Skip to main content
PUT
/realms/{realmId}/organizations/{organizationId}/groups/{groupId}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

realmId
string
required
organizationId
string
required
groupId
string
required

Body

application/json
name
string
Required string length: 1 - 80
description
string
Maximum string length: 500
memberIds
string[]
Minimum array length: 1
Minimum string length: 1

Response

200 - application/json

Successful response

Org-scoped user groups (identity groups collection).

Groups are authored by org/realm ADMINs and consumed by the ruleengine business-policy engine: a business_policies approval entry of type GROUP points at a group id, and the policy-request creation resolves it to the concrete member users through IdentityClient.getOrganizationGroup.

NOTE the field names realm/organization (NOT realmId/organizationId) — that is identity's own persistence convention (see customField).

id
string
required
realm
string
required
organization
string
required
name
string
required
memberIds
string[]
required
description
string
createdBy
string
updatedBy
string
createdAt
updatedAt