Accredify O Auth API

openapi: 3.2.0
info:
  title: Auth Module O Auth API
  version: '1.0'
  description: Auth module endpoints
  contact:
    name: Accredify
    url: https://accredify.io
    email: support@accredify.io
  termsOfService: https://www.accredify.io/legal
servers:
- url: https://nexus.staging.accredify.io
  description: Staging
- url: https://nexus.uat.accredify.io
  description: UAT
- url: https://nexus.accredify.io
  description: Production
tags:
- name: OAuth
paths:
  /oauth/token:
    post:
      summary: Get OAuth access token
      description: 'Obtain an access token using the client credentials grant type. Request only the scopes required by your integration, separated by spaces.


        | Scope | Permission granted |

        | --- | --- |

        | `run-workflow` | Ability to run a specific workflow. |

        | `webcomponent-verification` | Ability to get verification access from the web component. |

        | `verification-suite` | Ability to access the verification suite APIs. |

        | `workflows:read` | Ability to read workflows. |

        | `workflows:write` | Ability to write workflows. |

        | `workflow-runs:read` | Ability to read workflow runs. |

        | `documents:read` | Ability to read documents. |

        | `documents:write` | Ability to write documents. |

        | `custom-views:read` | Ability to read custom views. |

        | `users:read` | Ability to read organization users. |

        | `users:write` | Ability to write organization users. |

        | `design-templates:read` | Ability to read design templates. |

        | `document-templates:read` | Ability to read document templates. |

        | `groups:read` | Ability to read organization groups. |

        | `groups:write` | Ability to write organization groups. |

        | `courses:read` | Ability to read courses. |

        | `courses:write` | Ability to write courses. |

        | `roles:read` | Ability to read organization roles. |

        | `user-tokens:read` | Ability to read user tokens. |

        | `user-tokens:write` | Ability to create and revoke user tokens. |'
      tags:
      - OAuth
      security: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - grant_type
              - client_id
              - client_secret
              properties:
                grant_type:
                  type: string
                  enum:
                  - client_credentials
                  description: OAuth grant type
                client_id:
                  type: string
                  description: OAuth client ID
                client_secret:
                  type: string
                  description: OAuth client secret
                scope:
                  type: string
                  description: Space-separated list of scopes. See the endpoint description for the available scopes and their permissions.
                  example: workflows:read workflow-runs:read documents:read
      responses:
        '200':
          description: Token issued successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthTokenResponse'
              examples:
                Success:
                  value:
                    token_type: Bearer
                    expires_in: 31536000
                    access_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthError'
      operationId: postOauthToken
      x-operation-id-source: derived
components:
  schemas:
    OAuthError:
      type: object
      description: OAuth error response
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - invalid_request
          - invalid_client
          - invalid_grant
          - unauthorized_client
          - unsupported_grant_type
          - invalid_scope
          description: Error code
        error_description:
          type: string
          description: Human-readable error description
        error_uri:
          type: string
          format: uri
          description: URI identifying the error
      examples:
      - error: invalid_client
        error_description: Client authentication failed
        message: Client authentication failed
      - error: unsupported_grant_type
        error_description: The authorization grant type is not supported by the authorization server.
        hint: Check that all required parameters have been provided
        message: The authorization grant type is not supported by the authorization server.
    OAuthTokenResponse:
      type: object
      description: OAuth token response
      required:
      - token_type
      - expires_in
      - access_token
      properties:
        token_type:
          type: string
          enum:
          - Bearer
          description: Type of token issued
        expires_in:
          type: integer
          description: Token expiration time in seconds
        access_token:
          type: string
          description: The access token
        refresh_token:
          type: string
          description: The refresh token (if applicable)
        scope:
          type: string
          description: Space-separated list of granted scopes
      examples:
      - token_type: Bearer
        expires_in: 31536000
        access_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...
  securitySchemes:
    OAuth2:
      type: oauth2
      description: OAuth2 client credentials flow
      flows:
        clientCredentials:
          tokenUrl: /oauth/token
          scopes:
            run-workflow: Ability to run a specific workflow
            webcomponent-verification: Ability to get the verification access from webcomponent
            verification-suite: Ability to access the verification suite APIs
            workflows:read: Ability to read workflows
            workflows:write: Ability to write workflows
            workflow-runs:read: Ability to read workflow runs
            documents:read: Ability to read documents
            documents:write: Ability to write documents
            custom-views:read: Ability to read custom views
            users:read: Ability to read users
            users:write: Ability to write users
            design-templates:read: Ability to read design templates
            document-templates:read: Ability to read document templates
            groups:read: Ability to read groups
            groups:write: Ability to write groups
            courses:read: Ability to read courses
            courses:write: Ability to write courses
            roles:read: Ability to read roles
            user-tokens:read: Ability to read user tokens
            user-tokens:write: Ability to write user tokens