Clerk docs

OAuth2 Identify Provider

Requests for the OAuth2 authorization flow.

Request OAuth2 authorization

Request OAuth2 authorization. If successful, receive authorization grant via redirect.

Responses
200

Success for 'form_post' response mode

302

Redirect, no body.

303

Redirect, no body.

400

Bad request error, for example a request parameter is invalid.

401

Unauthorized error, for example the provided client is invalid.

403

Forbidden error, for example you are trying to use a satellite domain

get/oauth/authorize

Request OAuth2 authorization

Request OAuth2 authorization. If successful, receive authorization grant via redirect.

Responses
200

Success for 'form_post' response mode

302

Redirect, no body.

303

Redirect, no body.

400

Bad request error, for example a request parameter is invalid.

401

Unauthorized error, for example the provided client is invalid.

403

Forbidden error, for example you are trying to use a satellite domain

post/oauth/authorize

Get OAuth2 token

Get OAuth2 token in exchange for a valid authorization grant.

Responses
200

Fetch token for OAuth2 flow

400

Bad request error, for example a request parameter is invalid.

401

Unauthorized error, for example the provided client is invalid.

403

Forbidden error, for example you are trying to use a satellite domain

post/oauth/token
Response samples
application/json
{
  • "access_token": "string",
  • "expires_in": 0,
  • "refresh_token": "string",
  • "scope": "string",
  • "token_type": "string"
}

Get user info after OAuth2 flow

Get user info in exchange for a valid OAuth2 access token.

Responses
200

Get user info after successful OAuth2 flow

400

Request was not successful

401

Request was not successful

403

Request was not successful

get/oauth/userinfo
Response samples
application/json
{
  • "object": "string",
  • "instance_id": "string",
  • "user_id": "string",
  • "email": "string",
  • "email_verified": true,
  • "family_name": "string",
  • "given_name": "string",
  • "name": "string",
  • "username": "string",
  • "preferred_username": "string",
  • "picture": "string",
  • "public_metadata": { },
  • "private_metadata": { },
  • "unsafe_metadata": { }
}

Get user info after OAuth2 flow

Get user info in exchange for a valid OAuth2 access token.

Responses
200

Get user info after successful OAuth2 flow

400

Request was not successful

401

Request was not successful

403

Request was not successful

post/oauth/userinfo
Response samples
application/json
{
  • "object": "string",
  • "instance_id": "string",
  • "user_id": "string",
  • "email": "string",
  • "email_verified": true,
  • "family_name": "string",
  • "given_name": "string",
  • "name": "string",
  • "username": "string",
  • "preferred_username": "string",
  • "picture": "string",
  • "public_metadata": { },
  • "private_metadata": { },
  • "unsafe_metadata": { }
}
➔ Next to OAuth2 Callbacks