find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/mabl:mabl-role-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: mabl Role API
  description: APIs for interacting with mabl services
  version: 0.599.3.1792436330
  x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Role
paths:
  /user-roles/{id}:
    get:
      tags:
      - Role
      summary: Get User Roles
      description: Used to get all of a user's roles
      operationId: getUserRoles
      parameters:
      - name: id
        in: path
        description: The ID of the user whose roles should be retrieved
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: The complete list of roles for this user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRoles'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::User
    patch:
      tags:
      - Role
      summary: Update User Roles
      description: Used to modify roles for a user. Available to global write clients, owners or company owners of all affected workspaces, API keys with write:users scope on every affected workspace, and to the user themselves for removals only. Adding a role in a workspace where the user already holds one returns 409.
      operationId: updateUserRoles
      parameters:
      - name: id
        in: path
        description: The user ID 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. Allows for enforced atomic updates, to prevent update collisions
        required: false
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: The user roles to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRoleUpdate'
        required: true
      responses:
        '200':
          description: The complete list of roles after applying this update
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRoles'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::User
  /user-company-roles/{id}:
    get:
      tags:
      - Role
      summary: Get User's Company Roles
      description: Used to get all of a user's company roles
      operationId: getUserCompanyRoles
      parameters:
      - name: id
        in: path
        description: The ID of the user whose company roles should be retrieved
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: The complete list of company roles for this user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCompanyRoles'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::User
    patch:
      tags:
      - Role
      summary: Update User's Company Roles
      description: Used to modify company roles for a user
      operationId: updateUserCompanyRoles
      parameters:
      - name: id
        in: path
        description: The user ID 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. Allows for enforced atomic updates, to prevent update collisions
        required: false
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: The user roles to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCompanyRoleUpdate'
        required: true
      responses:
        '200':
          description: The complete list of roles after applying this update
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCompanyRoles'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::User
  /user-roles/acknowledge/{workspace_id}:
    post:
      tags:
      - Role
      summary: Acknowledge users own role in the specified workspace
      description: Acknowledging a workspace role means the user has been presented with and dismissed information about their role and joining their new workspace
      operationId: acknowledgeWorkspaceRole
      parameters:
      - name: workspace_id
        in: path
        description: The workspace in which the role will be acknowledged
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: No content response indicates successful acknowledgement of the role.
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: User or user role not found in this workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::User
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:
    UserCompanyRole:
      required:
      - company_id
      - role
      type: object
      properties:
        role:
          $ref: '#/components/schemas/UserRoleEnum'
        company_id:
          type: string
          description: The company to which this role applies
    UserRoleUpdate:
      type: object
      properties:
        add:
          type: array
          items:
            $ref: '#/components/schemas/UserRole'
        remove:
          type: array
          items:
            $ref: '#/components/schemas/UserRole'
    UserCompanyRoleUpdate:
      type: object
      properties:
        add:
          type: array
          items:
            $ref: '#/components/schemas/UserCompanyRole'
        remove:
          type: array
          items:
            $ref: '#/components/schemas/UserCompanyRole'
    UserRole:
      required:
      - role
      type: object
      properties:
        role:
          $ref: '#/components/schemas/UserRoleEnum'
        workspace_id:
          type: string
          description: The workspace this role applies to. Preferred over `organization_id`. At least one of `workspace_id` or `organization_id` must be present.
          x-mabl-scope: public
        organization_id:
          type: string
          description: Deprecated alias for `workspace_id`. Retained so legacy callers keep working; new code should use `workspace_id`.
          deprecated: true
        acknowledged_status:
          type: string
          description: Status marking whether the user has acknowledged the welcome message in the joined workspace
          enum:
          - requires_acknowledgement
          - acknowledged
    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
    UserCompanyRoles:
      required:
      - roles
      type: object
      properties:
        roles:
          type: array
          items:
            $ref: '#/components/schemas/UserCompanyRole'
    UserRoles:
      required:
      - roles
      type: object
      properties:
        roles:
          type: array
          items:
            $ref: '#/components/schemas/UserRole'
          x-mabl-scope: public
    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.'
    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'
    UserRoleEnum:
      type: string
      description: The possible values for user role
      enum:
      - owner
      - editor
      - viewer
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header