Skip to main content
PATCH
Error

Authorizations

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

Path Parameters

user_group_id
string<uuid>
required

User Group ID

Body

application/json
description
string | null

Description is cleared by null.

idp_group_name
string | null

IdpGroupName is cleared by null. Workspace scoped user groups cannot have one.

Required string length: 1 - 255
idp_sync_enabled
boolean

IdpSyncEnabled can be true only while the user group has an IdpGroupName.

name
string
Required string length: 1 - 255

Response

OK

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.