AQX
DocumentationAPI Reference
DocumentationAPI Reference
  1. Authentication
  • AQX API documentation
  • Authentication
    • Authentication
    • Authorization
      GET
    • Token
      POST
    • User Info
      GET
  • Triggers
    • Subscribe
      GET
    • Unsubscribe
      DELETE
    • Campaigns
      GET
    • PerformList operation
      GET
  • Actions
    • Start a Call
      POST
DocumentationAPI Reference
DocumentationAPI Reference
  1. Authentication

Authentication

AQX uses OAuth 2.0 authentication. This document outlines the authentication process, endpoints, and token information required to integrate with our API.

Authentication Method#

Type: OAuth 2.0
Grant Type: Authorization Code
Audience: you must send the audience property to the auth flow with the value/https://aqxglobal.us.auth0.com/api/v2/

Token Information#

Access Tokens#

Lifetime: 36000 seconds (10 hours)
Format: JWT (JSON Web Token)
Usage: Include in API requests as Bearer token in Authorization header

Refresh Tokens#

Enabled: Yes
Lifetime: 2592000 seconds (30 days)
Usage: Used to obtain new access tokens without requiring re-authorization

Scopes#

The following scopes are available:
openid: OpenID Connect protocol
profile: User's profile information
email: User's email address
offline_access: Required for refresh token issuance
Previous
AQX API documentation
Next
Authorization
Built with