User Identities
The user_identity Object
Represents a user identity associated with an application user account.
Properties
created_at Datetime
Date and time at which the user identity was created.
display_name String
email_address String
Unique email address for the user identity.
full_name String
phone_number String
Unique phone number for the user identity in E.164 format (for example, +15555550100).
user_identity_id UUID
ID of the user identity.
user_identity_key String
Unique key for the user identity.
workspace_id UUID
ID of the workspace that contains the user identity.
Endpoints
Adds a specified ACS user to a specified user identity.
Creates a new user identity.
Deletes a specified user identity. To delete a user identity, you must first delete any credentials and enrollment automations associated with the user identity. You must also deactivate any associated phones.
/user_identities/generate_instant_key
Generates a new instant key for a specified user identity.
Returns a specified user identity.
/user_identities/grant_access_to_device
Grants a specified user identity access to a specified device.
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.
Last updated
Was this helpful?