Package com.stytch.sdk.b2b.otp
Class OTP.SMS.AuthenticateParameters
-
- All Implemented Interfaces:
public final class OTP.SMS.AuthenticateParametersA data class wrapping the parameters needed to authenticate an SMS OTP
-
-
Field Summary
Fields Modifier and Type Field Description private final StringorganizationIdprivate final StringmemberIdprivate final Stringcodeprivate final SetMFAEnrollmentsetMFAEnrollmentprivate final IntegersessionDurationMinutes
-
Constructor Summary
Constructors Constructor Description OTP.SMS.AuthenticateParameters(String organizationId, String memberId, String code, SetMFAEnrollment setMFAEnrollment, Integer sessionDurationMinutes)OTP.SMS.AuthenticateParameters(String organizationId, String memberId, String code, SetMFAEnrollment setMFAEnrollment)OTP.SMS.AuthenticateParameters(String organizationId, String memberId, String code)
-
Method Summary
Modifier and Type Method Description final StringgetOrganizationId()The ID of the organization the member belongs to final StringgetMemberId()The ID of the member to send the OTP to final StringgetCode()The OTP to authenticate final SetMFAEnrollmentgetSetMFAEnrollment()If set to 'enroll', enrolls the member in MFA by setting the "mfa_enrolled" boolean to true. final IntegergetSessionDurationMinutes()indicates how long the session should last before it expires -
-
Constructor Detail
-
OTP.SMS.AuthenticateParameters
OTP.SMS.AuthenticateParameters(String organizationId, String memberId, String code, SetMFAEnrollment setMFAEnrollment, Integer sessionDurationMinutes)
-
OTP.SMS.AuthenticateParameters
OTP.SMS.AuthenticateParameters(String organizationId, String memberId, String code, SetMFAEnrollment setMFAEnrollment)
-
-
Method Detail
-
getOrganizationId
final String getOrganizationId()
The ID of the organization the member belongs to
-
getMemberId
final String getMemberId()
The ID of the member to send the OTP to
-
getSetMFAEnrollment
final SetMFAEnrollment getSetMFAEnrollment()
If set to 'enroll', enrolls the member in MFA by setting the "mfa_enrolled" boolean to true. If set to 'unenroll', unenrolls the member in MFA by setting the "mfa_enrolled" boolean to false. If not set, does not affect the member's MFA enrollment.
-
getSessionDurationMinutes
final Integer getSessionDurationMinutes()
indicates how long the session should last before it expires
-
-
-
-