Sign in
latestOpenAPI 3.1.02026-08-142887561.0 MB

61436a496404

beta.admin.user-groups

Update User Group

Update a user group.

patch/v1/admin/user-groups/{group_uuid}

Path parameters

group_uuidstring uuid required

Request body

namestring nullable

Updated name of the user group.

descriptionstring nullable

Updated description of the user group.

target_type'W' | 'O'
parent_group_idsstring[] nullable

Full replacement list of parent group UUIDs. Pass an empty list to remove all parents; omit the field to leave the parent groups unchanged.

Example request

{
  "name": "Engineering Team",
  "description": "Members of the platform engineering team",
  "parent_group_ids": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  ]
}

Response

OK

uuidstring uuid required

User group ID.

namestring required

Name of the user group.

descriptionstring nullable required

Optional description of the user group.

externally_managedboolean nullable

Whether the group is managed by an external system.

target_type'W' | 'O'
organization_rolestring nullable

Organization role assigned to the group.

parent_group_idsstring[]

UUIDs of the groups this group is directly nested inside.

Example response

{
  "name": "Engineering Team",
  "description": "Members of the platform engineering team",
  "parent_group_ids": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  ]
}