User Identities

user_identity

Represents a user identity associated with an application user account.

created_at

Format: Datetime

Date and time at which the user identity was created.

---

display_name

Format: String

---

email_address

Format: String

Unique email address for the user identity.

---

full_name

Format: String

---

phone_number

Format: String

Unique phone number for the user identity in E.164 format (for example, [phone]).

---

user_identity_id

Format: UUID

ID of the user identity.

---

user_identity_key

Format: String

Unique key for the user identity.

---

workspace_id

Format: UUID

ID of the workspace that contains the user identity.

---

Endpoints

/user_identities/add_acs_user

Adds a specified ACS user to a specified user identity.

/user_identities/create

Creates a new user identity.

/user_identities/delete

Deletes a specified user identity. To delete a user identity, you must first delete any ACS credentials and enrollment automations associated with the user identity. You must also deactivate any associated phones.

/user_identities/get

Returns a specified user identity.

/user_identities/grant_access_to_device

Grants a specified user identity access to a specified device.

/user_identities/list

Returns a list of all user identities.

/user_identities/list_accessible_devices

Returns a list of all devices associated with a specified user identity.

/user_identities/list_acs_systems

Returns a list of all access control systems associated with a specified user identity.

/user_identities/list_acs_users

Returns a list of all ACS users assigned to a specified user identity.

/user_identities/remove_acs_user

Removes a specified ACS user from a specified user identity.

/user_identities/revoke_access_to_device

Revokes access to a specified device from a specified user identity.

/user_identities/update