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

# List roles

> List all roles in the current organization



## OpenAPI

````yaml /api-reference/specs/iam.yaml get /v1/roles
openapi: 3.0.3
info:
  title: Basaltic IAM API
  version: 1.0.0
  description: |
    Identity for the platform: organizations, accounts, users, groups,
    service accounts, roles and policies, together with the sign-in flows and
    the temporary STS credentials every other Basaltic API authenticates
    against.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://iam.basaltic.sh
    description: Global API endpoint
security:
  - SignatureAuth: []
paths:
  /v1/roles:
    get:
      tags:
        - IAM
      summary: List roles
      description: List all roles in the current organization
      operationId: listRoles
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Marker'
        - $ref: '#/components/parameters/NameFilter'
      responses:
        '200':
          description: List of roles
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - SignatureAuth: []
components:
  parameters:
    Limit:
      name: limit
      in: query
      description: >-
        Maximum number of items to return. A value above the maximum is clamped
        to it rather than rejected, so a page shorter than the one you asked for
        is normal — page until `meta.has_more` is false, not until a page looks
        short.
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      example: 20
    Marker:
      name: marker
      in: query
      description: >-
        Opaque pagination cursor. Echo back the `meta.marker` value from the
        previous page to fetch the next one; do not construct or parse it. The
        token's internal form varies by endpoint (a resource ID, a timestamp, …)
        and is not guaranteed stable across releases.
      required: false
      schema:
        type: string
      example: 550e8400-e29b-41d4-a716-446655440000
    NameFilter:
      name: name
      in: query
      description: Filter by name (exact match or prefix with *)
      required: false
      schema:
        type: string
      example: web-*
  schemas:
    RoleListResponse:
      type: object
      properties:
        roles:
          type: array
          items:
            $ref: '#/components/schemas/Role'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    Role:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          example: b2c3d4e5-f6a7-8901-2345-67890abcdef1
        crn:
          type: string
          readOnly: true
          description: Cloud Resource Name
          example: crn:iam:::role/550e8400-e29b-41d4-a716-446655440000
        name:
          type: string
          example: S3ReadOnly
        description:
          type: string
          example: Read-only access to S3 buckets
        tags:
          $ref: '#/components/schemas/Tags'
        trust_policy:
          $ref: '#/components/schemas/TrustPolicy'
        created_at:
          type: string
          format: date-time
          readOnly: true
          example: '2026-01-15T09:30:00Z'
        updated_at:
          type: string
          format: date-time
          readOnly: true
          example: '2026-01-16T14:20:00Z'
    PaginationMeta:
      type: object
      properties:
        total:
          type: integer
          description: Total number of items
          example: 150
        limit:
          type: integer
          description: Number of items per page
          example: 20
        marker:
          type: string
          description: >-
            Opaque cursor for the next page. Pass it back as the `marker` query
            parameter; treat it as a token, not a value to parse.
          example: 550e8400-e29b-41d4-a716-446655440000
        has_more:
          type: boolean
          description: Whether there are more items
          example: true
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Error code identifying the type of error
              example: INVALID_INPUT
            message:
              type: string
              description: Human-readable error message
              example: Invalid request parameters
            request_id:
              type: string
              format: uuid
              description: Request ID for debugging
              example: 550e8400-e29b-41d4-a716-446655440000
    Tags:
      type: object
      additionalProperties:
        type: string
      example:
        environment: production
        team: backend
    TrustPolicy:
      type: object
      description: Defines who/what can assume this role using CRN patterns
      properties:
        principals:
          type: array
          description: |
            CRN patterns that identify who can assume this role.
            Supports wildcards (*) for matching multiple resources.

            These match the caller's own CRN: an instance presents
            `crn:compute:<region>:<account>:instance/<id>` to AssumeRole via
            IMDS, a service account presents `crn:iam:::service-account/<id>`.
          items:
            type: string
          example:
            - crn:compute:*:*:instance/*
            - crn:iam:::service-account/sa-550e8400
            - crn:iam:::user/u-550e8400
        conditions:
          type: array
          description: Optional conditions for role assumption
          items:
            $ref: '#/components/schemas/PolicyCondition'
      example:
        principals:
          - crn:compute:*:*:instance/*
    PolicyCondition:
      type: object
      description: A condition that must be satisfied for the statement to apply
      required:
        - operator
        - key
        - values
      properties:
        operator:
          type: string
          enum:
            - equals
            - not_equals
            - starts_with
            - ends_with
            - contains
            - in
            - not_in
            - greater_than
            - less_than
            - greater_than_or_equals
            - less_than_or_equals
            - exists
            - not_exists
            - ip_address
            - not_ip_address
          description: The comparison operator
          example: equals
        key:
          type: string
          description: The condition key to evaluate
          example: s3:prefix
        values:
          type: array
          items:
            type: string
          description: Values to compare against
          example:
            - home/
            - shared/
        set_operator:
          type: string
          enum:
            - for_all_values
            - for_any_value
          description: >
            Evaluates `operator` against a multi-valued context key (a set, such
            as

            `basalt:TagKeys` — the tag keys a request carries) rather than a
            single

            value. Omit for an ordinary single-valued condition.


            - `for_all_values` — holds when every member of the request set
              satisfies `operator`. An absent or empty set holds vacuously, so a
              request carrying no tags is not fenced by a tag-key restriction.
            - `for_any_value` — holds when at least one member does. An absent
            or
              empty set does not hold.
          example: for_all_values
  responses:
    Unauthorized:
      description: Authentication required or token invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An internal error occurred
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    SignatureAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >
        Request signing with an access key issued to a service account. An

        HMAC-SHA256 over a canonical form of the request, close to AWS SigV4.

        The `basaltic` CLI signs for you.


        Send `Authorization`, `X-Date` (UTC, `YYYYMMDDTHHMMSSZ`) and `X-Nonce`

        (random per request); add `X-Content-Sha256` to bind a body, and

        `X-Amz-Security-Token` when using temporary credentials.


        ```

        Authorization: BASALTIC-HMAC-SHA256
        Credential=<access_key_id>/<date>/<region>/basaltic/basaltic_request,
        SignedHeaders=host;x-date;x-nonce, Signature=<hex>

        ```


        `<region>` is the region code you are calling, or `global` for the
        global

        services. A signature is valid for 5 minutes from `X-Date`, and mutating

        requests are replay-guarded on the nonce.


        **Full signing procedure, including a working implementation:**

        https://docs.basaltic.sh/authentication


        ## Rate limits

        There is no global request budget. A limit applies only where an

        operation documents a `429`, and that operation says what it counts.

        Those responses carry `X-RateLimit-Limit`, `X-RateLimit-Remaining`,

        `X-RateLimit-Reset` and, on a `429`, `Retry-After` — read them rather

        than hard-coding a number. Retrying before `Retry-After` is refused and

        extends the window. Everything else is bounded by quota, not by request

        rate.

````