Package com.stytch.sdk.b2b.magicLinks

Class B2BMagicLinks.EmailMagicLinks.InviteParameters

    • Constructor Detail

      • B2BMagicLinks.EmailMagicLinks.InviteParameters

        B2BMagicLinks.EmailMagicLinks.InviteParameters(String emailAddress, String inviteRedirectUrl, String inviteTemplateId, String name, Map<String, Object> untrustedMetadata, Locale locale, List<String> roles)

      • B2BMagicLinks.EmailMagicLinks.InviteParameters

        B2BMagicLinks.EmailMagicLinks.InviteParameters(String emailAddress, String inviteRedirectUrl, String inviteTemplateId, String name, Map<String, Object> untrustedMetadata, Locale locale)

      • B2BMagicLinks.EmailMagicLinks.InviteParameters

        B2BMagicLinks.EmailMagicLinks.InviteParameters(String emailAddress, String inviteRedirectUrl, String inviteTemplateId, String name, Map<String, Object> untrustedMetadata)

      • B2BMagicLinks.EmailMagicLinks.InviteParameters

        B2BMagicLinks.EmailMagicLinks.InviteParameters(String emailAddress, String inviteRedirectUrl, String inviteTemplateId, String name)

      • B2BMagicLinks.EmailMagicLinks.InviteParameters

        B2BMagicLinks.EmailMagicLinks.InviteParameters(String emailAddress, String inviteRedirectUrl, String inviteTemplateId)

      • B2BMagicLinks.EmailMagicLinks.InviteParameters

        B2BMagicLinks.EmailMagicLinks.InviteParameters(String emailAddress, String inviteRedirectUrl)

      • B2BMagicLinks.EmailMagicLinks.InviteParameters

        B2BMagicLinks.EmailMagicLinks.InviteParameters(String emailAddress)

    • Method Detail

      • getEmailAddress

         final String getEmailAddress()

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

      • getInviteRedirectUrl

         final String getInviteRedirectUrl()

        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.

      • getInviteTemplateId

         final String getInviteTemplateId()

        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.

      • getUntrustedMetadata

         final Map<String, Object> getUntrustedMetadata()

        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.

      • getLocale

         final Locale getLocale()

        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.

      • getRoles

         final List<String> getRoles()

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