API Reference

Build an OAuth/OIDC authorization URL for a provider.

post
https://platform.routy.app/api/v1/traffic-source-providers//auth/authorize

Requires the TrafficSourceUpdate policy. The request body's RedirectUri is mandatory;
an empty value yields 400. The route provider overrides any provider set in the body.

🔐 Required permissions: traffic-source.read, traffic-source.update

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Provider type (TrafficSourceProvider enum).

Body Params

Authorization request including the OAuth redirect URI and OIDC parameters.

Enhanced authorization request supporting OIDC with PKCE and state parameters

string
enum

Represents third-party providers that can be integrated with traffic sources

int32

Integration ID for tracking purposes

string | null

Redirect URI where the authorization server will redirect after user consent

string | null

State parameter for CSRF protection (auto-generated if not provided)

string | null

PKCE code verifier (auto-generated if not provided)

string | null

PKCE code challenge method (S256 recommended)

additionalScopes
array of strings | null

Additional scopes to request beyond the default provider scopes

additionalScopes
customParameters
object | null

Provider-specific parameters (e.g., prompt=consent for Google)

string | null

Login hint to pre-populate the user's email address on the consent screen

string | null

Domain hint for Google Workspace accounts (e.g., "example.com")

boolean

Whether this is a popup-based OAuth flow

consentOptions
object | null

Additional options for customizing the OAuth consent screen experience

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 2 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 days ago