Openpath auth API

Authentication and Login

Operations 10

GET /auth/accessTokens/{token} Describe an access token's associated identity and scopes #
POST /auth/login Login #
POST /auth/loginAll Login all successful matches for email/password #
POST /auth/logout Logout #
POST /auth/resetPassword Send email to reset password #
POST /auth/setupMobile Send email with magic link to setup mobile #
POST /auth/accessTokens/refresh Create a new access token with refreshed scopes and expiration time, invalidate old token #
POST /auth/oidc/authorize DEPRECATED - use /auth/sso/authorize instead #
POST /auth/sso/authorize Generate SSO authorize URL (may be OIDC or SAML) #
POST /auth/accessTokens/{token}/validate Validate an access token for proper signature, format, expiration, and active status #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/openpath-auth-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

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

OpenAPI Specification

openpath-auth-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Openpath API Documentation Auth API
  version: 1.0.0
  description: Authentication and Login
servers:
- url: https://api.openpath.com
tags:
- name: auth
  description: Authentication and Login
paths:
  /auth/accessTokens/{token}:
    get:
      summary: Describe an access token's associated identity and scopes
      operationId: describeAccessToken
      description: '__Endpoint name__: describeAccessToken'
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
      tags:
      - auth
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      identityId:
                        type: number
                      identity:
                        type: object
                        properties:
                          id:
                            type: number
                          namespace:
                            type: object
                            properties:
                              id:
                                type: number
                              nickname:
                                type: string
                            required:
                            - id
                        required:
                        - id
                      token:
                        type: string
                      tokenScopeList:
                        type: array
                        items:
                          type: object
                          properties:
                            org:
                              type: object
                              properties:
                                id:
                                  type:
                                  - number
                                  - 'null'
                                name:
                                  type:
                                  - string
                                  - 'null'
                                opal:
                                  type:
                                  - string
                                  - 'null'
                                packagePlans:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: number
                                      package:
                                        type: object
                                        properties:
                                          id:
                                            type: number
                                          name:
                                            type: string
                                          packageFeatures:
                                            type: array
                                            items:
                                              type: object
                                              properties:
                                                id:
                                                  type: number
                                                config:
                                                  type:
                                                  - object
                                                  - 'null'
                                                feature:
                                                  type: object
                                                  properties:
                                                    id:
                                                      type: number
                                                    name:
                                                      type: string
                                                    code:
                                                      type: string
                                                  required:
                                                  - id
                                              required:
                                              - id
                                        required:
                                        - id
                                      isSelected:
                                        type: boolean
                                    required:
                                    - id
                                parentOrg:
                                  type:
                                  - object
                                  - 'null'
                                  properties:
                                    id:
                                      type: number
                                    name:
                                      type: string
                                  required:
                                  - id
                                orgNativeApps:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      failureReason:
                                        type:
                                        - string
                                        - 'null'
                                      url:
                                        type:
                                        - string
                                        - 'null'
                                      status:
                                        type: string
                                        enum:
                                        - A
                                        - E
                                        - I
                                        - P
                                        - S
                                      config:
                                        type:
                                        - object
                                        - 'null'
                                      nativeApp:
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          url:
                                            type:
                                            - string
                                            - 'null'
                                        required:
                                        - id
                                    required:
                                    - id
                                    - nativeApp
                                isUnified:
                                  type: boolean
                              required:
                              - id
                            user:
                              type: object
                              properties:
                                id:
                                  type:
                                  - number
                                  - 'null'
                                opal:
                                  type:
                                  - string
                                  - 'null'
                                needsMFACredential:
                                  type: boolean
                              required:
                              - id
                            scope:
                              type:
                              - array
                              - 'null'
                              items:
                                type: string
                            policySection:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: number
                                  nativeAppId:
                                    type:
                                    - number
                                    - 'null'
                                  site:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        id:
                                          type: number
                                      required:
                                      - id
                                  role:
                                    type: object
                                    properties:
                                      id:
                                        type: number
                                    required:
                                    - id
                                required:
                                - id
                            scopeWithContext:
                              type: array
                              items:
                                type: object
                                properties:
                                  context:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        mfa:
                                          type: boolean
                                        needsMFACredential:
                                          type: boolean
                                        fsa:
                                          type: boolean
                                  scope:
                                    type: array
                                    items:
                                      type: string
                      createdAt:
                        type: string
                        format: date
                      expiresAt:
                        type:
                        - string
                        - 'null'
                        format: date
                  meta:
                    type: object
                    properties:
                      accessToken:
                        type:
                        - object
                        - 'null'
                        properties:
                          scopeUpdatedAt:
                            type: string
                            format: date
                      siteSpecificAccess:
                        type:
                        - object
                        - 'null'
                        properties:
                          isSiteSpecific:
                            type: boolean
                          siteIds:
                            type:
                            - array
                            - 'null'
                            items:
                              type: integer
                          siteIdsByScope:
                            type:
                            - object
                            - 'null'
                            properties:
                              string:
                                type:
                                - array
                                - 'null'
                                items:
                                  type: integer
  /auth/login:
    post:
      summary: Login
      operationId: login
      description: '__Endpoint name__: login'
      tags:
      - auth
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      identityId:
                        type: number
                      identity:
                        type: object
                        properties:
                          id:
                            type: number
                          namespace:
                            type: object
                            properties:
                              id:
                                type: number
                              nickname:
                                type: string
                            required:
                            - id
                        required:
                        - id
                      token:
                        type: string
                      tokenScopeList:
                        type: array
                        items:
                          type: object
                          properties:
                            org:
                              type: object
                              properties:
                                id:
                                  type:
                                  - number
                                  - 'null'
                                name:
                                  type:
                                  - string
                                  - 'null'
                                opal:
                                  type:
                                  - string
                                  - 'null'
                                packagePlans:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: number
                                      package:
                                        type: object
                                        properties:
                                          id:
                                            type: number
                                          name:
                                            type: string
                                          packageFeatures:
                                            type: array
                                            items:
                                              type: object
                                              properties:
                                                id:
                                                  type: number
                                                config:
                                                  type:
                                                  - object
                                                  - 'null'
                                                feature:
                                                  type: object
                                                  properties:
                                                    id:
                                                      type: number
                                                    name:
                                                      type: string
                                                    code:
                                                      type: string
                                                  required:
                                                  - id
                                              required:
                                              - id
                                        required:
                                        - id
                                      isSelected:
                                        type: boolean
                                    required:
                                    - id
                                parentOrg:
                                  type:
                                  - object
                                  - 'null'
                                  properties:
                                    id:
                                      type: number
                                    name:
                                      type: string
                                  required:
                                  - id
                                orgNativeApps:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      failureReason:
                                        type:
                                        - string
                                        - 'null'
                                      url:
                                        type:
                                        - string
                                        - 'null'
                                      status:
                                        type: string
                                        enum:
                                        - A
                                        - E
                                        - I
                                        - P
                                        - S
                                      config:
                                        type:
                                        - object
                                        - 'null'
                                      nativeApp:
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          url:
                                            type:
                                            - string
                                            - 'null'
                                        required:
                                        - id
                                    required:
                                    - id
                                    - nativeApp
                                isUnified:
                                  type: boolean
                              required:
                              - id
                            user:
                              type: object
                              properties:
                                id:
                                  type:
                                  - number
                                  - 'null'
                                opal:
                                  type:
                                  - string
                                  - 'null'
                                needsMFACredential:
                                  type: boolean
                              required:
                              - id
                            scope:
                              type:
                              - array
                              - 'null'
                              items:
                                type: string
                            policySection:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: number
                                  nativeAppId:
                                    type:
                                    - number
                                    - 'null'
                                  site:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        id:
                                          type: number
                                      required:
                                      - id
                                  role:
                                    type: object
                                    properties:
                                      id:
                                        type: number
                                    required:
                                    - id
                                required:
                                - id
                            scopeWithContext:
                              type: array
                              items:
                                type: object
                                properties:
                                  context:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        mfa:
                                          type: boolean
                                        needsMFACredential:
                                          type: boolean
                                        fsa:
                                          type: boolean
                                  scope:
                                    type: array
                                    items:
                                      type: string
                      createdAt:
                        type: string
                        format: date
                      expiresAt:
                        type:
                        - string
                        - 'null'
                        format: date
                  meta:
                    type: object
                    properties:
                      accessToken:
                        type:
                        - object
                        - 'null'
                        properties:
                          scopeUpdatedAt:
                            type: string
                            format: date
                      siteSpecificAccess:
                        type:
                        - object
                        - 'null'
                        properties:
                          isSiteSpecific:
                            type: boolean
                          siteIds:
                            type:
                            - array
                            - 'null'
                            items:
                              type: integer
                          siteIdsByScope:
                            type:
                            - object
                            - 'null'
                            properties:
                              string:
                                type:
                                - array
                                - 'null'
                                items:
                                  type: integer
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                namespaceId:
                  type: integer
                namespaceNickname:
                  type: string
                  minLength: 1
                  maxLength: 255
                email:
                  type: string
                  x-format:
                    email: true
                  x-convert:
                    trim: true
                password:
                  type: string
                mfa:
                  type: object
                  properties:
                    totpCode:
                      type: string
                forMobileLogin:
                  type: boolean
              required:
              - email
              - password
  /auth/loginAll:
    post:
      summary: Login all successful matches for email/password
      operationId: loginAll
      description: '__Endpoint name__: loginAll'
      tags:
      - auth
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalCount:
                    type: integer
                  filteredCount:
                    type: integer
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        identityId:
                          type: number
                        identity:
                          type: object
                          properties:
                            id:
                              type: number
                            namespace:
                              type: object
                              properties:
                                id:
                                  type: number
                                nickname:
                                  type: string
                              required:
                              - id
                          required:
                          - id
                        token:
                          type: string
                        tokenScopeList:
                          type: array
                          items:
                            type: object
                            properties:
                              org:
                                type: object
                                properties:
                                  id:
                                    type:
                                    - number
                                    - 'null'
                                  name:
                                    type:
                                    - string
                                    - 'null'
                                  opal:
                                    type:
                                    - string
                                    - 'null'
                                  packagePlans:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        id:
                                          type: number
                                        package:
                                          type: object
                                          properties:
                                            id:
                                              type: number
                                            name:
                                              type: string
                                            packageFeatures:
                                              type: array
                                              items:
                                                type: object
                                                properties:
                                                  id:
                                                    type: number
                                                  config:
                                                    type:
                                                    - object
                                                    - 'null'
                                                  feature:
                                                    type: object
                                                    properties:
                                                      id:
                                                        type: number
                                                      name:
                                                        type: string
                                                      code:
                                                        type: string
                                                    required:
                                                    - id
                                                required:
                                                - id
                                          required:
                                          - id
                                        isSelected:
                                          type: boolean
                                      required:
                                      - id
                                  parentOrg:
                                    type:
                                    - object
                                    - 'null'
                                    properties:
                                      id:
                                        type: number
                                      name:
                                        type: string
                                    required:
                                    - id
                                  orgNativeApps:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        id:
                                          type: integer
                                        failureReason:
                                          type:
                                          - string
                                          - 'null'
                                        url:
                                          type:
                                          - string
                                          - 'null'
                                        status:
                                          type: string
                                          enum:
                                          - A
                                          - E
                                          - I
                                          - P
                                          - S
                                        config:
                                          type:
                                          - object
                                          - 'null'
                                        nativeApp:
                                          type: object
                                          properties:
                                            id:
                                              type: integer
                                            url:
                                              type:
                                              - string
                                              - 'null'
                                          required:
                                          - id
                                      required:
                                      - id
                                      - nativeApp
                                  isUnified:
                                    type: boolean
                                required:
                                - id
                              user:
                                type: object
                                properties:
                                  id:
                                    type:
                                    - number
                                    - 'null'
                                  opal:
                                    type:
                                    - string
                                    - 'null'
                                  needsMFACredential:
                                    type: boolean
                                required:
                                - id
                              scope:
                                type:
                                - array
                                - 'null'
                                items:
                     

# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-auth-api-openapi.yml