API ReferenceManagementUsersTest Users
POST
/v1/mgmt/tests/generate/enchantedlink

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

See Also

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Try it

/v1/mgmt/tests/generate/enchantedlink

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

loginIdstring

redirectUrlstring

loginOptionsobject

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/mgmt/tests/generate/enchantedlink" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ProjectId:ManagementKey>" \
  -d '{
  "loginId": "string",
  "redirectUrl": "string",
  "loginOptions": {
    "stepup": false,
    "customClaims": {},
    "mfa": false,
    "ssoAppId": "string",
    "templateOptions": {
      "property1": "string",
      "property2": "string"
    },
    "locale": "string",
    "pkceChallenge": "string",
    "revokeOtherSessions": true
  }
}'

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

Was this helpful?

Previous

Generate Magic Link

Next

Delete All Test Users