Update user
Updates a user’s attributes. Only fields explicitly provided with a non-null, non-blank value are written — omitted, null, blank, or empty-list fields keep their current values.
Updatable fields: userName, name.givenName, name.familyName, emails (primary address), externalId, locale, timezone, active.
The active field is always applied from the request body regardless of its previous value.
Bot identities and users managed externally (EXTERNAL membership) cannot be updated.
Role assignments in the request body are ignored — role updates via SCIM are not supported.
Authorizations
SCIM access token issued via Phrase Platform organization settings. The Bearer token value must be configured in Phrase Platform SCIM section.
Path Parameters
Phrase Platform identity UID of the user
Body
SCIM User resource for create and update (PUT) operations
Unique username within the Phrase Platform. Required for create; optional for replace if unchanged.
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.
1SCIM schema URNs
[
"urn:ietf:params:scim:schemas:core:2.0:User"
]Identifier assigned by the provisioning client (IdP)
User's name components
Whether the user account should be enabled. Ignored on create — newly provisioned users are always active regardless of this value.
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.
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 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 updated successfully
SCIM User resource (urn:ietf:params:scim:schemas:core:2.0:User)
SCIM schema URNs
[
"urn:ietf:params:scim:schemas:core:2.0:User"
]Unique Phrase Platform identity UID, assigned by the service provider
Identifier assigned by the provisioning client (IdP). Used to correlate the Phrase identity with the IdP record.
Unique username within the Phrase Platform
User's name components
List of email addresses. The first entry marked primary: true is used as the user's primary email.
Whether the user account is enabled
User locale in IETF BCP 47 format (e.g. en-US)
User time zone in IANA Time Zone Database format (e.g. Europe/Berlin)
Roles to assign on create. Only processed when SCIM role management is enabled for the organization.
Resource metadata set by the service provider