Directory Record

APIs for Directory Record management. These APIs are only available to the customers using the new Onboarding experience.

Get all Directory Records

Returns a list of all Directory Record instances

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

Enterprise ID

Responses
200

Directory records

default

Unexpected error

get/v1/enterprise/{enterprise_id}/directory_record/
Response samples
application/json
{
  • "count": 0,
  • "previous": "string",
  • "next": "string",
  • "results": [
    ]
}

Create a new Directory Record

Returns the created Directory Record intance

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

Enterprise ID

Request Body schema: application/json
Array of objects (Unique Identifiers)
group_id
string <uuid> (Group ID)
alias
string (Alias name)
tags
Array of strings (Tags)
Responses
201

Created

400

Directory record create error

401

Directory record create error

post/v1/enterprise/{enterprise_id}/directory_record/
Request samples
application/json
{
  • "unique_identifiers": [
    ],
  • "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
  • "alias": "string",
  • "tags": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "online_status": "ONLINE",
  • "alias": "string",
  • "tags": [
    ],
  • "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": [
    ]
}

Get details about a Directory Record

Returns detail of the Directory Record instance

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

Enterprise ID

directory_record_id
required
string <uuid>

Directory record ID

Responses
200

Directory record information

default

Unexpected error

get/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "online_status": "ONLINE",
  • "alias": "string",
  • "tags": [
    ],
  • "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": [
    ]
}

Update a Directory Record

Returns the updated Directory Record instance

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

Enterprise ID

directory_record_id
required
string <uuid>

Directory record ID

Request Body schema: application/json
Array of objects (Unique Identifiers)
group_id
string <uuid> (Group ID)
alias
string (Alias name)
tags
Array of strings (Tags)
Responses
200

Updated Directory Record Information

400

Directory record update error

401

Directory record update error

put/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/
Request samples
application/json
{
  • "unique_identifiers": [
    ],
  • "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
  • "alias": "string",
  • "tags": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "online_status": "ONLINE",
  • "alias": "string",
  • "tags": [
    ],
  • "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": [
    ]
}

Delete a Directory Record

Deletes the requested Directory Record instance

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

Enterprise ID

directory_record_id
required
string <uuid>

Directory record ID

Responses
204

Deleted Directory Record

401

Directory record delete error

delete/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/
Response samples
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}