PHphrase
SCIM

Create user

Provisions a new user into the authenticated organization using the SCIM urn:ietf:params:scim:schemas:core:2.0:User schema.

If a user with the same userName or primary email already exists in another organization within the same customer group (SSO-linked), the user is added to this organization instead of being created.

post/scim/Users

Request

Request body

schemasstring[]

SCIM schema URNs

externalIdstring

Identifier assigned by the provisioning client (IdP)

userNamestring required

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

activeboolean

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

localestring

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.

timezonestring

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.

rolesunknown

Example request

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ]
}

Response

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