Skip to content

Start reset by email link

Request

Starts a password reset flow by sending an email magic link. Once clicked, the User Agent will be redirected to the URI specified in this request. This URI will include a code required to reset the password.

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

emailstring

The user's primary email address. Pass either username or email, but not both.

usernamestring

The username to send the magic link to. Pass either username or email, but not both.

redirect_uristringrequired

URI where the email link will redirect to. This is the server GET endpoint used to call the password reset endpoint, and should accept "code" as a query parameter. This URI must also be configured as an allowed redirect URI in the Transmit Admin Portal.

Example:"https://www.example.com/reset-password"
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/link \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "prev_reset_token": "string",
    "ignore_mfa": true,
    "email": "string",
    "username": "string",
    "redirect_uri": "https://www.example.com/reset-password",
    "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:"Reset password email sent"
Response
{
  "message": "Reset password email sent"
}