Send Recovery Code Email

Send the user a recovery verification code. This code is used as a second factor to verify the user initiated the recovery request.

POST /auth/recover/user/code

Send Recovery Code Email

cURL

curl --request POST \
  --url https://api.dfns.io/auth/recover/user/code \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>",
  "orgId": "or-30tnh-itmjs-s235s5ontr3r23h2",
  "tenantId": "acct-24hka-dhili-9hgvdlvr1ohpibp4"
}
'

200

{
  "message": "<string>"
}

Authentication

No authentication required.

Required Permissions

No authentication required.

Body

application/json

username · string · required

Username/identifier of the user to send the recovery code to.

Minimum string length: 1

orgId · string

Organization id.

Required string length: 1 - 64

Pattern: ^or-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

Example:

"or-30tnh-itmjs-s235s5ontr3r23h2"

tenantId · string

Tenant id.

Required string length: 1 - 64

Pattern: ^acct-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

Example:

"acct-24hka-dhili-9hgvdlvr1ohpibp4"

Response

200 - application/json

Success

message · string · required

Human-readable success message.