Package com.stytch.sdk.b2b.totp
Class TOTP.AuthenticateParameters
-
- All Implemented Interfaces:
public final class TOTP.AuthenticateParametersA data class wrapping the parameters needed to authenticate a TOTP
-
-
Field Summary
Fields Modifier and Type Field Description private final StringorganizationIdprivate final StringmemberIdprivate final Stringcodeprivate final SetMFAEnrollmentsetMFAEnrollmentprivate final BooleansetDefaultMFAMethodprivate final IntegersessionDurationMinutes
-
Constructor Summary
Constructors Constructor Description TOTP.AuthenticateParameters(String organizationId, String memberId, String code, SetMFAEnrollment setMFAEnrollment, Boolean setDefaultMFAMethod, Integer sessionDurationMinutes)TOTP.AuthenticateParameters(String organizationId, String memberId, String code, SetMFAEnrollment setMFAEnrollment, Boolean setDefaultMFAMethod)TOTP.AuthenticateParameters(String organizationId, String memberId, String code, SetMFAEnrollment setMFAEnrollment)TOTP.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 create the TOTP for final StringgetCode()The TOTP code to authenticate final SetMFAEnrollmentgetSetMFAEnrollment()If set to 'enroll', enrolls the member in MFA by setting the "mfa_enrolled" boolean to true. final BooleangetSetDefaultMFAMethod()If set to true, sets TOTP as the member's default MFA method. final IntegergetSessionDurationMinutes()indicates how long the session should last before it expires -
-
Constructor Detail
-
TOTP.AuthenticateParameters
TOTP.AuthenticateParameters(String organizationId, String memberId, String code, SetMFAEnrollment setMFAEnrollment, Boolean setDefaultMFAMethod, Integer sessionDurationMinutes)
-
TOTP.AuthenticateParameters
TOTP.AuthenticateParameters(String organizationId, String memberId, String code, SetMFAEnrollment setMFAEnrollment, Boolean setDefaultMFAMethod)
-
TOTP.AuthenticateParameters
TOTP.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 create the TOTP for
-
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.
-
getSetDefaultMFAMethod
final Boolean getSetDefaultMFAMethod()
If set to true, sets TOTP as the member's default MFA method.
-
getSessionDurationMinutes
final Integer getSessionDurationMinutes()
indicates how long the session should last before it expires
-
-
-
-