githubEdit

User Identities

The user_identity Object

Represents a user identity associated with an application user account.

{
  created_at: [example value],
  display_name: [example value],
  email_address: [example value],
  full_name: [example value],
  phone_number: [example value],
  user_identity_id: [example value],
  user_identity_key: [example value],
  workspace_id: [example value]
}

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 formatarrow-up-right (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

/user_identities/add_acs_user

Adds a specified ACS userarrow-up-right to a specified user identityarrow-up-right.

/user_identities/create

Creates a new user identityarrow-up-right.

/user_identities/delete

Deletes a specified user identityarrow-up-right. To delete a user identity, you must first delete any credentialsarrow-up-right and enrollment automationsarrow-up-right associated with the user identity. You must also deactivate any associated phones.

/user_identities/generate_instant_keyarrow-up-right

Generates a new instant keyarrow-up-right for a specified user identityarrow-up-right.

/user_identities/get

Returns a specified user identityarrow-up-right.

/user_identities/grant_access_to_device

Grants a specified user identityarrow-up-right access to a specified device.

/user_identities/list

Returns a list of all user identitiesarrow-up-right.

/user_identities/list_accessible_devices

Returns a list of all devices associated with a specified user identityarrow-up-right.

/user_identities/list_acs_systems

Returns a list of all access control systemsarrow-up-right associated with a specified user identityarrow-up-right.

/user_identities/list_acs_users

Returns a list of all ACS usersarrow-up-right assigned to a specified user identityarrow-up-right.

/user_identities/remove_acs_user

Removes a specified ACS userarrow-up-right from a specified user identityarrow-up-right.

/user_identities/revoke_access_to_device

Revokes access to a specified device from a specified user identityarrow-up-right.

/user_identities/update

Last updated

Was this helpful?