Generate Enchanted Link | API Reference

POST

/v1/mgmt/tests/generate/enchantedlink

Generate a Enchanted Link for a test user.

This endpoint is used to generate a Enchanted Link for a test user. You can define whether this is sent via email or sms.

Once you generate the Enchanted Link Token must be verified via verify token

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Authorization

`Authorization`
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

`loginId`string

`redirectUrl`string

`loginOptions`object

Status code	Description
`200`	OK

curl -X POST "https://api.descope.com/v1/mgmt/tests/generate/enchantedlink" \
  -d '{
  "loginId": "string",
  "redirectUrl": "string",
  "loginOptions": {
    "stepup": false,
    "customClaims": {},
    "mfa": false,
    "ssoAppId": "string",
    "templateOptions": {
      "property1": "string",
      "property2": "string"
    },
    "locale": "string",
    "pkceChallenge": "string"
  }
}'

{
  "loginId": "string",
  "link": "string",
  "pendingRef": "string"
}

Was this helpful?

Generate a Enchanted Link for a test user.

See Also

Endpoint Authentication

Try it

Authorization

`Authorization`
Required
Bearer <token>

Request Body

`loginId`string

`redirectUrl`string

`loginOptions`object

Generate a Enchanted Link for a test user.

See Also

Endpoint Authentication

Try it

Authorization

AuthorizationRequiredBearer <token>

Request Body

loginIdstring

redirectUrlstring

loginOptionsobject

loginOptions

Response

Typescript

`Authorization`
Required
Bearer <token>

`loginId`string

`redirectUrl`string

`loginOptions`object