Skip to main content
POST
/
api
/
v1
/
auth
/
oauth
/
{provider_name}
/
authorize
Authorize
curl --request POST \
  --url https://api.example.com/api/v1/auth/oauth/{provider_name}/authorize \
  --header 'Content-Type: application/json' \
  --data '
{
  "redirect_uri": "<string>",
  "account": "<string>",
  "account_name": "<string>",
  "state": "<string>"
}
'
{
  "authorization_url": "<string>",
  "state": "<string>",
  "provider": "<string>"
}

Path Parameters

​
provider_name
string
required

Body

application/json

Request body for starting an OAuth flow.

​
redirect_uri
string
required

URI to redirect to after OAuth completion

​
account
string | null

Account identifier (slug or ID)

​
account_name
string | null

Display name for the new account (used when creating a new account)

Required string length: 1 - 255
​
state
string | null

Optional state for CSRF (auto-generated if missing)

Response

Successful Response

Response for OAuth authorization initiation.

​
authorization_url
string
required

URL to redirect the user to

​
state
string
required

The state token used for this flow

​
provider
string
required

The provider name