Send User Recovery Verification Email

PUT /auth/recover/user/code

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

• Request headers required. See Request Headers for more information.

Required Permissions

Since this endpoint is not authentication, the permissions apply to the application only.

Name	Conditions
Auth:Users:Create	Always Required
Auth:Types:Employee	When kind is CustomerEmployee
Auth:Types:EndUser	When kind is EndUser

Request body

username *	String	email of the user
orgId *	String	globally unique ID of the organization of the user

Example

{
  "username": "[e-mail]",
  "orgId": "or-34513-nip9c-8bppvgqgj28dbodrc"
}

Responses

• See Common Errors for common errors.

• See User Recovery Errors for user recovery specific errors.

200

Success - generic success message

{
    "message": "success"
}