Mabl Resource Group API

openapi: 3.2.0
info:
  title: mabl Resource Group API
  description: APIs for interacting with mabl services
  version: 0.599.3.1792436330
  x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: ResourceGroup
paths:
  /resourceGroups:
    get:
      tags:
      - ResourceGroup
      summary: Query ResourceGroups
      description: Used to query ResourceGroups
      operationId: queryResourceGroups
      parameters:
      - name: parent_namespace
        in: query
        description: Namespace of the parent for which to query ResourceGroups
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/ResourceGroupParentNamespace'
      - name: parent_id
        in: query
        description: ID of the parent for which to query ResourceGroups
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: resource_namespace
        in: query
        description: Namespace of the resource for which to query ResourceGroupBindings. Required when querying resource groups associated with a specific resource.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: resource_id
        in: query
        description: ID of the resource for which to query ResourceGroupBindings. Required when querying resource groups associated with a specific resource.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: short_name
        in: query
        description: short name of the resource group to query by (partial match)
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Results of the query
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceGroupQueryResult'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::ResourceGroup
    post:
      tags:
      - ResourceGroup
      summary: Create ResourceGroup
      description: The ResourceGroup to create
      operationId: createResourceGroup
      requestBody:
        description: The ResourceGroup to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceGroup'
        required: true
      responses:
        '201':
          description: The ResourceGroup that was created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceGroup'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Create::ResourceGroup
  /recover/resourceGroups/{id}:
    post:
      tags:
      - ResourceGroup
      summary: Recover ResourceGroup and associated bindings
      description: Recover a ResourceGroup
      operationId: recoverResourceGroup
      parameters:
      - name: id
        in: path
        description: The ID of the ResourceGroup to recover
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: ResourceGroup recovered
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceGroup'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: ResourceGroup not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Recover::ResourceGroup
  /resourceGroups/{id}:
    get:
      tags:
      - ResourceGroup
      summary: Get ResourceGroup details
      description: Get the details for a given ResourceGroup
      operationId: getResourceGroup
      parameters:
      - name: id
        in: path
        description: The ID of the ResourceGroup to retrieve
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: ResourceGroup found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceGroup'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: ResourceGroup not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::ResourceGroup
    delete:
      tags:
      - ResourceGroup
      summary: Delete ResourceGroup and associated bindings
      description: Delete a ResourceGroup
      operationId: removeResourceGroup
      parameters:
      - name: id
        in: path
        description: The ID of the ResourceGroup to delete
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: ResourceGroup deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceGroup'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: ResourceGroup not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Delete::ResourceGroup
    patch:
      tags:
      - ResourceGroup
      summary: Patch ResourceGroup details
      description: Patch the details for a given ResourceGroup
      operationId: patchResourceGroup
      parameters:
      - name: id
        in: path
        description: The ID of the ResourceGroup to patch
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: The partial ResourceGroup patch
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceGroup'
        required: true
      responses:
        '200':
          description: ResourceGroup patched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceGroup'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: ResourceGroup not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::ResourceGroup
  /resourceGroups/{resource_group_id}/bindings/{resource_namespace}/{resource_id}:
    put:
      tags:
      - ResourceGroup
      summary: Add ResourceGroupBinding
      description: Add a ResourceGroupBinding
      operationId: addResourceGroupBinding
      parameters:
      - name: resource_group_id
        in: path
        description: The ID of the ResourceGroup to bind to the resource
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: resource_namespace
        in: path
        description: The namespace of the resource
        required: true
        style: simple
        explode: false
        schema:
          $ref: '#/components/schemas/ResourceGroupBindingNamespace'
      - name: resource_id
        in: path
        description: The ID of the resource to bind to the ResourceGroup
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: The ResourceGroupBinding that was added or updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceGroupBinding'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: ResourceGroup or resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Create::ResourceGroup
    delete:
      tags:
      - ResourceGroup
      summary: Remove ResourceGroupBinding for the specified resource
      description: Remove a ResourceGroupBinding
      operationId: removeResourceGroupBinding
      parameters:
      - name: resource_group_id
        in: path
        description: The ID of the ResourceGroup to bind to the resource
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: resource_namespace
        in: path
        description: The namespace of the resource
        required: true
        style: simple
        explode: false
        schema:
          $ref: '#/components/schemas/ResourceGroupBindingNamespace'
      - name: resource_id
        in: path
        description: The ID of the resource to bind to the ResourceGroup
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: ResourceGroupBinding removed from the ResourceGroup
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceGroupBinding'
        '204':
          description: ResourceGroup exists but the ResourceGroupBinding did not
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: ResourceGroup not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::ResourceGroup
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:
    ResourceGroupBinding:
      type: object
      properties:
        namespaced_resource_id:
          type: string
          description: Namespaced ID of the associated resource, which includes the resource's namespace
        resource_id:
          type: string
          description: Unique ID of the associated resource
        resource_namespace:
          $ref: '#/components/schemas/ResourceGroupBindingNamespace'
        resource_group_id:
          type: string
          description: Unique ID of the associated ResourceGroup
        created_time:
          type: integer
          description: Time at which the ResourceGroupBinding was created
          format: int64
          readOnly: true
        created_by_id:
          type: string
          description: The ID of the user who created this ResourceGroupBinding
      description: A ResourceGroupBinding
    ResourceGroupBindingNamespace:
      type: string
      description: Namespace of the resource bound by this ResourceGroupBinding
      enum:
      - credentials
      - datatables
    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.
    ResourceGroup:
      type: object
      properties:
        id:
          type: string
          description: Unique ID of the ResourceGroup
        short_name:
          type: string
          description: Short name of the ResourceGroup
        namespaced_name:
          type: string
          description: Fully qualified name of the ResourceGroup that includes the parent_id
        parent_id:
          type: string
          description: ID of the parent to which this ResourceGroup belongs
        parent_namespace:
          $ref: '#/components/schemas/ResourceGroupParentNamespace'
        parent:
          type: string
          description: Fully qualified parent to which this ResourceGroup belongs
        description:
          type: string
          description: A short description of the ResourceGroup
        created_time:
          type: integer
          description: Time at which the ResourceGroup was created
          format: int64
          readOnly: true
        created_by_id:
          type: string
          description: The ID of the user who created this ResourceGroup
        last_updated_time:
          type: integer
          description: Time at which the ResourceGroup was last updated
          format: int64
          readOnly: true
        last_updated_by_id:
          type: string
          description: The ID of the user who last updated this ResourceGroup
      description: A ResourceGroup
      x-implements-interface:
      - HasId
      - HasCreatedActivity
      - HasUpdatedActivity
    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
    ResourceGroupParentNamespace:
      type: string
      description: Namespace of the parent to which this ResourceGroup belongs
      enum:
      - workspaces
    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.'
    ResourceGroupQueryResult:
      type: object
      properties:
        resource_groups:
          type: array
          description: All ResourceGroups that matched the query
          readOnly: true
          items:
            $ref: '#/components/schemas/ResourceGroup'
    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