Get User

When included, each resource returned will contain the minimum set of resource attributes. Additionally, the default set of attributes minus those attributes listed in "excludedAttributes" is returned.

200

Returns the requested user, optionally filtered by values in attributes or excludedAttributes parameters.

Response body

object

active

boolean

Defaults to true

Indicates if the user is active/enabled.

displayName

string

The name of the user, suitable for display to end-users.

name

object

Compatibility attribute, writes are allowed but discarded. Empty strings when read from.

formatted

string

familyName

string

givenName

string

middleName

string

honorificPrefix

string

honorificSuffix

string

password

string

Compatibility attribute. Write-only, never returned. Writes are discarded.

roles

array of objects

length ≥ 0

roles

object

type

string | null

Type Identifier

display

string | null

Roles display name

value

string

Roles value

primary

boolean

Roles primary

externalId

string | null

A custom, user-supplied ID.

groups

array of objects

length ≥ 0

A list of groups to which the user belongs, either through direct membership, through nested groups, or dynamically calculated.

groups

object

display

string | null

Compatibility field, accepted but discarded.

type

string

Defaults to Group

The name of the resource type of the resource. Always 'Group.'

value

string

The ID of the group.

x-ref

string

The URI of the corresponding "Group" resources to which the user belongs.

string

The ID of this resource instance.

locale

string

Indicate the User's default location for purposes of localization. It is the language tag only (no region).

200Returns the requested user, optionally filtered by values in attributes or excludedAttributes parameters.