API ReferenceMagic LinkEmbedded Link
POST
/v1/mgmt/user/signin/embeddedlink

Initiate a sign-in process by generating an embdedded link for an existing user utilizing a management key.

The endpoint will return a token which can then be verified using the Magic Link Verify Token endpoint.

Next Steps

Verify the embedded link token using the Verify Token endpoint.

See Also

  • See Embedded link Authentication for details about implementing embedded links.
  • 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 \<ProjectId:ManagementKey\>

Try it

/v1/mgmt/user/signin/embeddedlink

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

loginIdstring

customClaimsobject

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/mgmt/user/signin/embeddedlink" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ProjectId:ManagementKey>" \
  -d '{
  "loginId": "string",
  "customClaims": {}
}'

{
  "token": "string",
  "maskedEmail": "string",
  "maskedPhone": "string"
}

Was this helpful?

Previous

Verify Token

Next

Enchanted Link Authentication API Overview