List of Identities

curl --request GET \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/directory/identities \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://wksusa1b2c3d.provisionr.app/api/v1/directory/identities"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://wksusa1b2c3d.provisionr.app/api/v1/directory/identities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "id": "dridt_01hq8xyzabc123def456ghi789",
    "state": "staged",
    "vendor_id": "<string>",
    "email": "<string>",
    "profile": {},
    "timestamp": {
      "created_at": "2025-01-28T13:37:00Z",
      "updated_at": "2025-05-04T03:27:00Z",
      "deleted_at": null,
      "provisioned_at": "2023-11-07T05:31:56Z",
      "deprovisioned_at": null,
      "profile_changed_at": "2023-11-07T05:31:56Z",
      "last_authenticated_at": "2023-11-07T05:31:56Z"
    },
    "count": {
      "audit_logs_parent": 123,
      "audit_logs_record": 123,
      "audit_logs_related": 123
    },
    "included": {
      "integration": {
        "id": "gitg_01hq8xyzabc123def456ghi789",
        "vendor": "google",
        "is_primary": true
      },
      "directory_user": {
        "id": "drusr_01hq8xyzabc123def456ghi789",
        "state": "active",
        "manager_id": "drusr_01kam9z5z71f7r4hhrm2ydxkhn",
        "is_manager": true,
        "full_name": "Dade Murphy",
        "email": "[email protected]",
        "username": "dmurphy",
        "badge_id": "<string>",
        "employee_id": "<string>",
        "employee_alt_id": "<string>",
        "org": {
          "cost_center": "CC-1234",
          "department": "Infrastructure",
          "division": "Engineering",
          "title": "Senior Engineer"
        },
        "metadata": {
          "custom_field_1": "value1",
          "employee_type": "full-time",
          "desk_number": "42"
        }
      }
    },
    "links": {
      "self": "<string>",
      "integration": "<string>",
      "directory_user": "<string>"
    }
  }
]

{
  "message": "<string>"
}

{
  "message": "<string>"
}

GET

directory

identities

List of Identities

curl --request GET \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/directory/identities \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://wksusa1b2c3d.provisionr.app/api/v1/directory/identities"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://wksusa1b2c3d.provisionr.app/api/v1/directory/identities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "id": "dridt_01hq8xyzabc123def456ghi789",
    "state": "staged",
    "vendor_id": "<string>",
    "email": "<string>",
    "profile": {},
    "timestamp": {
      "created_at": "2025-01-28T13:37:00Z",
      "updated_at": "2025-05-04T03:27:00Z",
      "deleted_at": null,
      "provisioned_at": "2023-11-07T05:31:56Z",
      "deprovisioned_at": null,
      "profile_changed_at": "2023-11-07T05:31:56Z",
      "last_authenticated_at": "2023-11-07T05:31:56Z"
    },
    "count": {
      "audit_logs_parent": 123,
      "audit_logs_record": 123,
      "audit_logs_related": 123
    },
    "included": {
      "integration": {
        "id": "gitg_01hq8xyzabc123def456ghi789",
        "vendor": "google",
        "is_primary": true
      },
      "directory_user": {
        "id": "drusr_01hq8xyzabc123def456ghi789",
        "state": "active",
        "manager_id": "drusr_01kam9z5z71f7r4hhrm2ydxkhn",
        "is_manager": true,
        "full_name": "Dade Murphy",
        "email": "[email protected]",
        "username": "dmurphy",
        "badge_id": "<string>",
        "employee_id": "<string>",
        "employee_alt_id": "<string>",
        "org": {
          "cost_center": "CC-1234",
          "department": "Infrastructure",
          "division": "Engineering",
          "title": "Senior Engineer"
        },
        "metadata": {
          "custom_field_1": "value1",
          "employee_type": "full-time",
          "desk_number": "42"
        }
      }
    },
    "links": {
      "self": "<string>",
      "integration": "<string>",
      "directory_user": "<string>"
    }
  }
]

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter[deprovisioned_pending_deactivation]

string

sort

enum<string>[]

Available options:

integration_id,

-integration_id,

directory_user_id,

-directory_user_id,

vendor_id,

-vendor_id,

user_full-name,

-user_full-name,

user_email,

-user_email,

provisioned_at,

-provisioned_at,

profile_changed_at,

-profile_changed_at,

last_authenticated_at,

-last_authenticated_at,

deprovisioned_at,

-deprovisioned_at,

created_at,

-created_at,

updated_at,

-updated_at,

deleted_at,

-deleted_at,

state,

-state,

-integration_id,

--integration_id,

-user_id,

--user_id,

-vendor_id,

--vendor_id,

-user_full-name,

--user_full-name,

-user_email,

--user_email,

-email,

--email,

-provisioned_at,

--provisioned_at,

-profile_changed_at,

--profile_changed_at,

-last_authenticated_at,

--last_authenticated_at,

-deprovisioned_at,

--deprovisioned_at,

-created_at,

--created_at,

-updated_at,

--updated_at,

-deleted_at,

--deleted_at,

-state,

--state

filter

string

page

string

filter[id_search]

string

Filter by a partial match of the identity ID

filter[integration_id]

string

Filter by an exact match of the integration ID

filter[integration_type]

string

Filter by an exact match of the integration type (polymorphic morph class)

filter[directory_user_id]

string

Filter by an exact match of the directory user ID

filter[vendor_id]

string

Filter by an exact match of the integration vendor ID field

filter[vendor_id_search]

string

Filter by a partial match of the integration vendor ID field

filter[email]

string

Filter by an exact match of the email field

filter[email_search]

string

Filter by a partial match of the email field (useful for handles or domain names)

filter[state]

string

Filter by an exact match of the state field

filter[profile_search]

string

Filter by searching custom profile key/value pairs for any partial string match

filter[created_before]

string

Filter by imported to Provisionr before date

filter[created_after]

string

Filter by imported to Provisionr after date

filter[deleted_before]

string

Filter by deleted before date

filter[deleted_after]

string

Filter by deleted after date

filter[provisioned_before]

string

Filter by identities that were provisioned before date

filter[provisioned_after]

string

Filter by identities that were provisioned after date

filter[profile_changed_before]

string

Filter by profile changed before date

filter[profile_changed_after]

string

Filter by profile changed after date

filter[last_authenticated_before]

string

Filter by last authenticated before date

filter[last_authenticated_after]

string

Filter by last authenticated after date

filter[deprovisioned_before]

string

Filter by deprovisioned before date. Reminder to include trashed records.

filter[deprovisioned_after]

string

Filter by deprovisioned after date. Reminder to include trashed records.

filter[trashed]

string

Include trashed records (with, only, without)

Response

The collection of DirectoryIdentityDetailedResponseData

string

required

Example:

"dridt_01hq8xyzabc123def456ghi789"

state

enum<string>

required

The state of the identity record (not the user)


`staged` The record is staged and is only visible to administrators or in the API. Since Directory Users are managed by Directory Identities with your primary integration, this usually indicates that the user is staged and will be activated or onboarded soon. Staged users are not included in ruleset manifests until they are active users.
`active` The record is active.
`orphan` The record is active but is not associated with a Directory User.
`expiring` The `expires_at` value is set in the future for the record. You can run the `activate` action to remove the scheduled expiration.
`expired` The `expires_at` value is in the past and the record was deactivated.
`suspended` The record is temporarily suspended. This reflects the state of the primary Workspace Integration.
`deactivated` The record was deactivated in the primary Workspace Integration.

Available options:

staged,

active,

orphan,

expiring,

expired,

suspended,

deactivated

vendor_id

string | null

required

The ID of the user on the vendor API in its native format

string | null

required

The email address of the user in the vendor API. This is used for Directory User lookup matching

profile

object

required

The vendor API profile data (raw) that is imported. This likely contains sensitive PII. This endpoint requires directory.identity.view permission.

If you do not have permission, use the api/v1/directory/users?include=identities to get a nested list of identities for a user without the profile

Show child attributes

timestamp

DirectoryIdentityTimestampResponseData · object

required

The timestamps for the directory identity record

Show child attributes

count

object

required

Count of related records

Show child attributes

included

object

required

Included related resources

Show child attributes

links

object

required

API hyperlinks related to the record

Show child attributes

Getting Started

Endpoints

List of Identities

Authorizations

Query Parameters

Response