PHphrase
SCIM

Get user

Returns a single user by their Phrase Platform identity UID.

get/scim/Users/{userUid}

Request

Path parameters

userUidstring required

Phrase Platform identity UID of the user

Response

User returned successfully

schemasstring[]

SCIM schema URNs

idstring

Unique Phrase Platform identity UID, assigned by the service provider

externalIdstring

Identifier assigned by the provisioning client (IdP). Used to correlate the Phrase identity with the IdP record.

userNamestring

Unique username within the Phrase Platform

activeboolean

Whether the user account is enabled

localestring

User locale in IETF BCP 47 format (e.g. en-US)

timezonestring

User time zone in IANA Time Zone Database format (e.g. Europe/Berlin)

Example response

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "roles": [
    {
      "type": "phrase__platform",
      "value": "MEMBER"
    }
  ],
  "meta": {
    "resourceType": "User"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.