Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
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 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.

{"stackTrail":"components:schemas:ScimUserRequest:properties:roles","oasType":"schema","type":"unknown","description":"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.\n\n**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`.\n\n**Azure AD format**: single entry with `type: \"WindowsAzureActiveDirectoryRole\"` and `value` set to a JSON-escaped array of standard role objects.\n\nExample (standard):"}

Example request

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

Response

User created successfully