Skip to content

Create a new Directory Record
Deprecated

Request

⚠️ Deprecation Notice: The following endpoint is deprecated.

Creates a new Directory Record for an enterprise.

Registers a device ahead of enrollment by submitting its unique identifiers, and returns the created Directory Record instance including its assigned approval status.

About Directory Records

A Directory Record represents a device identified for onboarding, typically before it has completed enrollment, and is used to drive device registration/approval workflows. Creating one associates one or more unique identifiers with an optional device group, alias, and tags.

Security
esper_cloud_api_apiKey
Path
enterprise_idstring, (uuid)required

Enterprise ID

Bodyapplication/jsonrequired
unique_identifiersArray of objects(Unique Identifiers)
group_idstring, (uuid)(Group ID)
aliasstring(Alias name)
tagsArray of strings(Tags)
cURL
curl -i -X POST \
  'https://api.esper.io/_mock/openapi/v1/enterprise/{enterprise_id}/directory_record/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "unique_identifiers": [
      {
        "unique_id": "string",
        "type": 0
      }
    ],
    "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
    "alias": "string",
    "tags": [
      "string"
    ]
  }'

Responses

Created

Bodyapplication/json
idstring(Directory Record ID)
namestring(Device name)
online_statusstring
Enum:"ONLINE""OFFLINE""NONE"
aliasstring(Alias name)
tagsArray of strings(Tags)
group_idstring, (uuid)(Group ID)
device_idstring, (uuid)(Device ID)
approval_statusstring(Approval Status)
Enum:"WAITING_FOR_APPROVAL""APPROVED""REJECTED""BLOCKED"
provisioned_onstring, (date-time)(Provisioned on)read-only
unique_identifiersArray of objects(Unique Identifiers)
Response
{
  "id": "string",
  "name": "string",
  "online_status": "ONLINE",
  "alias": "string",
  "tags": [
    "string"
  ],
  "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
  "device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940",
  "approval_status": "WAITING_FOR_APPROVAL",
  "provisioned_on": "2019-08-24T14:15:22Z",
  "unique_identifiers": [
    { … }
  ]
}