rbac

Update role

Changed on Oct 16, 2026

Replaces a custom role's name, description, and capabilities. Capabilities you omit are removed, and the members field is ignored. Requires an Enterprise plan or the RBAC add-on.

put/rbac/roles/{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/roles/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Unique identifier of the role to update

Request body

datasetCapabilitiesRoleDatasetCapabilities

Defines the available permissions for dataset operations

descriptionstring

Detailed description of the role's purpose and scope

membersstring[]

IDs of users assigned this role directly. Returned in responses and ignored in requests. To assign a role to a user, use the Update user role endpoint.

namestring required

Unique name identifier for the role

viewCapabilitiesRoleViewCapabilities

Defines the available permissions for view operations

Response

The updated role.