OAuth2 Callbacks

Used to receive callbacks from successful oauth attempts.

OAuth Callback

The endpoint where the oauth providers redirect to after a successful authentication attempt.

SecurityDevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
query Parameters
scope
string

returned scopes from oauth provider.

code
string

returned exchange code from oauth provider.

state
string

returned state from oauth provider.

Responses
200

[AuthV2] HTML-based redirection in dev instances

299

FAKE SUCCESS

303

Redirect

400

Request was not successful

403

Request was not successful

get/v1/oauth_callback
Response samples
application/json
{
  • "errors": [
    ],
  • "meta": { }
}

OAuth Post Callback

Converts a POST to a GET, because if it's a POST coming from an external account. This is necessary because some providers (e.g. Apple) issue a POST instead of a GET request.

SecurityDevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
Request Body schema: application/x-www-form-urlencoded
code
string

returned exchange code from oauth provider.

state
string

returned state from oauth provider.

property name*
additional property
any
Responses
303

Redirect to GET /v1/oauth_callback with same parameters

post/v1/oauth_callback
Request samples
application/x-www-form-urlencoded
code=string&state=string