Class Organization.OrganizationMembers.CreateMemberParameters
-
- All Implemented Interfaces:
public final class Organization.OrganizationMembers.CreateMemberParametersData class used for wrapping the parameters necessary for creating a user
-
-
Field Summary
Fields Modifier and Type Field Description private final StringemailAddressprivate final Stringnameprivate final BooleanisBreakGlassprivate final BooleanmfaEnrolledprivate final StringmfaPhoneNumberprivate final Map<String, Object>untrustedMetadataprivate final BooleancreateMemberAsPendingprivate final List<String>roles
-
Constructor Summary
-
Method Summary
Modifier and Type Method Description final StringgetEmailAddress()the Member's email_addressfinal StringgetName()The name of the Member. final BooleanisBreakGlass()Identifies the Member as a break glass user - someone who has permissions to authenticate into an Organization by bypassing the Organization's settings. final BooleangetMfaEnrolled()Sets whether the Member is enrolled in MFA. final StringgetMfaPhoneNumber()The Member's phone number. final Map<String, Object>getUntrustedMetadata()An arbitrary JSON object of application-specific data. final BooleangetCreateMemberAsPending()Flag for whether or not to save a Member as pending or active in Stytch. final List<String>getRoles()Roles to explicitly assign to this Member. -
-
Constructor Detail
-
Organization.OrganizationMembers.CreateMemberParameters
Organization.OrganizationMembers.CreateMemberParameters(String emailAddress, String name, Boolean isBreakGlass, Boolean mfaEnrolled, String mfaPhoneNumber, Map<String, Object> untrustedMetadata, Boolean createMemberAsPending, List<String> roles)
-
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
-
getEmailAddress
final String getEmailAddress()
the Member's
email_address
-
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.
-
-
-
-