Class Organization.OrganizationMembers.UpdateMemberParameters
-
- All Implemented Interfaces:
public final class Organization.OrganizationMembers.UpdateMemberParametersData class used for wrapping the parameters necessary for creating a user
-
-
Field Summary
Fields Modifier and Type Field Description private final StringmemberIdprivate final StringemailAddressprivate final Stringnameprivate final BooleanisBreakGlassprivate final BooleanmfaEnrolledprivate final StringmfaPhoneNumberprivate final Map<String, Object>untrustedMetadataprivate final List<String>rolesprivate final BooleanpreserveExistingSessionsprivate final MfaMethoddefaultMfaMethod
-
Constructor Summary
-
Method Summary
Modifier and Type Method Description final StringgetMemberId()Globally unique UUID that identifies a specific Member. 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 List<String>getRoles()Roles to explicitly assign to this Member. final BooleangetPreserveExistingSessions()Whether to preserve existing sessions when explicit Roles that are revoked are also implicitly assigned by SSO connection or SSO group. final MfaMethodgetDefaultMfaMethod()Sets the Member's default MFA method. -
-
Constructor Detail
-
Organization.OrganizationMembers.UpdateMemberParameters
Organization.OrganizationMembers.UpdateMemberParameters(String memberId, String emailAddress, String name, Boolean isBreakGlass, Boolean mfaEnrolled, String mfaPhoneNumber, Map<String, Object> untrustedMetadata, List<String> roles, Boolean preserveExistingSessions, MfaMethod defaultMfaMethod)
-
Organization.OrganizationMembers.UpdateMemberParameters
Organization.OrganizationMembers.UpdateMemberParameters(String memberId, String emailAddress, String name, Boolean isBreakGlass, Boolean mfaEnrolled, String mfaPhoneNumber, Map<String, Object> untrustedMetadata, List<String> roles, Boolean preserveExistingSessions)
-
Organization.OrganizationMembers.UpdateMemberParameters
Organization.OrganizationMembers.UpdateMemberParameters(String memberId, String emailAddress, String name, Boolean isBreakGlass, Boolean mfaEnrolled, String mfaPhoneNumber, Map<String, Object> untrustedMetadata, List<String> roles)
-
Organization.OrganizationMembers.UpdateMemberParameters
Organization.OrganizationMembers.UpdateMemberParameters(String memberId, String emailAddress, String name, Boolean isBreakGlass, Boolean mfaEnrolled, String mfaPhoneNumber, Map<String, Object> untrustedMetadata)
-
Organization.OrganizationMembers.UpdateMemberParameters
Organization.OrganizationMembers.UpdateMemberParameters(String memberId, String emailAddress, String name, Boolean isBreakGlass, Boolean mfaEnrolled, String mfaPhoneNumber)
-
Organization.OrganizationMembers.UpdateMemberParameters
Organization.OrganizationMembers.UpdateMemberParameters(String memberId, String emailAddress, String name, Boolean isBreakGlass, Boolean mfaEnrolled)
-
Organization.OrganizationMembers.UpdateMemberParameters
Organization.OrganizationMembers.UpdateMemberParameters(String memberId, String emailAddress, String name, Boolean isBreakGlass)
-
Organization.OrganizationMembers.UpdateMemberParameters
Organization.OrganizationMembers.UpdateMemberParameters(String memberId, String emailAddress, String name)
-
Organization.OrganizationMembers.UpdateMemberParameters
Organization.OrganizationMembers.UpdateMemberParameters(String memberId, String emailAddress)
-
Organization.OrganizationMembers.UpdateMemberParameters
Organization.OrganizationMembers.UpdateMemberParameters(String memberId)
-
-
Method Detail
-
getMemberId
final String getMemberId()
Globally unique UUID that identifies a specific Member.
-
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.
-
getPreserveExistingSessions
final Boolean getPreserveExistingSessions()
Whether to preserve existing sessions when explicit Roles that are revoked are also implicitly assigned by SSO connection or SSO group. Defaults to false - that is, existing Member Sessions that contain SSO authentication factors with the affected SSO connection IDs will be revoked.
-
getDefaultMfaMethod
final MfaMethod getDefaultMfaMethod()
Sets the Member's default MFA method. Valid values are 'sms_otp' and 'totp'. This value will determine
Which MFA method the Member is prompted to use when logging in
Whether An SMS will be sent automatically after completing the first leg of authentication
-
-
-
-