Send an email code for a directory password migration fallback or recovery transaction.

POST

/api/auth/directory-password/migration/email-code/send

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/auth/directory-password/migration/email-code/send \
  --header 'Content-Type: application/json' \
  --data '{ "transaction_id": "damt_email_123", "transaction_token": "migration-email-token" }'

Works only where the tenant allows email code for login (authentication-methods.email_otp.login_enabled, off unless turned on). This is decided first, before the transaction is looked up or anything is counted, sent or stored: 403 access_denied (error_code AR050006) when it is off, 503 temporarily_unavailable when the tenant settings cannot be read.

Request Body ^required

Media type application/json

object

transaction_id

required

string

>= 1 characters

transaction_token

required

string

>= 1 characters

key

additional properties

Example

{
  "transaction_id": "damt_email_123",
  "transaction_token": "migration-email-token"
}

Responses

200

Successful response. The representation can be JSON, HTML, or a redirect.

400

Successful response. The representation can be JSON, HTML, or a redirect.

401

Successful response. The representation can be JSON, HTML, or a redirect.

403

Successful response. The representation can be JSON, HTML, or a redirect.

429

Successful response. The representation can be JSON, HTML, or a redirect.

503

Successful response. The representation can be JSON, HTML, or a redirect.