Group Update

Description: Updates an Access group's external ID, description, and other parameters. To add or remove users, use the Add or Remove User from Groups REST API instead.

Note

Using the New Security REST APIs, modifying the realm and realm attributes parameters is not supported.SECURITY

Since: 7.49.3

Authorization: Requires admin authentication using Access Tokens

Usage: PATCH /access/api/v2/groups/{name}

Produces: application/json

Note

All fields are optional; if a field is not specified, the value will not change (if the request payload is empty, returns 200)

Request:

{
  "description": "string",
  "auto_join": boolean,
  "admin_privileges": boolean,
  "external_id": "string"
}

Response:

{
  "name": "string",
  "description": "string",
  "auto_join": false,
  "admin_privileges": false,
  "external_id": "string",
  "members": ["user1", "user2"]
}

Response Codes:

201: Successful
400: Invalid input, object invalid
401: Invalid credentials
403: Insufficient permissions
404: Name not found