Update group

PUT/v2/rbac/groups/{id}

Replaces a group's name, description, roles, and members. Fields you omit are cleared, and members of managed groups aren't changed. Requires an Enterprise plan or the RBAC add-on.

Parameters

Property	Type	Location	Description
`id`	`string`Required	`path`	Unique identifier of the group to update

Body

Defines a group of users for organizational purposes

application/json

Property	Type	Description
`description`	`string`	Detailed description of the group's purpose and scope
`isManaged`	`boolean`	Whether the group is synced from your identity provider. You can't delete a managed group or change its members.
`members`	`string[]`	List of user IDs that are assigned to this group
`name`	`string`Required	Unique name identifier for the group
`roles`	`string[]`	IDs of the roles assigned to the group. Use a custom role ID or a built-in role ID: `axiom-owner`, `axiom-admin`, `axiom-user`, `axiom-read-only`, or `axiom-none`.

Request

curl -X PUT 'https://api.axiom.co/v2/rbac/groups/ID' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"description":"string","isManaged":true,"members":["string"],"name":"string","roles":["string"]}'

Try itRun this request against your Axiom organization

Credentials stay in this browser tab and are only sent to Axiom when you run the request.

API token Requiredid pathRequiredRequest body application/json

Response

200The updated group.

application/json

400Bad Request

403Forbidden

404Not Found

Property	Type	Description
`description`	`string`	Detailed description of the group's purpose and scope
`isManaged`	`boolean`	Whether the group is synced from your identity provider. You can't delete a managed group or change its members.
`members`	`string[]`	List of user IDs that are assigned to this group
`name`	`string`Required	Unique name identifier for the group
`roles`	`string[]`	IDs of the roles assigned to the group. Use a custom role ID or a built-in role ID: `axiom-owner`, `axiom-admin`, `axiom-user`, `axiom-read-only`, or `axiom-none`.
`id`	`string`Required	Unique identifier for the group