Arthur AI Authorization V1 API

openapi: 3.2.0
info:
  title: Arthur Scope Agents V1 Authorization V1 API
  version: 0.1.0
servers:
- url: https://platform.arthur.ai/api
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Authorization V1
paths:
  /api/v1/workspaces/{workspace_id}/role_bindings:
    post:
      tags:
      - Authorization V1
      summary: Post Workspace Role Binding.
      description: Creates new workspace role binding. Requires workspace_create_role_binding permission.
      operationId: post_workspace_role_binding
      security:
      - OAuth2AuthorizationCode:
        - workspace_create_role_binding
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRoleBinding'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleBinding'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Authorization V1
      summary: List Workspace Role Bindings.
      description: Fetches all workspace role bindings. Requires workspace_list_role_bindings permission.
      operationId: list_workspace_role_bindings
      security:
      - OAuth2AuthorizationCode:
        - workspace_list_role_bindings
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      - name: search
        in: query
        required: false
        schema:
          type: string
          description: Search for role bindings by user name, group name, role name, user ID or group ID.
          title: Search
        description: Search for role bindings by user name, group name, role name, user ID or group ID.
      - name: bound_member_kind
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/BoundMemberKind'
          description: Filter the list of role bindings by the kind of the bound member. Optional.
        description: Filter the list of role bindings by the kind of the bound member. Optional.
      - name: user_types
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/UserType'
          description: Limits the results to a specific set of user types. Only applies to user role bindings.
          default:
          - user
          - service_account
          title: User Types
        description: Limits the results to a specific set of user types. Only applies to user role bindings.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The page to return starting from 1 up to total_pages.
          default: 1
          title: Page
        description: The page to return starting from 1 up to total_pages.
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of records per page. The max is 1000.
          default: 20
          title: Page Size
        description: The number of records per page. The max is 1000.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList_RoleBinding_'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/organization/roles:
    get:
      tags:
      - Authorization V1
      summary: List Roles
      description: Fetches all roles. Requires organization_list_roles permission.
      operationId: list_roles
      security:
      - OAuth2AuthorizationCode:
        - organization_list_roles
      parameters:
      - name: sort
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/RoleSort'
          description: Override the field used for sorting. Optional.
          default: name
        description: Override the field used for sorting. Optional.
      - name: order
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/SortOrder'
          description: Override the sort order of the returned list. Optional.
          default: asc
        description: Override the sort order of the returned list. Optional.
      - name: name
        in: query
        required: false
        schema:
          type: string
          description: Filter the list of roles by name. Optional.
          title: Name
        description: Filter the list of roles by name. Optional.
      - name: organization_bindable
        in: query
        required: false
        schema:
          type: boolean
          description: Filter the list of roles by organization bindable. Optional.
          title: Organization Bindable
        description: Filter the list of roles by organization bindable. Optional.
      - name: workspace_bindable
        in: query
        required: false
        schema:
          type: boolean
          description: Filter the list of roles by workspace bindable. Optional.
          title: Workspace Bindable
        description: Filter the list of roles by workspace bindable. Optional.
      - name: project_bindable
        in: query
        required: false
        schema:
          type: boolean
          description: Filter the list of roles by project bindable. Optional.
          title: Project Bindable
        description: Filter the list of roles by project bindable. Optional.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The page to return starting from 1 up to total_pages.
          default: 1
          title: Page
        description: The page to return starting from 1 up to total_pages.
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of records per page. The max is 1000.
          default: 20
          title: Page Size
        description: The number of records per page. The max is 1000.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList_Role_'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/organization/role_bindings:
    post:
      tags:
      - Authorization V1
      summary: Post Organization Role Binding.
      description: Creates new organization role binding. Requires organization_create_role_binding permission.
      operationId: post_org_role_binding
      security:
      - OAuth2AuthorizationCode:
        - organization_create_role_binding
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRoleBinding'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleBinding'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Authorization V1
      summary: List Organization Role Bindings.
      description: Fetches all organization role bindings. Requires organization_list_role_bindings permission.
      operationId: list_org_role_bindings
      security:
      - OAuth2AuthorizationCode:
        - organization_list_role_bindings
      parameters:
      - name: search
        in: query
        required: false
        schema:
          type: string
          description: Search for role bindings by user name, group name, role name, user ID or group ID.
          title: Search
        description: Search for role bindings by user name, group name, role name, user ID or group ID.
      - name: bound_member_kind
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/BoundMemberKind'
          description: Filter the list of role bindings by the kind of the bound member. Optional.
        description: Filter the list of role bindings by the kind of the bound member. Optional.
      - name: user_types
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/UserType'
          description: Limits the results to a specific set of user types. Only applies to user role bindings.
          default:
          - user
          - service_account
          title: User Types
        description: Limits the results to a specific set of user types. Only applies to user role bindings.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The page to return starting from 1 up to total_pages.
          default: 1
          title: Page
        description: The page to return starting from 1 up to total_pages.
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of records per page. The max is 1000.
          default: 20
          title: Page Size
        description: The number of records per page. The max is 1000.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList_RoleBinding_'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/projects/{project_id}/role_bindings:
    post:
      tags:
      - Authorization V1
      summary: Post Project Role Binding
      description: Creates new project role binding. Requires project_create_role_binding permission.
      operationId: post_project_role_binding
      security:
      - OAuth2AuthorizationCode:
        - project_create_role_binding
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Project Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRoleBinding'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleBinding'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Authorization V1
      summary: List Project Role Bindings.
      description: Fetches all project role bindings. Requires project_list_role_bindings permission.
      operationId: list_project_role_bindings
      security:
      - OAuth2AuthorizationCode:
        - project_list_role_bindings
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Project Id
      - name: search
        in: query
        required: false
        schema:
          type: string
          description: Search for role bindings by user name, group name, role name, parent workspace name or ID, user ID or group ID.
          title: Search
        description: Search for role bindings by user name, group name, role name, parent workspace name or ID, user ID or group ID.
      - name: bound_member_kind
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/BoundMemberKind'
          description: Filter the list of role bindings by the kind of the bound member. Optional.
        description: Filter the list of role bindings by the kind of the bound member. Optional.
      - name: user_types
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/UserType'
          description: Limits the results to a specific set of user types. Only applies to user role bindings.
          default:
          - user
          - service_account
          title: User Types
        description: Limits the results to a specific set of user types. Only applies to user role bindings.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The page to return starting from 1 up to total_pages.
          default: 1
          title: Page
        description: The page to return starting from 1 up to total_pages.
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of records per page. The max is 1000.
          default: 20
          title: Page Size
        description: The number of records per page. The max is 1000.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList_RoleBinding_'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/users/{user_id}/role_bindings:
    get:
      tags:
      - Authorization V1
      summary: Get User Role Bindings.
      description: Lists all role bindings for the user. Requires user_list_role_bindings permission.
      operationId: list_user_role_bindings
      security:
      - OAuth2AuthorizationCode:
        - user_list_role_bindings
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: User Id
      - name: search
        in: query
        required: false
        schema:
          type: string
          description: Search for role bindings by workspace name, project name, role name, workspace ID, or project ID.
          title: Search
        description: Search for role bindings by workspace name, project name, role name, workspace ID, or project ID.
      - name: bound_resource_kind
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/BoundResourceKind'
          description: Filter the list of role bindings by the kind of the bound resource. Optional.
        description: Filter the list of role bindings by the kind of the bound resource. Optional.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The page to return starting from 1 up to total_pages.
          default: 1
          title: Page
        description: The page to return starting from 1 up to total_pages.
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of records per page. The max is 1000.
          default: 20
          title: Page Size
        description: The number of records per page. The max is 1000.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList_RoleBinding_'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/groups/{group_id}/role_bindings:
    get:
      tags:
      - Authorization V1
      summary: Get Group Role Bindings.
      description: Lists all role bindings for the group. Requires group_list_role_bindings permission.
      operationId: list_group_role_bindings
      security:
      - OAuth2AuthorizationCode:
        - group_list_role_bindings
      parameters:
      - name: group_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Group Id
      - name: search
        in: query
        required: false
        schema:
          type: string
          description: Search for role bindings by workspace name, project name, role name, workspace ID, or project ID.
          title: Search
        description: Search for role bindings by workspace name, project name, role name, workspace ID, or project ID.
      - name: bound_resource_kind
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/BoundResourceKind'
          description: Filter the list of role bindings by the kind of the bound resource. Optional.
        description: Filter the list of role bindings by the kind of the bound resource. Optional.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The page to return starting from 1 up to total_pages.
          default: 1
          title: Page
        description: The page to return starting from 1 up to total_pages.
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of records per page. The max is 1000.
          default: 20
          title: Page Size
        description: The number of records per page. The max is 1000.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList_RoleBinding_'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/role_bindings/{role_binding_id}:
    delete:
      tags:
      - Authorization V1
      summary: Delete Role Binding.
      description: Deletes role binding by id. Permission required depends on the role binding type. Deleting an organization role binding requires organization_role_binding_delete permission. Deleting a workspace role binding requires workspace_role_binding_delete permission. Deleting a project role binding requires project_role_binding_delete permission.
      operationId: delete_role_binding
      security:
      - OAuth2AuthorizationCode: []
      parameters:
      - name: role_binding_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Role Binding Id
      responses:
        '204':
          description: Successful Response
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/permissions:
    get:
      tags:
      - Authorization V1
      summary: List Permissions
      description: Returns list of available permissions.
      operationId: list_permissions_library
      security:
      - OAuth2AuthorizationCode: []
      parameters:
      - name: search_string
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: String to search on. Will perform a substring match of name and description.
          title: Search String
        description: String to search on. Will perform a substring match of name and description.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The page to return starting from 1 up to total_pages.
          default: 1
          title: Page
        description: The page to return starting from 1 up to total_pages.
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of records per page. The max is 1000.
          default: 20
          title: Page Size
        description: The number of records per page. The max is 1000.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList_Permission_'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/permissions/check:
    post:
      tags:
      - Authorization V1
      summary: Check Permissions
      description: Check given permissions and returns a list of allowed and not allowed permissions.
      operationId: check_permissions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PermissionsRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionsResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2AuthorizationCode: []
components:
  schemas:
    ResourceKind:
      type: string
      enum:
      - platform
      - organization
      - workspace
      - project
      - model
      - connector
      - available_dataset
      - dataset
      - role_binding
      - role
      - user
      - group
      - data_plane_association
      - data_plane
      - alert_rule
      - webhook
      - custom_aggregation
      - custom_aggregation_test
      - agent
      - policy
      - policy_alert_rule
      - policy_attestation_rule
      - policy_assignment
      title: ResourceKind
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    PermissionName:
      type: string
      enum:
      - organization_read
      - organization_delete
      - organization_update
      - organization_list_workspaces
      - organization_create_workspace
      - organization_list_group_memberships
      - organization_create_user
      - organization_invite_user
      - organization_create_service_account
      - delete_user
      - user_update
      - organization_role_binding_delete
      - organization_create_role_binding
      - organization_list_role_bindings
      - organization_list_users
      - organization_create_group
      - organization_list_groups
      - organization_list_roles
      - group_list_role_bindings
      - group_read
      - group_list_users
      - group_update
      - group_delete
      - group_create_group_membership
      - group_delete_group_membership
      - user_list_role_bindings
      - user_regenerate_creds
      - workspace_read
      - workspace_update
      - workspace_delete
      - workspace_list_projects
      - workspace_create_project
      - workspace_create_data_plane
      - workspace_list_data_planes
      - workspace_list_data_plane_associations
      - workspace_create_data_plane_association
      - workspace_role_binding_delete
      - workspace_create_role_binding
      - workspace_list_role_bindings
      - workspace_create_webhook
      - workspace_list_webhooks
      - workspace_test_webhook
      - workspace_create_custom_aggregation
      - workspace_create_custom_aggregation_test
      - workspace_list_custom_aggregation_tests
      - workspace_validate_custom_aggregation
      - workspace_list_datasets
      - workspace_list_models
      - workspace_list_alerts
      - workspace_list_alert_rules
      - workspace_list_custom_aggregations
      - workspace_list_agents
      - workspace_list_unregistered_agents
      - workspace_list_agent_tools
      - workspace_list_agent_sub_agents
      - workspace_list_agent_llm_models
      - workspace_list_agent_data_sources
      - workspace_get_statistics
      - workspace_governance_view
      - workspace_upsert_agents
      - agent_read
      - unregistered_agent_patch
      - project_read
      - project_update
      - project_delete
      - project_list_models
      - project_create_model
      - project_list_connectors
      - project_create_connector
      - project_list_datasets
      - project_list_jobs
      - project_create_job
      - project_create_dataset
      - project_create_available_dataset
      - project_list_data_plane_associations
      - project_role_binding_delete
      - project_create_role_binding
      - project_list_role_bindings
      - project_generate_metrics_spec
      - project_create_model_task
      - project_create_model_link_task
      - model_read
      - model_update
      - model_delete
      - model_put_metric_config
      - model_list_metric_versions
      - model_create_metric_version
      - model_add_metrics_for_version
      - model_edit_dashboard
      - model_create_alert
      - model_list_alerts
      - model_create_alert_rule
      - model_list_alert_rules
      - model_query_metrics
      - model_metrics_schedule_update
   

# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/arthur-ai/refs/heads/main/openapi/arthur-ai-authorization-v1-api-openapi.yml