Users

Update a group

Changed on

Enterprise feature

Update existing user group by group id. It overrides previous group details.

put/api/admin/groups/{groupId}

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/groups/{groupId}
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

groupIdstring required

Request body

namestring required

The name of the group

descriptionstring nullable

A custom description of the group

mappingsSSOstring[]

A list of SSO groups that should map to this Unleash group

rootRolenumber nullable

A role id that is used as the root role for all users in this group. This can be either the id of the Viewer, Editor or Admin role.

Example request

{
  "name": "DX team",
  "description": "Current members of the DX squad",
  "mappingsSSO": [
    "SSOGroup1",
    "SSOGroup2"
  ],
  "rootRole": 1,
  "users": [
    {
      "user": {
        "id": 123
      }
    }
  ]
}

Response

groupWriteResponseSchema

idinteger

The group id

namestring required

The name of the group

descriptionstring nullable

A custom description of the group

mappingsSSOstring[]

A list of SSO groups that should map to this Unleash group

rootRolenumber nullable

A role id that is used as the root role for all users in this group. This can be either the id of the Viewer, Editor or Admin role.

createdBystring nullable

A user who created this group

createdAtstring date-time nullable

When was this group created

projectsstring[]

A list of projects where this group is used

userCountinteger

The number of users that belong to this group

scimIdstring nullable

The SCIM ID of the group, only present if managed by SCIM

Example response

{
  "id": 1,
  "name": "DX team",
  "description": "Current members of the DX squad",
  "mappingsSSO": [
    "SSOGroup1",
    "SSOGroup2"
  ],
  "rootRole": 1,
  "createdBy": "admin",
  "createdAt": "2023-06-30T11:41:00.123Z",
  "projects": [
    "default",
    "my-project"
  ],
  "userCount": 1,
  "scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
}

Changes

  • b2c3116e633eRevision changes
    • warning

      removed the optional property from the response with the status

  • 774670258f04Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status