Get a user

get https://{hostname}/identity-management/v3/user-admin/ui-identities/{uiIdentityId}

This operation retrieves a user's profile.

Path Params

uiIdentityId

string

required

Unique identifier for each user. To get this value, run the List users operation.

Query Params

authGrants

boolean

Defaults to false

Includes the list of your group and role assignments, false by default.

notifications

boolean

Defaults to false

Includes product notifications you subscribe to, false by default.

actions

boolean

Defaults to false

Includes actions such as edit or delete that a user can perform on an object, false by default. Don't confuse this with the action parameter, which applies to the Set two-factor authentication operation.

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Response

Response body

object

accountId

string

length ≥ 1

Unique identifier for each account.

actions

object

Specifies permissions available to the user for this group. This data is available when you specify the actions parameter of the same name, not to be confused with the action parameter that applies to the Set two-factor authentication operation.

delete

boolean

required

Whether the user is deletable.

apiClient

boolean

required

Enables the administrator to create an API client.

edit

boolean

required

Whether the user is editable.

isCloneable

boolean

required

Enables an administrator to create a new user with permissions cloned from this user.

resetPassword

boolean

required

Enables an administrator to send a user a password by email or see a one-time token.

thirdPartyAccess

boolean

required

Enables the administrator to manage extended access.

additionalAuthentication

string

required

Specifies the user's multi-factor authentication method, confirming their identity. Either TFA, MFA, or NONE, which offers no additional authentication.

TFA MFA NONE

additionalAuthenticationConfigured

boolean

required

Whether the user has multi-factor authentication configured.

address

string

required

length ≥ 1

The user's street address.

authGrants

array of objects

length ≥ 0

A user's role assignments, per group.

authGrants

object

groupId

integer

≥ 0

Unique identifier for each group. It's returned only for group roles.

groupName

string

length ≥ 1

Descriptive label for the group.

isBlocked

boolean

Whether a user's access to a group is blocked.

roleDescription

string

length ≥ 1

Descriptive label for the role to convey its use.

roleId

integer

required

≥ 1

Unique identifier for each role.

roleName

string

required

length ≥ 1

Descriptive label for the role.

subGroups

array of objects

length ≥ 0

Children of the parent group. Permissions cascade downward from parent to child unless the child group's isBlocked is true.

subGroups

object

city

string

length ≥ 1

The user's city.

contactType

string

length ≥ 1

User's contact type.

country

string

required

length ≥ 1

User's country.

string

required

The user's email address.

emailUpdatePending

boolean

Whether there are any pending changes to the email address.

firstName

string

required

length ≥ 1

The user's first name.

isLocked

boolean

Whether the user's account is locked. To learn more, see Temporary account lockout.

jobTitle

string

length ≥ 1

The user's position at the company.

lastLoginDate

date-time

ISO 8601 timestamp indicating when the user last logged in.

lastName

string

required

length ≥ 1

The user's surname.

mobilePhone

string

length ≥ 1

The user's mobile phone number in ITU-T E.164 format, that is, +country code-area code-subscriber number.

notifications

object

Specifies email notifications the user receives for products.

options

object

required

Specifies email notifications settings.

enableEmailNotifications

boolean

required

Enables email notifications.

passwordExpiryDate

date-time

The date a user's password expires.

phone

string

length ≥ 1

The user's mobile phone number in ITU-T E.164 format, that is, +country code-area code-subscriber number.

preferredLanguage

string

length ≥ 1

The user's language.

secondaryEmail

string

The user's alternate email address.

sessionTimeOut

integer

≥ 0

The number of seconds it takes for the user's Control Center session to time out after no activity.

state

string

length ≥ 1

The user's state or province if user's country is USA or Canada.

tfaConfigured

boolean

Whether TFA is configured.

tfaEnabled

boolean

Whether TFA is enabled.

timeZone

string

required

length ≥ 1

The user's time zone. To get the available values, run the View time zones operation.

uiIdentityId

string

required

length ≥ 1

Unique identifier for each user, which corresponds to their Control Center profile or client ID. Also known as a contactId in other APIs.

uiUserName

string

length ≥ 1

The user's username in Control Center.

zipCode

string

length ≥ 1

The user's five-digit postal code, represented as a string.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/identity-management/v3/user-admin/ui-identities/uiIdentityId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The response provides the user's profile.