OAuth authorization endpoint

GET

oauth

authorize

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx();

await client.oauth.retrieveAuthorize({
  client_id: 'client_id',
  redirect_uri: 'https://example.com',
  response_type: 'code',
});

"<string>"

Query Parameters

response_type

enum<string>

required

OAuth response type

Available options:

code

client_id

string

required

OAuth client identifier

redirect_uri

string<uri>

required

Redirect URI

scope

string

Space-separated list of requested scopes

state

string

State parameter for CSRF protection

code_challenge

string

PKCE code challenge

code_challenge_method

enum<string>

PKCE code challenge method

Available options:

plain,

S256

Response

Consent page displayed (when consent UI is embedded)

Protected resource metadata

Get OAuth consent token

⌘I

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx();

await client.oauth.retrieveAuthorize({
  client_id: 'client_id',
  redirect_uri: 'https://example.com',
  response_type: 'code',
});

"<string>"