OAuth Protocol

OAuth token endpoint

Exchange authorization code, client credentials, or refresh token for access token

post/oauth/token

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/oauth/token
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://api.telnyx.com/v2/oauth/authorize, token URL https://api.telnyx.com/v2/oauth/token; client credentials, token URL https://api.telnyx.com/v2/oauth/token)
    • none

Request body

grant_type'client_credentials' | 'authorization_code' | 'refresh_token' required

OAuth 2.0 grant type

scopestring

Space-separated list of requested scopes (for client_credentials)

codestring

Authorization code (for authorization_code flow)

redirect_uristring uri

Redirect URI (for authorization_code flow)

code_verifierstring

PKCE code verifier (for authorization_code flow)

refresh_tokenstring

Refresh token (for refresh_token flow)

client_idstring

OAuth client ID (if not using HTTP Basic auth)

client_secretstring

OAuth client secret (if not using HTTP Basic auth)

Example request

{
  "scope": "admin"
}

Response

Token response

access_tokenstring required

The access token

token_type'Bearer' required

Token type

expires_ininteger required

Token lifetime in seconds

scopestring

Space-separated list of granted scopes

refresh_tokenstring

Refresh token (if applicable)

Changes

No operation changes recorded.