Verify an email code for a directory password migration fallback or recovery transaction and create a session.

POST

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

Code sample: Shell / cURL

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

Request Body ^required

Media type application/json

object

transaction_id

required

string

>= 1 characters

transaction_token

required

string

>= 1 characters

challenge_id

required

string

>= 1 characters

code

required

string

/^\d{6}$/

key

additional properties

Example

{
  "transaction_id": "damt_email_123",
  "transaction_token": "migration-email-token",
  "challenge_id": "challenge_123",
  "code": "123456"
}

Responses

200

Successful JSON response.

Media type application/json

One of:

object

object

ok

required

boolean

expires_in

required

integer

session

required

object

userId

string

createdAt

integer

expiresAt

integer

authTime

integer

acr

string

amr

Array<string>

key

additional properties

user

required

object

id

string

email

string format: email

name

Any of:

string

string

null

null

authorization

object

key

additional properties

redirect_url

string format: uri

object

object

ok

required

boolean

migration

required

object

required

required

boolean

action

required

string

Allowed values: require_passkey

transaction_id

required

string

transaction_token

required

string

expires_at

required

integer

campaign_id

required

string

state

required

string

reason

Any of:

string

string

null

null

passkey_required_at

Any of:

integer

integer

null

null

email_code_fallback_mode

required

string

Allowed values: migration_recovery directory_unavailable_recovery admin_invitation_only login_method disabled

email_code_fallback_available

required

boolean

email_code_fallback

Any of:

object

object

transaction_id

required

string

transaction_token

required

string

expires_at

required

integer

masked_email

required

string

key

additional properties

null

null

key

additional properties

user

required

object

id

string

email

Any of:

string

string format: email

null

null

name

Any of:

string

string

null

null

email_verified

One of:

boolean

boolean

integer

integer

created_at

string

updated_at

string

last_login_at

Any of:

string

string

null

null

user_type

string

key

additional properties

object

object

ok

required

boolean

recovery

required

object

required

required

boolean

reason

required

string

Allowed values: directory_unavailable

transaction_id

required

string

transaction_token

required

string

expires_at

required

integer

masked_email

required

string

key

additional properties

user

required

object

id

string

email

Any of:

string

string format: email

null

null

name

Any of:

string

string

null

null

email_verified

One of:

boolean

boolean

integer

integer

created_at

string

updated_at

string

last_login_at

Any of:

string

string

null

null

user_type

string

key

additional properties

Example

{
  "ok": true,
  "expires_in": 86400,
  "session": {
    "userId": "user_123",
    "createdAt": 1770000000000,
    "expiresAt": 1770086400000,
    "authTime": 1770000000,
    "acr": "urn:mace:incommon:iap:bronze",
    "amr": [
      "pwd",
      "directory"
    ]
  },
  "user": {
    "id": "user_123",
    "email": "[email protected]",
    "name": "Example User"
  }
}

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.