Mabl OAUTH Token API

openapi: 3.2.0
info:
  title: mabl OAUTH Token API
  description: APIs for interacting with mabl services
  version: 0.599.3.1792436330
  x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: OauthToken
paths:
  /oauth:
    get:
      tags:
      - OauthToken
      summary: Query Oauth Tokens
      description: Used to retrieve the Oauth Tokens for the given organization
      operationId: queryOauthTokens
      parameters:
      - name: organization_id
        in: query
        description: The ID of the organization whose Oauth Tokens should be retrieved
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: token_type
        in: query
        description: The type of Oauth Tokens should be retrieved
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The limit to use for pagination
        required: false
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          format: int32
          default: 100
      - name: cursor
        in: query
        description: The cursor to use for pagination
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: The query result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OauthTokenQueryResult'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Organization not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::OauthToken
    post:
      tags:
      - OauthToken
      summary: Create a new Oauth Token
      description: Used to create a new Oauth Token
      operationId: createOauthToken
      requestBody:
        description: The Oauth Token to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OauthToken'
        required: true
      responses:
        '201':
          description: The Oauth Token that was created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OauthToken'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Organization not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Create::OauthToken
  /oauth/{id}:
    get:
      tags:
      - OauthToken
      summary: Get Oauth Token
      description: Used to retrieve information about an Oauth Token
      operationId: getOauthToken
      parameters:
      - name: id
        in: path
        description: The ID of the Oauth Token to retrieve
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: The Oauth Token with the given ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OauthToken'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Oauth Token not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::OauthToken
    delete:
      tags:
      - OauthToken
      summary: Remove Oauth Token
      description: Used to remove an existing Oauth Token
      operationId: removeOauthToken
      parameters:
      - name: id
        in: path
        description: The ID of the Oauth Token to remove
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: The Oauth Token that was removed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OauthToken'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Oauth Token not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Delete::OauthToken
    patch:
      tags:
      - OauthToken
      summary: Update Oauth Token
      description: Used to update information about an Oauth Token
      operationId: updateOauthToken
      parameters:
      - name: id
        in: path
        description: The ID of the Oauth Token to update
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: If-Match
        in: header
        description: If-Match header according to http/1.1 spec section 14.24
        required: false
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: The Oauth Token fields to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OauthToken'
        required: true
      responses:
        '200':
          description: The updated Oauth Token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OauthToken'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Oauth Token not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::OauthToken
  /oauth/{id}/azureBoardsProjects:
    get:
      tags:
      - OauthToken
      summary: Query Azure Boards Projects
      description: Lists the Azure DevOps projects an Azure Boards OAuth token can see in one organization, so an integration can be configured with a project before it exists.
      operationId: queryAzureBoardsProjects
      parameters:
      - name: id
        in: path
        description: The ID of an Azure Boards Oauth Token
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: organization_url
        in: query
        description: The Azure DevOps organization URL, in the form https://dev.azure.com/{organization}
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: The projects visible to the token, sorted by name
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AzureBoardsProjectList'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Oauth Token not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::OauthToken
  /oauth/{id}/azureBoardsWorkItemTypes:
    get:
      tags:
      - OauthToken
      summary: Query Azure Boards Work Item Types
      description: Lists a project's work item types with the fields mabl's create form can show, and the project's area and iteration paths, so an Azure Boards integration's field settings can be chosen -- including before the integration exists.
      operationId: queryAzureBoardsWorkItemTypes
      parameters:
      - name: id
        in: path
        description: The ID of an Azure Boards Oauth Token
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: organization_url
        in: query
        description: The Azure DevOps organization URL, in the form https://dev.azure.com/{organization}
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: project_id
        in: query
        description: The Azure DevOps project id
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: The project's work item types and classification paths
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AzureBoardsWorkItemTypeCatalog'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Oauth Token not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::OauthToken
  /oauth/exchange:
    post:
      tags:
      - OauthToken
      summary: Fetch an Oauth Token
      description: Used to exchange an Oauth Code for an Oauth Token from an Oauth service provider
      operationId: exchangeOauthCode
      requestBody:
        description: The Oauth Code fields to exchange for a Oauth Token
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OauthCode'
        required: true
      responses:
        '200':
          description: The new Oauth Token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OauthToken'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Oauth Token not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::OauthToken
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:
    OauthTokenQueryResult:
      type: object
      properties:
        oauth_tokens:
          type: array
          description: All Oauth Tokens that matched the query
          readOnly: true
          items:
            $ref: '#/components/schemas/OauthToken'
        cursor:
          type: string
          description: Cursor used for pagination
          readOnly: true
    OauthCode:
      type: object
      properties:
        token_type:
          type: string
          description: Type of token
          enum:
          - slack
          - jira
          - segment
          - azure_boards
        code:
          type: string
          description: Friendly name for this Oauth Token
        redirect_uri:
          type: string
          description: The redirect uri used to generate the code
        organization_id:
          type: string
          description: The ID of the organization associated with this Oauth Code
    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
    Tag:
      required:
      - name
      type: object
      properties:
        name:
          type: string
          description: tag name
          x-mabl-scope: public
        values:
          maxItems: 32
          minItems: 0
          type: array
          items:
            type: string
    AzureBoardsWorkItemTypeCatalog:
      required:
      - area_paths
      - iteration_paths
      - truncated
      - work_item_types
      type: object
      properties:
        work_item_types:
          type: array
          items:
            $ref: '#/components/schemas/AzureBoardsWorkItemTypeFields'
        area_paths:
          type: array
          description: Area paths, as a work item's System.AreaPath takes them
          items:
            type: string
        iteration_paths:
          type: array
          description: Iteration paths, as a work item's System.IterationPath takes them
          items:
            type: string
        truncated:
          type: boolean
          description: True when a path list hit its depth or size limit, so a stored path missing from it is not necessarily gone from Azure
        suggested_work_item_type:
          type: string
          description: 'The type a new integration should default to: the project''s bug type, or Issue on the Basic process. Absent when the project has neither'
    OauthToken:
      type: object
      properties:
        id:
          type: string
          description: The ID of the Oauth Token
        created_time:
          type: integer
          description: Time at which the organization Oauth Token was created
          format: int64
        created_by_id:
          type: string
          description: The ID of the user who created this OAuth token
        last_updated_time:
          type: integer
          description: Time at which the organization Oauth Token was last updated
          format: int64
        last_updated_by_id:
          type: string
          description: The ID of the user who last updated this OAuth token
        organization_id:
          type: string
          description: The ID of the organization associated with this Oauth Token
        token_type:
          type: string
          description: Type of token
          enum:
          - segment
          - slack
          - jira
          - azure_boards
        name:
          type: string
          description: Friendly name for this Oauth Token
        access_token:
          type: string
          description: The Oauth Token value
        scope:
          type: string
          description: The Oauth Token scope
        refresh_token:
          type: string
          description: The refresh token value
        expires_in:
          type: integer
          description: The Oauth Token expiration value
          format: int64
        raw_response:
          type: string
          description: The raw access token result from the issuer
        tags:
          type: array
          description: Free text tags associated with this entity
          items:
            $ref: '#/components/schemas/Tag'
      x-implements-interface:
      - ActivityTrackingBaseEntity
      - HasName
      - HasOrganizationId
    AzureBoardsProject:
      required:
      - id
      - name
      type: object
      properties:
        id:
          type: string
          description: The Azure DevOps project id (a GUID)
        name:
          type: string
          description: The project name
    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.'
    AzureBoardsProjectList:
      required:
      - projects
      type: object
      properties:
        projects:
          type: array
          description: The projects visible to the token
          items:
            $ref: '#/components/schemas/AzureBoardsProject'
    AzureBoardsWorkItemTypeFields:
      required:
      - fields
      - name
      type: object
      properties:
        name:
          type: string
          description: The work item type's name
        fields:
          type: array
          items:
            $ref: '#/components/schemas/AzureBoardsFieldDescriptor'
    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'
    AzureBoardsFieldDescriptor:
      required:
      - name
      - reference_name
      - required
      type: object
      properties:
        reference_name:
          type: string
        name:
          type: string
        required:
          type: boolean
          description: Whether Azure requires the field on create
        custom:
          type: boolean
          description: Whether the field is a process customization rather than a System or Microsoft field
        allowed_values:
          type: array
          description: The values Azure allows, as scalars; empty for free-form fields
          items: {}
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header