Axiom
Overview

Update role

PUT/v2/rbac/roles/{id}
Features

Send the token in the Authorization: Bearer API_TOKEN header. See Tokens for which token types this endpoint accepts.

Input7
Authorizationheaderrequired
Sent from your browser straight to the API — never to Docsbook, never stored.
idstring · pathrequired
(path) Unique identifier of the role to update
datasetCapabilitiesobject · body
Defines the available permissions for dataset operations
descriptionstring · body
Detailed description of the role's purpose and scope
membersstring[] · body
List of user IDs that are assigned to this role
namestring · bodyrequired
Unique name identifier for the role
orgCapabilitiesobject · body
Defines organization-wide permissions and capabilities
Show child attributes15
annotationsstring[]
Controls the management of annotations across the organization
apiTokensstring[]
Controls the management of API tokens for authentication
auditLogstring[]
Controls access to organization audit logs
billingstring[]
Controls access to billing information and settings
dashboardsstring[]
Controls the management of organization dashboards
datasetsstring[]
Controls the management of organization datasets
endpointsstring[]
Controls the management of API endpoints
flowsstring[]
Controls the management of data flows and pipelines
integrationsstring[]
Controls the management of third-party integrations
monitorsstring[]
Controls the management of monitoring
notifiersstring[]
Controls the management of notification settings
rbacstring[]
Controls access to role-based access control settings
sharedAccessKeysstring[]
Controls the management of shared access keys
usersstring[]
Controls user management within the organization
viewsstring[]
Controls the management of data views
viewCapabilitiesobject · body
Defines the available permissions for view operations
Output7
datasetCapabilitiesobject
Defines the available permissions for dataset operations
descriptionstring
Detailed description of the role's purpose and scope
membersstring[]
List of user IDs that are assigned to this role
namestring
Unique name identifier for the role
orgCapabilitiesobject
Defines organization-wide permissions and capabilities
Show child attributes15
annotationsstring[]
Controls the management of annotations across the organization
apiTokensstring[]
Controls the management of API tokens for authentication
auditLogstring[]
Controls access to organization audit logs
billingstring[]
Controls access to billing information and settings
dashboardsstring[]
Controls the management of organization dashboards
datasetsstring[]
Controls the management of organization datasets
endpointsstring[]
Controls the management of API endpoints
flowsstring[]
Controls the management of data flows and pipelines
integrationsstring[]
Controls the management of third-party integrations
monitorsstring[]
Controls the management of monitoring
notifiersstring[]
Controls the management of notification settings
rbacstring[]
Controls access to role-based access control settings
sharedAccessKeysstring[]
Controls the management of shared access keys
usersstring[]
Controls user management within the organization
viewsstring[]
Controls the management of data views
viewCapabilitiesobject
Defines the available permissions for view operations
idstring
Unique identifier for the role
Responses
200The role was successfully updated
Example input
curl -X PUT 'https://api.axiom.co/v2/rbac/roles/{id}' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string"}'
Example output
{
  "datasetCapabilities": {},
  "description": "string",
  "members": [
    "string"
  ],
  "name": "string",
  "orgCapabilities": {
    "annotations": [
      "create"
    ],
    "apiTokens": [
      "create"
    ],
    "auditLog": [
      "read"
    ],
    "billing": [
      "read"
    ],
    "dashboards": [
      "create"
    ],
    "datasets": [
      "create"
    ],
    "endpoints": [
      "create"
    ],
    "flows": [
      "create"
    ],
    "integrations": [
      "create"
    ],
    "monitors": [
      "create"
    ],
    "notifiers": [
      "create"
    ],
    "rbac": [
      "create"
    ]
  },
  "viewCapabilities": {},
  "id": "string"
}

Updated

Was this page helpful?