Sign in
Identities

Start linking an external identity

Begins the OpenID Connect authorization-code flow for provider and returns the URL to send the browser to. The flow is completed by POST /v1/identities/{provider}/link/complete with the code and state the provider redirects back with. Requires a signed-in session (not an API key).

post/v1/identities/{provider}/link

Path parameters

providerstring required

Identity provider key, e.g. world-sandbox.

Example:world-sandbox

Identity provider key, e.g. world-sandbox.

Request body

returnTostring

Dashboard path to return to after the link completes (same-origin path only, e.g. /wallet?promoResume=1).

Example request

{
  "returnTo": "/wallet"
}

Response

Pending link created; redirect the browser

authorizationUrlstring uri required

Send the browser here to authenticate at the provider.

expiresAtstring date-time required

The pending link must be completed before this instant.

Changes