Class Organization.OrganizationMembers.CreateMemberParameters

    • Constructor Detail

      • Organization.OrganizationMembers.CreateMemberParameters

        Organization.OrganizationMembers.CreateMemberParameters(String emailAddress, String name, Boolean isBreakGlass, Boolean mfaEnrolled, String mfaPhoneNumber, Map<String, Object> untrustedMetadata, Boolean createMemberAsPending)
      • Organization.OrganizationMembers.CreateMemberParameters

        Organization.OrganizationMembers.CreateMemberParameters(String emailAddress, String name, Boolean isBreakGlass, Boolean mfaEnrolled, String mfaPhoneNumber, Map<String, Object> untrustedMetadata)
      • Organization.OrganizationMembers.CreateMemberParameters

        Organization.OrganizationMembers.CreateMemberParameters(String emailAddress, String name, Boolean isBreakGlass, Boolean mfaEnrolled, String mfaPhoneNumber)
      • Organization.OrganizationMembers.CreateMemberParameters

        Organization.OrganizationMembers.CreateMemberParameters(String emailAddress, String name, Boolean isBreakGlass, Boolean mfaEnrolled)
      • Organization.OrganizationMembers.CreateMemberParameters

        Organization.OrganizationMembers.CreateMemberParameters(String emailAddress, String name, Boolean isBreakGlass)
      • Organization.OrganizationMembers.CreateMemberParameters

        Organization.OrganizationMembers.CreateMemberParameters(String emailAddress, String name)
      • Organization.OrganizationMembers.CreateMemberParameters

        Organization.OrganizationMembers.CreateMemberParameters(String emailAddress)
    • Method Detail

      • isBreakGlass

         final Boolean isBreakGlass()

        Identifies the Member as a break glass user - someone who has permissions to authenticate into an Organization by bypassing the Organization's settings. A break glass account is typically used for emergency purposes to gain access outside of normal authentication procedures.

      • getMfaEnrolled

         final Boolean getMfaEnrolled()

        Sets whether the Member is enrolled in MFA. If true, the Member must complete an MFA step whenever they wish to log in to their Organization. If false, the Member only needs to complete an MFA step if the Organization's MFA policy is set to REQUIRED_FOR_ALL.

      • getMfaPhoneNumber

         final String getMfaPhoneNumber()

        The Member's phone number. A Member may only have one phone number.

      • getUntrustedMetadata

         final Map<String, Object> getUntrustedMetadata()

        An arbitrary JSON object of application-specific data. These fields can be edited directly by the frontend SDK, and should not be used to store critical information.

      • getCreateMemberAsPending

         final Boolean getCreateMemberAsPending()

        Flag for whether or not to save a Member as pending or active in Stytch. It defaults to false. If true, new Members will be created with status pending in Stytch's backend. Their status will remain pending and they will continue to receive signup email templates for every Email Magic Link until that Member authenticates and becomes active. If false, new Members will be created with status active.