Skip to main content
GET
/
scim
/
Users
/
{userUid}
Get user
curl --request GET \
  --url https://eu.phrase.com/idm/scim/Users/{userUid} \
  --header 'Authorization: Bearer <token>'
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "<string>",
  "externalId": "<string>",
  "userName": "<string>",
  "name": {
    "givenName": "<string>",
    "familyName": "<string>"
  },
  "emails": [
    {
      "value": "jsmith@example.com",
      "primary": true
    }
  ],
  "active": true,
  "locale": "<string>",
  "timezone": "<string>",
  "roles": [
    {
      "type": "phrase__platform",
      "value": "MEMBER"
    }
  ],
  "meta": {
    "resourceType": "User",
    "created": "2023-11-07T05:31:56Z",
    "lastModified": "2023-11-07T05:31:56Z",
    "location": "<string>"
  }
}

Authorizations

Authorization
string
header
required

SCIM access token issued via Phrase Platform organization settings. The Bearer token value must be configured in Phrase Platform SCIM section.

Path Parameters

userUid
string
required

Phrase Platform identity UID of the user

Response

User returned successfully

SCIM User resource (urn:ietf:params:scim:schemas:core:2.0:User)

schemas
string[]

SCIM schema URNs

Example:
[
"urn:ietf:params:scim:schemas:core:2.0:User"
]
id
string
read-only

Unique Phrase Platform identity UID, assigned by the service provider

externalId
string

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

userName
string

Unique username within the Phrase Platform

name
object

User's name components

emails
object[]

List of email addresses. The first entry marked primary: true is used as the user's primary email.

active
boolean

Whether the user account is enabled

locale
string

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

timezone
string

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

roles
object[]

Roles to assign on create. Only processed when SCIM role management is enabled for the organization.

meta
object
read-only

Resource metadata set by the service provider