rbac

Update group

Changed on Oct 16, 2026

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.

put/rbac/groups/{id}

Request

Base URL
https://api.axiom.co/v2
Auth
OAuth 2
Authorization codehttps://accounts.google.com/o/oauth2/v2/auth
Token URLhttps://www.googleapis.com/oauth2/v4/token
Scopesrbac|create
TypeScript
https://skmtc.dev/axiom/apis/axiom-public-api/docs/rbac/groups/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Unique identifier of the group to update

Request body

descriptionstring

Detailed description of the group's purpose and scope

isManagedboolean

Whether the group is synced from your identity provider. You can't delete a managed group or change its members.

membersstring[]

List of user IDs that are assigned to this group

namestring required

Unique name identifier for the group

rolesstring[]

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.

Response

The updated group.