Ctrl+K

Creates a new user via SCIM 2.0 provisioning.

post/api/v2/scim/v2/Users

If the user already exists, they will be invited to join the enterprise and assigned the SCIM identifier. The userName must be a valid email address and match the primary email in the emails array.

Request Body

schemas array[string] required
SCIM schemas array (must include urn:ietf:params:scim:schemas:core:2.0:User)
Allowed value: urn:ietf:params:scim:schemas:core:2.0:User
userName string required
User's primary email address
externalId string
External identifier from the identity provider (e.g., Okta user ID)
name object
User's name information
familyName string
formatted string
givenName string
emails array[object]
User's email addresses (primary email must match userName)
primary boolean
value string required

201 Response

schemas array[string] required
Allowed value: urn:ietf:params:scim:schemas:core:2.0:User
id string required
userName string required
meta object required
resourceType string required
location string required
externalId string
name object
givenName string
familyName string
formatted string
emails array[object]
value string required
primary boolean
active boolean

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

401 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

409 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id