Mabl Authorization API

openapi: 3.2.0
info:
  title: mabl Authorization API
  description: APIs for interacting with mabl services
  version: 0.599.3.1792436330
  x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Authorization
paths:
  /authorization/check:
    get:
      tags:
      - Authorization
      summary: Check whether an identity has access to a resource
      description: Performs an authorization check on a resource
      operationId: authorize
      parameters:
      - name: workspaceId
        in: query
        description: ID of the resource's workspace
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: ID of the resource. Leave empty to authorize for the entire resource type
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: resourceId
        in: query
        description: ID of the resource. Leave empty to authorize for the entire resource type
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: scope
        in: query
        description: Scope of the authorization check
        required: true
        style: form
        explode: true
        schema:
          type: string
          enum:
          - read
          - write
          - list
          - read_secret
          - authorize
      - name: feature_flags
        in: query
        description: Required feature flags
        required: false
        style: form
        explode: true
        schema:
          minItems: 1
          type: array
          items:
            type: string
      - name: additional_scopes
        in: query
        description: Additional scope checks to perform (AND'd with the primary check). Each value is a resourceType:permission pair (e.g., artifacts:read).
        required: false
        style: form
        explode: true
        schema:
          minItems: 1
          type: array
          items:
            type: string
      responses:
        '200':
          description: Result of the authorization check
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationResult'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::Authorization
  /authorization/isAuthenticated:
    get:
      tags:
      - Authorization
      summary: Check whether the requesting user is authenticated
      description: Preflight check for whether the requesting user is authenticated
      operationId: isAuthenticated
      responses:
        '200':
          description: Result of the authorization check
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationResult'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::Authorization
components:
  responses:
    ErrorResponse401:
      description: User not authenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse400:
      description: Invalid or missing parameter
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse403:
      description: User not authorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse:
      description: Unknown error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
  schemas:
    GuardrailApprovalKind:
      type: string
      description: Who decides a guardrail approval. SELF is decided by the person the agent acts for; WORKSPACE, for an agent acting for an API key, by a workspace owner or editor.
      enum:
      - SELF
      - WORKSPACE
    GuardrailRefusal:
      type: object
      properties:
        id:
          type: string
          description: The id of the guardrail policy that decided the refusal.
        reason:
          type: string
          description: Why the policy refuses the request, written for the person the agent acts for.
        decision_id:
          type: string
          description: The id of this decision in the guardrail decision log.
        action:
          type: string
          description: The action the request was evaluated as, written Verb::Resource (for example Delete::Test), as declared by the operation's x-mabl-action extension.
        policy_source:
          type: string
          description: 'Who set the deciding policy: workspace for a rule the workspace''s owners wrote, account for a rule set for the workspace''s account, mabl_agent_type for the agent type''s ceiling, and mabl_default for mabl''s own defaults.'
        approval:
          description: The approval for this request; present when error_code is approval_required and the approval could be recorded. Without it the request cannot be approved.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalRef'
      description: The guardrail policy that refused an agent request.
    GuardrailApprovalState:
      type: string
      description: Where a guardrail approval stands. PENDING awaits a decision and expires undecided after 24 hours; APPROVED lets the agent repeat the request, as often as it does, for 20 minutes; DENIED refuses the same request for 20 minutes after the decision, after which asking again opens a new approval; CANCELLED means a person withdrew it while pending or revoked it while approved. EXPIRED and CANCELLED are final.
      enum:
      - PENDING
      - APPROVED
      - DENIED
      - EXPIRED
      - CANCELLED
    GuardrailApprovalRef:
      type: object
      properties:
        id:
          type: string
          description: The approval's id.
        state:
          description: Where the approval stands.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalState'
        kind:
          description: Who decides the approval.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalKind'
        request_expires_time:
          type: integer
          description: When the approval expires if nobody decides it, in epoch milliseconds.
          format: int64
        url:
          type: string
          description: The mabl app page where a person reviews the approval.
      description: 'An approval a guardrail policy asks for. While it is PENDING, stop: give the person the url, tell them the request is waiting for approval, and do not repeat the request or poll in a loop. Once a person tells you it is APPROVED, repeat the identical request with the header X-Mabl-Approval set to id. DENIED means a person said no, so do not work around it.'
    AuthorizationResult:
      type: object
      properties:
        granted:
          type: boolean
          description: Whether the authorization check resulted in granted authorization
        api_key_id:
          type: string
          description: The verified id of the api key, if api key auth used
        user_id:
          type: string
          description: The verified user id if the authentication is user based
    ErrorResponseGeneric:
      type: object
      properties:
        id:
          type: string
          x-mabl-scope: public
        code:
          maximum: 599
          minimum: 100
          type: integer
          format: int32
          x-mabl-scope: public
        message:
          type: string
          x-mabl-scope: public
        error_code:
          type: string
          description: Machine-readable reason for the error, present only when the API names one. Values are guardrail_blocked (a guardrail policy refused an agent request), approval_required (a guardrail policy requires a person to approve the request first).
        guardrail:
          description: The guardrail policy that refused the request; present only when error_code is guardrail_blocked or approval_required.
          allOf:
          - $ref: '#/components/schemas/GuardrailRefusal'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header