Arcade

Arcade Authorization API

The Authorization API from Arcade — 4 operation(s) for authorization.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.arcade.dev
📖
APIReference
https://docs.arcade.dev/en/references/api
📖
Authentication
https://docs.arcade.dev/guides/tool-calling/custom-apps/auth-tool-calling
📖
GettingStarted
https://docs.arcade.dev/en/get-started/quickstarts/call-tool-agent
📖
GettingStarted
https://docs.arcade.dev/en/get-started/quickstarts/mcp-server-quickstart

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/openapi/arcade-authorization-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-tool-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-tool-execution-detail-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-execute-tool-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-execute-tool-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-authorize-tool-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-authorization-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-auth-provider-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-worker-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-hook-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-gateway-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-plugin-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-secret-response-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-tool-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-tool-execution-detail-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-execute-tool-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-execute-tool-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-authorize-tool-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-authorization-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-auth-provider-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-worker-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-hook-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-gateway-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-plugin-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-secret-response-structure.json

Other Resources

🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/rules/arcade-engine-rules.yml
🔗
SDKs
https://github.com/ArcadeAI/arcade-py
🔗
SDKs
https://github.com/ArcadeAI/arcade-js
🔗
SDKs
https://github.com/ArcadeAI/arcade-go
🔗
SDKs
https://github.com/ArcadeAI/arcade-java
🔗
SDKs
https://github.com/ArcadeAI/arcade-dotnet
🔗
CLI
https://docs.arcade.dev/en/references/arcade-cli
🔗
ChangeLog
https://docs.arcade.dev/en/references/changelog

OpenAPI Specification

arcade-authorization-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  description: Reference Documentation for Arcade Engine API
  title: Arcade Admin Authorization API
  contact:
    name: Arcade
    url: https://arcade.dev
    email: contact@arcade.dev
  license:
    name: Proprietary
    url: https://arcade.dev/license
  version: 0.1.0
servers:
- url: https://api.arcade.dev
tags:
- name: Authorization
paths:
  /v1/auth/authorize:
    post:
      security:
      - Bearer: []
      - Bearer: []
      description: Starts the authorization process for given authorization requirements
      tags:
      - Authorization
      summary: Initiate Authorization
      operationId: initiate-authorization
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemas.AuthorizationInitiationRequest'
        description: Authorization request
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/auth.AuthorizationResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.Error'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.Error'
  /v1/auth/confirm_user:
    post:
      security:
      - Bearer: []
      - Bearer: []
      description: Confirms a user's details during an authorization flow
      tags:
      - Authorization
      summary: Confirm User Authorization
      operationId: confirm-user-auth-flow
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemas.AuthorizationConfirmUserRequest'
        description: User confirmation request
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.AuthorizationConfirmUserResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.Error'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.Error'
  /v1/auth/status:
    get:
      security:
      - Bearer: []
      - Bearer: []
      description: 'Checks the status of an ongoing authorization process for a specific tool.

        If ''wait'' param is present, does not respond until either the auth status becomes completed or the timeout is reached.'
      tags:
      - Authorization
      summary: Check Authorization Status
      operationId: auth-status
      parameters:
      - description: Authorization ID
        name: id
        in: query
        required: true
        schema:
          type: string
      - description: Timeout in seconds (max 59)
        name: wait
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/auth.AuthorizationResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.Error'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.Error'
  /v1/auth/validate_custom_verifier:
    post:
      security:
      - Bearer: []
      - Bearer: []
      description: Starts a test authorization flow
      tags:
      - Authorization
      summary: Test Authorization Flow
      operationId: test-authorization-flow
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemas.ValidateCustomVerifierRequest'
        description: Validate custom verifier request
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.ValidateCustomVerifierResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.Error'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas.Error'
components:
  schemas:
    schemas.AuthorizationInitiationRequest:
      type: object
      required:
      - auth_requirement
      - user_id
      properties:
        auth_requirement:
          $ref: '#/components/schemas/auth.AuthorizationRequirement'
        next_uri:
          description: 'Optional: if provided, the user will be redirected to this URI after authorization'
          type: string
        user_id:
          type: string
    auth.AuthorizationResponse:
      type: object
      properties:
        context:
          $ref: '#/components/schemas/auth.AuthorizationContext'
        id:
          type: string
        provider_id:
          type: string
        scopes:
          type: array
          items:
            type: string
        status:
          default: pending
          allOf:
          - $ref: '#/components/schemas/auth.AuthorizationStatus'
        url:
          type: string
        user_id:
          type: string
    schemas.Error:
      type: object
      properties:
        message:
          type: string
        name:
          type: string
    schemas.AuthorizationConfirmUserResponse:
      type: object
      required:
      - auth_id
      properties:
        auth_id:
          type: string
        next_uri:
          type: string
    schemas.ValidateCustomVerifierRequest:
      type: object
      required:
      - user_id
      - verifier_url
      properties:
        user_id:
          type: string
        verifier_url:
          type: string
    schemas.ValidateCustomVerifierResponse:
      type: object
      properties:
        flow_id:
          type: string
        next_uri:
          type: string
    auth.AuthorizationRequirement:
      type: object
      properties:
        id:
          description: one of ID or ProviderID must be set
          type: string
        oauth2:
          $ref: '#/components/schemas/auth.OAuth2AuthorizationRequirement'
        provider_id:
          description: one of ID or ProviderID must be set
          type: string
        provider_type:
          type: string
    auth.AuthorizationContext:
      type: object
      properties:
        token:
          type: string
        user_info:
          type: object
          additionalProperties: true
    auth.AuthorizationStatus:
      type: string
      enum:
      - not_started
      - pending
      - completed
      - failed
      x-enum-varnames:
      - StatusNotStarted
      - StatusPending
      - StatusCompleted
      - StatusFailed
    schemas.AuthorizationConfirmUserRequest:
      type: object
      required:
      - flow_id
      - user_id
      properties:
        flow_id:
          type: string
        user_id:
          type: string
    auth.OAuth2AuthorizationRequirement:
      type: object
      properties:
        scopes:
          type: array
          items:
            type: string
  securitySchemes:
    Bearer:
      description: 'Enter your API key or API token in the format: Bearer <token>'
      type: apiKey
      name: Authorization
      in: header
externalDocs:
  description: Documentation
  url: https://docs.arcade.dev