v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-031984301.2 MB
User

Get User

Retrieves a user by identifier.

get/users/{userId}

Query parameters

fieldsstring

A comma separated list of fields to include in the response. Every value in the list should either consist of a top-level property name (excluding the items envelope for endpoints returning lists) or refer to a property of a top-level property of type object, in the following form: "toplevelpropertyname.subpropertyname". When this query parameter is omitted, default resource representations are returned (excluding fields marked as optional). The same applies to nested objects when just specifying the top-level property name, without explicitly listing sub-property names. When specifying the fields query parameter, only the specified fields are returned. The id property is always returned.

Headers

Authorizationstring required

The bearer access token provided by Auth0.

X-LC-Tenantstring required

The identifier of the account where the request is executed.

Response

idstring required

User account identifier.

descriptionstring

Description of this account user. For Service account users only.

emailstring
<div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The user's email address. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.</div>
namestring
<div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The user's name. Retrieved only for Service users (not RWS ID users) that the authenticated entity is authorized to read.</div>
firstNamestring
<div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The user's first name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.</div>
lastNamestring
<div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The user's last name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.</div>
anonymizedboolean nullable
<div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">This shows if the authenticated entity has access to read the details of the user or not. If true, then the 'anonymizedUserName' should be retrieved.</div>
anonymizedUserNamestring
<div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">Retrieved if the authenticated entity does not have access to read the User.</div>
userType'user' | 'serviceUser'

The type of the account user.

status'inactive' | 'active' | 'deleted' | 'provisioned'

Status of this account user.

invitationLinkstring

The user's invitation link. Retrieved only for RWS ID (formerly SDL ID) users—not service users. It is available only if the user has not yet accepted the invitation (status is inactive).

membership'member' | 'collaborator'

Type of membership of this account user.

{"stackTrail":"components:schemas:user:properties:metadata","oasType":"schema","type":"unknown","title":"Metadata","description":"Additional metadata values in a key–value pair format","example":{"colour":"green","flag-enabled":true,"max value":3}}