discovery

Documentation

Index

• type SendParams
• type SendRequestLocale
• type SendResponse

Types

type SendParams

type SendParams struct {
	// EmailAddress: The email address of the Member.
	EmailAddress string `json:"email_address,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"`
	// PkceCodeChallenge: A base64url encoded SHA256 hash of a one time secret used to validate that the
	// request starts and ends on the same device.
	PkceCodeChallenge string `json:"pkce_code_challenge,omitempty"`
	// LoginTemplateID: Use a custom template for discovery emails. By default, it will use your default email
	// template. The template must be from Stytch's
	// built-in customizations or a custom HTML email for Magic Links - Login.
	LoginTemplateID string `json:"login_template_id,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 SendRequestLocale `json:"locale,omitempty"`
}

SendParams: Request type for `Discovery.Send`.

type SendRequestLocale

type SendRequestLocale string

const (
	SendRequestLocaleEn   SendRequestLocale = "en"
	SendRequestLocaleEs   SendRequestLocale = "es"
	SendRequestLocalePtbr SendRequestLocale = "pt-br"
)

type SendResponse

type SendResponse 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"`
}

SendResponse: Response type for `Discovery.Send`.