PropelAuth Access Tokens API

Mint short-lived access tokens for impersonation and testing

OpenAPI Specification

propelauth-access-tokens-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: PropelAuth End-User API Keys Access Tokens API
  description: 'Backend REST API for validating, issuing, listing, and revoking API keys that PropelAuth

    manages on behalf of your end users and tenant organizations. API keys can be scoped to a

    personal user, an organization, or imported from a legacy auth system. All endpoints

    require a PropelAuth Backend Integration API key.

    '
  version: 1.0.0
  contact:
    name: PropelAuth Support
    url: https://www.propelauth.com
    email: support@propelauth.com
  license:
    name: PropelAuth Terms
    url: https://www.propelauth.com/legal/terms-of-service
servers:
- url: https://{authId}.propelauthtest.com
  description: Test environment
  variables:
    authId:
      default: '0000000000'
- url: https://auth.example.com
  description: Production / Staging custom domain
security:
- BackendApiKey: []
tags:
- name: Access Tokens
  description: Mint short-lived access tokens for impersonation and testing
paths:
  /api/backend/v1/access_token:
    post:
      summary: Create Access Token
      description: Mint a short-lived access token for a user (impersonation, testing, scripted automation).
      operationId: createAccessToken
      tags:
      - Access Tokens
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - user_id
              properties:
                user_id:
                  type: string
                  format: uuid
                duration_in_minutes:
                  type: integer
                  minimum: 1
                  maximum: 1440
                active_org_id:
                  type: string
                  format: uuid
      responses:
        '200':
          description: Access token created
          content:
            application/json:
              schema:
                type: object
                properties:
                  access_token:
                    type: string
components:
  securitySchemes:
    BackendApiKey:
      type: http
      scheme: bearer