Grist Octri Preview
POST/scim/v2/Groups

Create a SCIM group

Creates a group in the SCIM service. Provide the group's displayName, any members, and the SCIM group schema identifier when applicable. A 201 response returns the created group and its generated identifier.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 body fields

SCIM group data to create, including the display name, members, and schema identifier.

displayNamestringoptional
The display name of the group.
membersarray<object>optional
The group members; each member must include a `value` and a `type`.
schemasarray<string>optional
The SCIM schema identifier for a group: `urn:ietf:params:scim:schemas:core:2.0:Group`.

6 status codes
201Returns the created group object, including its unique identifier, display name, members, metadata, and schema identifier.
displayNamestringoptional
The name of the group.
idstringoptional
The unique identifier of the group.
membersarray<object>optional
metaobjectoptional
schemasarray<string>optional
400Returned when the request is invalid, including when a supplied member omits `value` or `type`.
401Returned when the request is unauthenticated.
403Returned when the request is unauthorized.
409Returned when the group conflicts with an existing resource, such as through a conflicting display name.
500Returned when an internal server error occurs.

Error handling

A 400 is returned when the request is invalid; each supplied member must include value and type, and schemas must contain the SCIM Group schema identifier. A 401 is returned when the request is unauthenticated, and a 403 is returned when it is unauthorized. A 409 indicates a resource conflict, such as a conflicting displayName; a 500 indicates an internal server error.