Clerk docs

External Accounts

Used to interact with the external accounts of the current user.

Connect OAuth Accounts

Connect a new External Account from the OAuth providers enabled.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
Request Body schema: application/x-www-form-urlencoded
strategy
string^oauth_(?:(?:token_)|(?:custom_))?[a-z]+$

The OAuth strategy that the external account provider supports. Can be one of oauth_[provider] or oauth_token_[provider]. The oauth_[provider] strategy can be used for regular OAuth flows with redirects and a redirect_url parameter is also required. The oauth_token_[provider] strategy can be used for native flows, along with a token or code parameter.

redirect_url
string or null
action_complete_redirect_url
string or null
code
string or null

The authorization or grant code that an OAuth provider returns during authentication. Can be used with oauth_token_[provider] strategies.

token
string or null

The ID token that an OpenID Connect provider returns during authentication. Can be used with oauth_token_[provider] strategies.

oidc_login_hint
string or null

Used with oauth_[provider]. The given value will be forwarded to the OIDC login_hint parameter of the generated redirect url.

oidc_prompt
string or null

Used with oauth_[provider]. The given value will be forwarded to the OIDC prompt parameter of the generated redirect url. When using shared credentials this value might be adjusted for security reasons.

Responses
200

Returns the response for Session wrapped Verification object.

400

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

500

Request was not successful

post/v1/me/external_accounts
Request samples
application/x-www-form-urlencoded
strategy=string&redirect_url=string&action_complete_redirect_url=string&code=string&token=string&oidc_login_hint=string&oidc_prompt=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Reauthorize External Account

Reauthorize an external account by ID.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
external_account_id
required
string

External account ID

Request Body schema: application/x-www-form-urlencoded
additional_scope
Array of strings
redirect_url
string
action_complete_redirect_url
string or null
oidc_login_hint
string or null

Used with oauth_[provider]. The given value will be forwarded to the OIDC login_hint parameter of the generated redirect url.

oidc_prompt
string or null

Used with oauth_[provider]. The given value will be forwarded to the OIDC prompt parameter of the generated redirect url. When using shared credentials this value might be adjusted for security reasons.

Responses
200

Returns the response for Session wrapped Verification object.

400

Request was not successful

404

Request was not successful

patch/v1/me/external_accounts/{external_account_id}/reauthorize
Request samples
application/x-www-form-urlencoded
additional_scope=string&redirect_url=string&action_complete_redirect_url=string&oidc_login_hint=string&oidc_prompt=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Delete External Account

Delete an external account by ID.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
external_account_id
required
string

External account ID

Responses
200

Returns a deleted external account.

400

Request was not successful

403

Request was not successful

404

Request was not successful

delete/v1/me/external_accounts/{external_account_id}
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Revoke OAuth tokens

Revoke the OAuth access and refresh token of an external account by ID, if supported by the provider.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
external_account_id
required
string

External account ID

Responses
200

Returns the response for Session wrapped User object.

400

Request was not successful

404

Request was not successful

delete/v1/me/external_accounts/{external_account_id}/tokens
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}
➔ Next to TOTP