Stytch Android/com.stytch.sdk.b2b.magicLinks/B2BMagicLinks/EmailMagicLinks/InviteParameters

InviteParameters

data class InviteParameters @JvmOverloads constructor(val emailAddress: String, val inviteRedirectUrl: String? = null, val inviteTemplateId: String? = null, val name: String? = null, val untrustedMetadata: Map<String, Any?>? = null, val locale: Locale? = null, val roles: List<String>? = null)

A data class used for wrapping paramaters used for sending an invite magic link

Constructors

InviteParameters

@JvmOverloads

constructor(emailAddress: String, inviteRedirectUrl: String? = null, inviteTemplateId: String? = null, name: String? = null, untrustedMetadata: Map<String, Any?>? = null, locale: Locale? = null, roles: List<String>? = null)

Properties

emailAddress

val emailAddress: String

is the account identifier for the account in the form of an Email address where you wish to receive a magic link to authenticate

inviteRedirectUrl

val inviteRedirectUrl: String? = null

The URL that the Member clicks from the invite Email Magic Link. This URL should be an endpoint in the backend server that verifies the request by querying Stytch's authenticate endpoint and finishes the invite flow. If this value is not passed, the default invite_redirect_url that you set in your Dashboard is used. If you have not set a default invite_redirect_url, an error is returned.

inviteTemplateId

val inviteTemplateId: String? = null

Use a custom template for invite 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 - Invite.

locale

val locale: Locale? = null

The locale is used to determine which language to use in the email. Parameter is a IETF BCP 47 language tag, 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.

name

val name: String? = null

The name of the Member.

roles

val roles: List<String>? = null

Roles to explicitly assign to this Member. See our RBAC guide for more information about role assignment.

untrustedMetadata

val untrustedMetadata: Map<String, Any?>? = null

A map containing application-specific metadata. Use it to store fields that a member can be allowed to edit directly without backend validation - such as display_theme or preferred_locale. See our metadata reference for complete details.