Skip to main content
PUT
Replace a provisioned user

Authorizations

Authorization
string
header
required

SCIM token for one organization's directory connection, created with POST /api/scim-tokens or in Settings > SCIM. It authenticates provisioning calls only, and stops working if the organization's Enterprise plan lapses.

Path Parameters

id
string
required
Minimum string length: 1

Body

application/scim+json
schemas
string[]
required
userName
string<email>
required
Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
externalId
string
Minimum string length: 1
name
object
emails
object[]
active
boolean
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
object
{key}
any

Response

The updated user.

schemas
string[]
required
Allowed value: "urn:ietf:params:scim:schemas:core:2.0:User"
id
string
required
userName
string
required
name
object
required
emails
object[]
required
active
boolean
required
meta
object
required
externalId
string
Last modified on August 10, 2026