api_password_v1_passwords_email_ResetStartRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_password_v1_passwords_email_ResetStartRequest",
  "title": "api_password_v1_passwords_email_ResetStartRequest",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The email of the User that requested the password reset."
    },
    "reset_password_redirect_url": {
      "type": "string",
      "description": "The URL that the User is redirected to from the reset password magic link. This URL should display your application's reset password page.\n  Before rendering the reset page, extract the `token` from the query parameters. On the reset page, collect the new password and complete the flow by calling the corresponding Password Reset by Email endpoint.\n  If this parameter is not specified, the default Reset Password redirect URL configured in the Dashboard will be used. If you have not set a default Reset Password redirect URL, an error is returned."
    },
    "reset_password_expiration_minutes": {
      "type": "integer",
      "format": "int32",
      "description": "Set the expiration for the password reset, in minutes. By default, it expires in 30 minutes.\n  The minimum expiration is 5 minutes and the maximum is 7 days (10080 mins)."
    },
    "code_challenge": {
      "type": "string",
      "description": "A base64url encoded SHA256 hash of a one time secret used to validate that the request starts and ends on the same device."
    },
    "attributes": {
      "$ref": "#/components/schemas/api_attribute_v1_Attributes",
      "description": "Provided attributes to help with fraud detection. These values are pulled and passed into Stytch endpoints by your application."
    },
    "login_redirect_url": {
      "type": "string",
      "description": "The URL that Users are redirected to upon clicking the \"Log in without password\" button in password reset emails.\n\n      After Users are redirected to the login redirect URL, your application should retrieve the `token` value from the URL parameters and call the [Magic Link Authenticate endpoint](https://stytch.com/docs/api/authenticate-magic-link) to log the User in without requiring a password reset. If this value is not provided, your project's default login redirect URL will be used. If you have not set a default login redirect URL, an error will be returned."
    },
    "locale": {
      "$ref": "#/components/schemas/api_password_v1_ResetStartRequestLocale",
      "description": "Used to determine which language to use when sending the user this delivery method. Parameter is an [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `\"en\"`.\n\nCurrently supported languages are English (`\"en\"`), Spanish (`\"es\"`), French (`\"fr\"`) and Brazilian Portuguese (`\"pt-br\"`); if no value is provided, the copy defaults to English.\n\nRequest support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link\")!\n"
    },
    "reset_password_template_id": {
      "type": "string",
      "description": "Use a custom template for password reset emails. By default, it will use your default email template.\n  Templates can be added in the [Stytch dashboard](https://stytch.com/dashboard/templates) using our built-in customization options or custom HTML templates with type \u201cPasswords - Password reset\u201d."
    }
  },
  "description": "Request type",
  "required": [
    "email"
  ]
}