Skip to main content
POST
/
scim
/
Users
Create user
curl --request POST \
  --url https://eu.phrase.com/idm/scim/Users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/scim+json' \
  --data '
{
  "userName": "<string>",
  "emails": [
    {
      "value": "jsmith@example.com",
      "primary": true
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "externalId": "<string>",
  "name": {
    "givenName": "<string>",
    "familyName": "<string>"
  },
  "active": true,
  "locale": "<string>",
  "timezone": "<string>",
  "roles": [
    {
      "type": "phrase__platform",
      "value": "MEMBER"
    }
  ]
}
'
{
  "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.

Body

SCIM User resource for create and update (PUT) operations

​
userName
string
required

Unique username within the Phrase Platform. Required for create; optional for replace if unchanged.

​
emails
object[]
required

List of email addresses. Must include at least one entry. The primary email is derived from the entry with primary: true, or the first entry if none is marked primary.

Minimum array length: 1
​
schemas
string[]

SCIM schema URNs

Example:
[
  "urn:ietf:params:scim:schemas:core:2.0:User"
]
​
externalId
string

Identifier assigned by the provisioning client (IdP)

​
name
object

User's name components

​
active
boolean

Whether the user account should be enabled. Ignored on create — newly provisioned users are always active regardless of this value.

​
locale
string

User locale in IETF BCP 47 format (e.g. en-US). Falls back to the organization default when not provided or when the value does not match a supported locale.

​
timezone
string

User time zone in IANA Time Zone Database format (e.g. Europe/Berlin). Falls back to the organization default when not provided or when the value is not a recognized IANA timezone.

​
roles
object[]

Roles to assign on create. Only processed when SCIM role management is enabled for the organization. Ignored on PUT and PATCH — role updates via SCIM are not supported.

Standard format (Okta, JumpCloud): one entry per Phrase product with type starting with phrase__ and value set to the role name. The phrase__platform entry is mandatory and cannot be set to none.

Azure AD format: single entry with type: "WindowsAzureActiveDirectoryRole" and value set to a JSON-escaped array of standard role objects.

Example (standard):

[
  { "type": "phrase__platform", "value": "MEMBER" },
  { "type": "phrase__tms", "value": "none" },
  { "type": "phrase__strings", "value": "Translator" }
]

Example (Azure AD):

[
  {
    "type": "WindowsAzureActiveDirectoryRole",
    "value": "[{\"type\":\"phrase__platform\",\"value\":\"MEMBER\"},{\"type\":\"phrase__tms\",\"value\":\"none\"},{\"type\":\"phrase__strings\",\"value\":\"Translator\"}]"
  }
]

Response

User created 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