POST
/scim/v2/UsersCreate a SCIM user
Creates a SCIM user from the supplied user resource data. Provide any user attributes you want included, such as userName, emails, or displayName; the schema does not specify required individual fields. The response includes the created user and its generated identifier.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
SCIM user resource data for creation; the request body is required.
displayNamestringoptional
the display name of the user
emailsarray<object>optional
Email addresses for the user, each with a value and an optional primary indicator.
localestringoptional
Used to indicate the User's default location for purposes of localizing such items as currency, date time format, or numerical representations.
nameobjectoptional
The user's name, with a formatted value for the full name.
photosarray<object>optional
The picture of the user. It is expected to have a single item in the context of Grist.
preferredLanguagestringoptional
Indicates the user's preferred written or spoken languages and is generally used for selecting a localized user interface.
schemasarray<string>optional
SCIM schema identifiers; the defined user schema is `urn:ietf:params:scim:schemas:core:2.0:User`.
userNamestringoptional
The unique username.
201Returns the created SCIM user resource, including its generated identifier and metadata.
idstringoptional
The unique identifier of the user.
metaobjectoptional
displayNamestringoptional
the display name of the user
emailsarray<object>optional
localestringoptional
Used to indicate the User's default location for purposes of localizing such items as currency, date time format, or numerical representations.
nameobjectoptional
photosarray<object>optional
The picture of the user. It is expected to have a single item in the context of Grist.
preferredLanguagestringoptional
Indicates the user's preferred written or spoken languages and is generally used for selecting a localized user interface.
schemasarray<string>optional
userNamestringoptional
The unique username.
400Returned when the request is invalid.
401Returned when the request is unauthenticated.
403Returned when the request is unauthorized.
409Returned when the user conflicts with an existing resource, such as an email address.
500Returned when an internal server error occurs.
Error handling
A 400 is returned when the request is invalid. A 401 is returned when the request is unauthenticated, and a 403 when it is unauthorized. A 409 indicates a resource conflict, such as a duplicate emails value; a 500 indicates an internal server error.