Get a User Identity
Get a specified user identity
Returns a specified user identity.
/user_identities/get
OK
Request
Specify the desired user identity by including the corresponding user_identity_id
in the request body.
Request Body Parameters
Parameter | Type | Description |
---|---|---|
| String Required | ID of the desired user identity |
Sample Request
Response
Returns a user_identity
containing the following properties:
Property | Description |
---|---|
| ID of the user identity |
| Unique key for the user identity |
| Unique email address for the user identity |
| Unique phone number for the user identity in E.164 format (for example, |
| Display name for the user identity |
| Full name of the user associated with the user identity |
| Date and time at which the user identity was created |
| ID of the workspace that contains the user identity |
This response also includes a Boolean ok
status indicator.
Sample Response
Last updated