email

Documentation

Index

• type ResetParams
• type ResetResponse
• type ResetStartParams
• type ResetStartResponse

Types

type ResetParams

type ResetParams struct {
	// PasswordResetToken: The password reset token to authenticate.
	PasswordResetToken string `json:"password_reset_token,omitempty"`
	// Password: The password to authenticate, reset, or set for the first time. Any UTF8 character is allowed,
	// e.g. spaces, emojis, non-English characers, etc.
	Password         string `json:"password,omitempty"`
	PkceCodeVerifier string `json:"pkce_code_verifier,omitempty"`
}

ResetParams: Request type for `Email.Reset`.

type ResetResponse

type ResetResponse struct {
	// RequestID: Globally unique UUID that is returned with every API call. This value is important to log for
	// debugging purposes; we may ask for this value to help identify a specific API call when helping you
	// debug an issue.
	RequestID string `json:"request_id,omitempty"`
	// IntermediateSessionToken: The returned Intermediate Session Token contains a password factor associated
	// with the Member. If this value is non-empty, the member must complete an MFA step to finish logging in
	// to the Organization. The token can be used with the
	// [OTP SMS Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-otp-sms),
	// [TOTP Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-totp), or
	// [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an
	// MFA flow and log in to the Organization. Password factors are not transferable between Organizations, so
	// the intermediate session token is not valid for use with discovery endpoints.
	IntermediateSessionToken string                             `json:"intermediate_session_token,omitempty"`
	EmailAddress             string                             `json:"email_address,omitempty"`
	DiscoveredOrganizations  []discovery.DiscoveredOrganization `json:"discovered_organizations,omitempty"`
	// StatusCode: The HTTP status code of the response. Stytch follows standard HTTP response status code
	// patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX
	// are server errors.
	StatusCode int32 `json:"status_code,omitempty"`
}

ResetResponse: Response type for `Email.Reset`.

type ResetStartParams

type ResetStartParams struct {
	// EmailAddress: The email address of the Member to start the email reset process for.
	EmailAddress string `json:"email_address,omitempty"`
	// ResetPasswordRedirectURL: The URL that the Member clicks from the reset password link. This URL should
	// be an endpoint in the backend server that verifies the request by querying
	//   Stytch's authenticate endpoint and finishes the reset password flow. If this value is not passed, the
	// default `reset_password_redirect_url` that you set in your Dashboard is used.
	//   If you have not set a default `reset_password_redirect_url`, an error is returned.
	ResetPasswordRedirectURL string `json:"reset_password_redirect_url,omitempty"`
	// DiscoveryRedirectURL: The URL that the end user clicks from the discovery Magic Link. This URL should be
	// an endpoint in the backend server that
	//   verifies the request by querying Stytch's discovery authenticate endpoint and continues the flow. If
	// this value is not passed, the default
	//   discovery redirect URL that you set in your Dashboard is used. If you have not set a default discovery
	// redirect URL, an error is returned.
	DiscoveryRedirectURL string `json:"discovery_redirect_url,omitempty"`
	// ResetPasswordTemplateID: Use a custom template for reset password emails. By default, it will use your
	// default email template. The template must be a template using our built-in customizations or a custom
	// HTML email for Magic Links - Reset Password.
	ResetPasswordTemplateID string `json:"reset_password_template_id,omitempty"`
	// ResetPasswordExpirationMinutes: Sets a time limit after which the email link to reset the member's
	// password will no longer be valid.
	ResetPasswordExpirationMinutes int32  `json:"reset_password_expiration_minutes,omitempty"`
	PkceCodeChallenge              string `json:"pkce_code_challenge,omitempty"`
	// Locale: Used to determine which language to use when sending the user this delivery method. Parameter is
	// a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
	//
	// Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese
	// (`"pt-br"`); if no value is provided, the copy defaults to English.
	//
	// Request support for additional languages
	// [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
	//
	Locale string `json:"locale,omitempty"`
}

ResetStartParams: Request type for `Email.ResetStart`.

type ResetStartResponse

type ResetStartResponse struct {
	// RequestID: Globally unique UUID that is returned with every API call. This value is important to log for
	// debugging purposes; we may ask for this value to help identify a specific API call when helping you
	// debug an issue.
	RequestID string `json:"request_id,omitempty"`
	// StatusCode: The HTTP status code of the response. Stytch follows standard HTTP response status code
	// patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX
	// are server errors.
	StatusCode int32 `json:"status_code,omitempty"`
}

ResetStartResponse: Response type for `Email.ResetStart`.