v1

latestSwagger 2.02026-07-14172228.6 KB
Groups

Replace Group

Updates an existing group. The request must include the full group definition. To modify one or more values without sending the full definition, see "Update Group". Member groups and member users must be in the organization. This call requires the role ROLE_ORG_WRITE.

put/Groups/{groupKey}

Path parameters

groupKeyinteger required

The key of the group to query. The group must be in the organization domain

Headers

Authorizationstring required

Access token prefixed with 'Bearer ', e.g. 'Bearer 123456abcdef'

Request body

displayNamestring required

The group's display name

Response

The group has been replaced.

displayNamestring required

The group's display name

idstring required

The group's unique key