API ReferenceSocial Login (OAuth)
POST
/v1/auth/oauth/authorize

Authorization

Descope Project ID
AuthorizationBearer <token>

Project ID as bearer token.

In: header

Query Parameters

provider?string
redirectUrl?string
prompt?array<string>
string
test?boolean
rawResponse?boolean
loginHint?string
initiatedEmail?string

Request Body

application/json

stepup?boolean
Defaultfalse
customClaims?object

Custom claims to include in the JWT as key-value pairs. Keys must be strings; values can be strings, numbers, or booleans.

Example{ "claim-name": "claim-value" }
mfa?boolean
Defaultfalse
ssoAppId?string
templateOptions?object
locale?string
pkceChallenge?string

relevant only for enchanted links in the point in time - other methods will ignore this field

Formatbytes
revokeOtherSessions?boolean
revokeOtherSessionsTypes?array<string>
string

Authorize end user to sign-up or sign-in using social login credentials

Initiate a social login (OAuth) sign-up or sign-in process for an end user. Descope will coordinate the authorization process with the OAUth provider specified in the provider field. Specify the URL you want to redirect the end user to after a successful sign-in in the redirectURL parameter.

When the OAuth authorization completes successfully, the endpoint returns a URL url that has a unique code <unique-code\> appended as a URL parameter to the redirectURL you provided. For example, if redirectURL = https://oauth.mycompany.com/shopping.htm then url = https://oauth.mycompany.com/shopping.htm?code=<unique-code\>. The unique code will be exchanged for a valid user object in the next step.

After the end user successfully authenticates with the OAuth provider the end user session is redirected to url.

Next Steps

Call the Exchange Code endpoint from the flow that responds to the URL specified in the redirectURL field, to exchange the unique code for a user session object.

See Also

  • See The User Object for further details on how to identify users and their contact information such as email addresses and phone number.
  • See User Login Options for further details on the stepup, mfa, and customClaims parameters.
curl -X POST "https://api.descope.com/v1/auth/oauth/authorize" \  -H "Content-Type: application/json" \  -d '{}'
{  "url": "string",  "errorId": "string"}
export interface Response {url?: stringerrorId?: string}
Was this helpful?

OAuth Social Login API Overview

Use the Descope REST API to build OAuth social logins for your application.

Create Redirect URI for Sign-In Request POST

### Create an OAuth Redirect URI for user Sign-In Request This endpoint allows you to create an OAuth Redirect URI for user Sign-Up Request. ### See Also - See [The User Object](/api/overview#the-user-object) for further details on how to identify users and their contact information such as email addresses and phone number.