Fax for Agents OAuth API

openapi: 3.2.0
info:
  title: Faxforagents OAuth API
  version: 1.4.3
  contact:
    name: Fax for Agents
    url: https://faxforagents.com/contact/
    email: hello@faxforagents.com
  termsOfService: https://faxforagents.com/terms/
  x-refined-note:
  - x-snapshot differs across the merged source definitions and was not carried
  description: 'Operations tagged oauth across 2 of this provider''s published API definitions: faxforagents-api-openapi.json, faxforagents-site-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.faxforagents.com
  description: Production
tags:
- name: OAuth
paths:
  /v1/oauth/authorizations/{authorization_id}:
    get:
      tags:
      - OAuth
      summary: 'The pending consent behind a consent URL: the app, the scopes and your…'
      operationId: get_oauth_authorization
      parameters:
      - name: authorization_id
        in: path
        required: true
        schema:
          type: string
          title: Authorization Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthConsent'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/oauth/authorizations/{authorization_id}/approve:
    post:
      tags:
      - OAuth
      summary: 'Allow: mint the authorization code and return where the browser goes next'
      operationId: approve_oauth_authorization
      parameters:
      - name: authorization_id
        in: path
        required: true
        schema:
          type: string
          title: Authorization Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OAuthConsentDecision'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthRedirect'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/oauth/authorizations/{authorization_id}/deny:
    post:
      tags:
      - OAuth
      summary: 'Deny: send the app an access_denied answer'
      operationId: deny_oauth_authorization
      parameters:
      - name: authorization_id
        in: path
        required: true
        schema:
          type: string
          title: Authorization Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthRedirect'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    OAuthConsent:
      properties:
        id:
          type: string
          title: Id
        client:
          $ref: '#/components/schemas/OAuthConsentClient'
        redirect_host:
          type: string
          title: Redirect Host
        scopes_requested:
          items:
            type: string
          type: array
          title: Scopes Requested
        organizations:
          items:
            $ref: '#/components/schemas/OAuthConsentOrganization'
          type: array
          title: Organizations
        default_environment:
          type: string
          enum:
          - live
          - test
          title: Default Environment
        expires_at:
          type: string
          title: Expires At
      additionalProperties: true
      type: object
      required:
      - id
      - client
      - redirect_host
      - scopes_requested
      - organizations
      - default_environment
      - expires_at
      title: OAuthConsent
    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
    OAuthConsentClient:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: The client's own name, shown as text beside the host.
        host:
          type: string
          title: Host
          description: 'The host the person is sending a credential to: the trust anchor.'
        loopback:
          type: boolean
          title: Loopback
          description: The redirect goes to the person's own computer (an app they started).
        first_seen:
          type: boolean
          title: First Seen
          description: This client was registered during this request.
      additionalProperties: true
      type: object
      required:
      - name
      - host
      - loopback
      - first_seen
      title: OAuthConsentClient
    OAuthRedirect:
      properties:
        redirect_to:
          type: string
          title: Redirect To
          description: 'Where the browser goes next: the client''s registered redirect URI.'
      additionalProperties: true
      type: object
      required:
      - redirect_to
      title: OAuthRedirect
    OAuthConsentDecision:
      properties:
        org_id:
          type: string
          maxLength: 64
          minLength: 1
          title: Org Id
        environment:
          type: string
          enum:
          - live
          - test
          title: Environment
          default: test
      additionalProperties: false
      type: object
      required:
      - org_id
      title: OAuthConsentDecision
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OAuthConsentOrganization:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        role:
          type: string
          title: Role
        scopes:
          items:
            type: string
          type: array
          title: Scopes
          description: What the grant would carry for this organization and role.
      additionalProperties: true
      type: object
      required:
      - id
      - name
      - role
      - scopes
      title: OAuthConsentOrganization
x-refined-from:
- faxforagents-api-openapi.json
- faxforagents-site-openapi.json