Start reset by Email OTP

Request

Starts a password reset flow by sending an Email OTP.

Required permissions: apps:execute, [appId]:execute, auth:execute.

Security

ClientAccessToken

Bodyapplication/jsonrequired

prev_reset_tokenstring

Reset token that contains mfa_required as true. Should be passed when initiating a second factor authentication, in case MFA is required for password reset flows.

ignore_mfaboolean

Allows resetting the password without MFA in case MFA is required for password reset flows

emailstringrequired

The user's primary email address

email_contentobject

Texts, logo and color to render email template with

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/cis/v1/auth/password/reset/email/otp \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "prev_reset_token": "string",
    "ignore_mfa": true,
    "email": "string",
    "email_content": {
      "subject": "string",
      "primaryColor": "#6981FF",
      "base64logo": "string",
      "headerText": "string",
      "bodyText": "string",
      "linkText": "string",
      "infoText": "string",
      "footerText": "If you didn'\''t request this email, you can safely ignore it.",
      "senderName": "string"
    }
  }'

Responses

Bodyapplication/json

messagestringread-onlyrequired

Example:"Email Sent"

Response

{
  "message": "Email Sent"
}