Create role

Body

Defines a role and its associated permissions within the system

application/json

Property	Type	Description
`datasetCapabilities`	`object`	Defines the available permissions for dataset operations
`description`	`string`	Detailed description of the role's purpose and scope
`members`	`string[]`	List of user IDs that are assigned to this role
`name`	`string`Required	Unique name identifier for the role
`orgCapabilities`	`object`	Defines organization-wide permissions and capabilities
`annotations`	`string[]`	Controls the management of annotations across the organization
`apiTokens`	`string[]`	Controls the management of API tokens for authentication
`auditLog`	`string[]`	Controls access to organization audit logs
`billing`	`string[]`	Controls access to billing information and settings
`dashboards`	`string[]`	Controls the management of organization dashboards
`datasets`	`string[]`	Controls the management of organization datasets
`endpoints`	`string[]`	Controls the management of API endpoints
`flows`	`string[]`	Controls the management of data flows and pipelines
`integrations`	`string[]`	Controls the management of third-party integrations
`monitors`	`string[]`	Controls the management of monitoring
`notifiers`	`string[]`	Controls the management of notification settings
`rbac`	`string[]`	Controls access to role-based access control settings
`sharedAccessKeys`	`string[]`	Controls the management of shared access keys
`users`	`string[]`	Controls user management within the organization
`views`	`string[]`	Controls the management of data views
`viewCapabilities`	`object`	Defines the available permissions for view operations

Request

curl -X POST 'https://api.axiom.co/v2/rbac/roles' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"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"],"sharedAccessKeys":["read"],"users":["create"],"views":["create"]},"viewCapabilities":{}}'

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 RequiredRequest body application/json

Response

200The role was successfully created

application/json