Annotation endpoints
API token endpoints
Dataset endpoints
Edge endpoints
Map field endpoints
Monitor endpoints
Notifier endpoints
Organization endpoints
Role-Based Access Control endpoints
Saved queries endpoints
User endpoints
List all roles
Retrieves all roles in the organization with their associated permissions and members.
curl --request GET \
--url https://api.axiom.co/v2/rbac/roles \
--header 'Authorization: Bearer <token>'[
{
"name": "<string>",
"id": "<string>",
"datasetCapabilities": {},
"description": "<string>",
"members": [
"<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": {}
}
]Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Response
A list of roles was successfully retrieved
Unique name identifier for the role
Unique identifier for the role
Defines the available permissions for dataset operations
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Controls data management operations like deletion
delete Controls the ability to ingest data into datasets
create Controls the ability to query and read data from datasets
read Controls the ability to share datasets with other users
create, read, delete Controls the management of starred/saved queries
create, read, update, delete Controls data trimming operations for storage optimization
update Controls field vacuuming operations for storage optimization
update Controls the management of virtual fields in datasets
create, read, update, delete Detailed description of the role's purpose and scope
List of user IDs that are assigned to this role
Defines organization-wide permissions and capabilities
Show child attributes
Show child attributes
Controls the management of annotations across the organization
create, read, update, delete Controls the management of API tokens for authentication
create, read, update, delete Controls access to organization audit logs
read Controls access to billing information and settings
read, update Controls the management of organization dashboards
create, read, update, delete Controls the management of organization datasets
create, read, update, delete Controls the management of API endpoints
create, read, update, delete Controls the management of data flows and pipelines
create, read, update, delete Controls the management of third-party integrations
create, read, update, delete Controls the management of monitoring
create, read, update, delete Controls the management of notification settings
create, read, update, delete Controls access to role-based access control settings
create, read, update, delete Controls the management of shared access keys
read, update Controls user management within the organization
create, read, update, delete Controls the management of data views
create, read, update, delete Defines the available permissions for view operations
Show child attributes
Show child attributes
Was this page helpful?
curl --request GET \
--url https://api.axiom.co/v2/rbac/roles \
--header 'Authorization: Bearer <token>'[
{
"name": "<string>",
"id": "<string>",
"datasetCapabilities": {},
"description": "<string>",
"members": [
"<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": {}
}
]