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

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 for further details on how to identify users and their contact information such as email addresses and phone number.

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<Project ID\>

Try it

/v1/auth/oauth/authorize/signin

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

stepupboolean

Default: false

customClaimsobject

mfaboolean

Default: false

ssoAppIdstring

templateOptionsobject

localestring

pkceChallengestring

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

Format: "bytes"

Query Parameters

providerstring

redirectUrlstring

promptarray<string>

testboolean

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/auth/oauth/authorize/signin?provider=string&redirectUrl=string&prompt=%5B%0A++%22string%22%0A%5D&test=true" \
  -d '{
  "stepup": false,
  "customClaims": {},
  "mfa": false,
  "ssoAppId": "string",
  "templateOptions": {
    "property1": "string",
    "property2": "string"
  },
  "locale": "string",
  "pkceChallenge": "string"
}'

{
  "url": "string"
}

Was this helpful?

Previous

Sign-Up / Sign-In

Next

Create Redirect URI for Sign-Up Request