POST/organization/groups

Create an organization group

Creates a new group in the organization. Provide a human-readable name between 1 and 255 characters; the response includes the group's generated ID and management details.

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

1 body field

Parameters for creating a new organization group.

namestringrequired
Human readable name for the group.

7 status codes
200Returns the created group, including its ID, name, creation timestamp, SCIM management status, and group type.
idstringrequired
Identifier for the group.
namestringrequired
Display name of the group.
created_atintegerrequired
Unix timestamp (in seconds) when the group was created.
is_scim_managedbooleanrequired
Whether the group is managed through SCIM and controlled by your identity provider.
group_typestringrequired
The type of the group.
Allowed:grouptenant_group
400Returned when request parameters are invalid or the requested operation cannot be performed.
errorobjectrequired
403Returned when the caller does not have permission to create organization groups.
errorobjectrequired
Details about the permission error.
404Returned when the endpoint is unavailable or a requested group, user, or project is not found.
errorobjectrequired
422Returned when the organization has reached its maximum number of groups.
errorobjectrequired
429Returned when the request exceeds a rate limit.
errorobjectrequired
500Returned when a server error prevents the group operation.
errorobjectrequired

Error handling

A 400 is returned when request parameters are invalid or the requested operation cannot be performed. A 403 is returned when the authenticated user lacks permission to create groups. A 404 is returned when the endpoint is unavailable or a requested group, user, or project is not found. A 422 is returned when the organization has reached its maximum number of groups. A 429 is returned when the request exceeds a rate limit. A 500 is returned when a server error prevents the group operation. name is required and must contain between 1 and 255 characters.