Skip to main content
POST
Error

Authorizations

X-API-Key
string
header
required
X-Organization-Id
string
header
required

Body

application/json
name
string
required
Required string length: 1 - 255
description
string
parent_user_group_id
string<uuid>
workspace_id
string<uuid>

Rejected with 400, so a request for a workspace user group does not create an organization-wide user group. Granting a user group a workspace creates its workspace user group.

Response

Created

created_at
string
required
description
string
required
id
string<uuid>
required
idp_sync_enabled
boolean
required
name
string
required
organization_id
string<uuid>
required
updated_at
string
required
idp_group_name
string
parent_user_group_id
string<uuid>

ParentUserGroupID is the organization-wide user group a workspace user group belongs to. It is omitted for organization-wide user groups.

workspace_id
string<uuid>

WorkspaceID is the workspace the user group belongs to. It is omitted for organization-wide user groups.