> ## Documentation Index
> Fetch the complete documentation index at: https://axiom.co/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve role

> Retrieves detailed information about a specific role by its unique identifier.



## OpenAPI

````yaml v2 get /rbac/roles/{id}
openapi: 3.0.0
info:
  description: A public and stable API for interacting with axiom services
  title: Axiom
  termsOfService: http://axiom.co/terms
  contact:
    name: Axiom support team
    url: https://axiom.co
    email: hello@axiom.co
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 2.0.0
servers:
  - url: https://api.axiom.co/v2/
security:
  - bearerAuth: []
paths:
  /rbac/roles/{id}:
    get:
      tags:
        - rbac
      summary: Get role by ID
      description: >-
        Retrieves detailed information about a specific role by its unique
        identifier.
      operationId: getRoleById
      parameters:
        - description: Unique identifier of the role to retrieve
          name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The role was successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleWithID'
      security:
        - Auth:
            - rbac|read
components:
  schemas:
    RoleWithID:
      description: Extends the base Role type to include a unique identifier
      allOf:
        - $ref: '#/components/schemas/Role'
        - type: object
          required:
            - id
          properties:
            id:
              description: Unique identifier for the role
              type: string
    Role:
      description: Defines a role and its associated permissions within the system
      type: object
      required:
        - name
      properties:
        datasetCapabilities:
          $ref: '#/components/schemas/roleDatasetCapabilities'
        description:
          description: Detailed description of the role's purpose and scope
          type: string
        members:
          description: List of user IDs that are assigned to this role
          type: array
          items:
            type: string
        name:
          description: Unique name identifier for the role
          type: string
        orgCapabilities:
          $ref: '#/components/schemas/roleOrgCapabilities'
        viewCapabilities:
          $ref: '#/components/schemas/roleViewCapabilities'
    roleDatasetCapabilities:
      description: Defines the available permissions for dataset operations
      type: object
      additionalProperties:
        properties:
          data:
            description: Controls data management operations like deletion
            type: array
            items:
              type: string
              enum:
                - delete
            x-omitempty: true
          ingest:
            description: Controls the ability to ingest data into datasets
            type: array
            items:
              type: string
              enum:
                - create
            x-omitempty: true
          query:
            description: Controls the ability to query and read data from datasets
            type: array
            items:
              type: string
              enum:
                - read
            x-omitempty: true
          share:
            description: Controls the ability to share datasets with other users
            type: array
            items:
              type: string
              enum:
                - create
                - read
                - delete
            x-omitempty: true
          starredQueries:
            description: Controls the management of starred/saved queries
            type: array
            items:
              type: string
              enum:
                - create
                - read
                - update
                - delete
            x-omitempty: true
          trim:
            description: Controls data trimming operations for storage optimization
            type: array
            items:
              type: string
              enum:
                - update
            x-omitempty: true
          vacuum:
            description: Controls field vacuuming operations for storage optimization
            type: array
            items:
              type: string
              enum:
                - update
            x-omitempty: true
          virtualFields:
            description: Controls the management of virtual fields in datasets
            type: array
            items:
              type: string
              enum:
                - create
                - read
                - update
                - delete
            x-omitempty: true
    roleOrgCapabilities:
      description: Defines organization-wide permissions and capabilities
      type: object
      properties:
        annotations:
          description: Controls the management of annotations across the organization
          type: array
          items:
            type: string
            enum:
              - create
              - read
              - update
              - delete
          x-omitempty: true
        apiTokens:
          description: Controls the management of API tokens for authentication
          type: array
          items:
            type: string
            enum:
              - create
              - read
              - update
              - delete
          x-omitempty: true
        auditLog:
          description: Controls access to organization audit logs
          type: array
          items:
            type: string
            enum:
              - read
          x-omitempty: true
        billing:
          description: Controls access to billing information and settings
          type: array
          items:
            type: string
            enum:
              - read
              - update
          x-omitempty: true
        dashboards:
          description: Controls the management of organization dashboards
          type: array
          items:
            type: string
            enum:
              - create
              - read
              - update
              - delete
          x-omitempty: true
        datasets:
          description: Controls the management of organization datasets
          type: array
          items:
            type: string
            enum:
              - create
              - read
              - update
              - delete
          x-omitempty: true
        endpoints:
          description: Controls the management of API endpoints
          type: array
          items:
            type: string
            enum:
              - create
              - read
              - update
              - delete
          x-omitempty: true
        flows:
          description: Controls the management of data flows and pipelines
          type: array
          items:
            type: string
            enum:
              - create
              - read
              - update
              - delete
          x-omitempty: true
        integrations:
          description: Controls the management of third-party integrations
          type: array
          items:
            type: string
            enum:
              - create
              - read
              - update
              - delete
          x-omitempty: true
        monitors:
          description: Controls the management of monitoring
          type: array
          items:
            type: string
            enum:
              - create
              - read
              - update
              - delete
          x-omitempty: true
        notifiers:
          description: Controls the management of notification settings
          type: array
          items:
            type: string
            enum:
              - create
              - read
              - update
              - delete
          x-omitempty: true
        rbac:
          description: Controls access to role-based access control settings
          type: array
          items:
            type: string
            enum:
              - create
              - read
              - update
              - delete
          x-omitempty: true
        sharedAccessKeys:
          description: Controls the management of shared access keys
          type: array
          items:
            type: string
            enum:
              - read
              - update
          x-omitempty: true
        users:
          description: Controls user management within the organization
          type: array
          items:
            type: string
            enum:
              - create
              - read
              - update
              - delete
          x-omitempty: true
        views:
          description: Controls the management of data views
          type: array
          items:
            type: string
            enum:
              - create
              - read
              - update
              - delete
          x-omitempty: true
    roleViewCapabilities:
      description: Defines the available permissions for view operations
      type: object
      additionalProperties:
        properties:
          query:
            description: Controls the ability to query and read data from views
            type: array
            items:
              type: string
              enum:
                - read
            x-omitempty: true
          share:
            description: Controls the ability to share views with other users
            type: array
            items:
              type: string
              enum:
                - create
                - read
                - delete
            x-omitempty: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate using an API token or personal access token (PAT). Include
        the token as a Bearer token: `Authorization: Bearer <token>`. For more
        information, see [Tokens](/reference/tokens).
    Auth:
      description: >-
        Authenticate using an API token or personal access token (PAT). Include
        the token as a Bearer token: `Authorization: Bearer <token>`. For more
        information, see [Tokens](/reference/tokens).
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/v2/auth
          tokenUrl: https://www.googleapis.com/oauth2/v4/token
          scopes: {}

````

Built with [Mintlify](https://mintlify.com).