AuthenticateParameters

data class AuthenticateParameters(val organizationId: String, val memberId: String, val code: String, val setMFAEnrollment: SetMFAEnrollment? = null, val sessionDurationMinutes: UInt = Constants.DEFAULT_SESSION_TIME_MINUTES)

A data class wrapping the parameters needed to authenticate an SMS OTP

Constructors

Link copied to clipboard
constructor(organizationId: String, memberId: String, code: String, setMFAEnrollment: SetMFAEnrollment? = null, sessionDurationMinutes: UInt = Constants.DEFAULT_SESSION_TIME_MINUTES)

Properties

Link copied to clipboard

The OTP to authenticate

Link copied to clipboard

The ID of the member to send the OTP to

Link copied to clipboard

The ID of the organization the member belongs to

Link copied to clipboard

indicates how long the session should last before it expires

Link copied to clipboard
val setMFAEnrollment: SetMFAEnrollment? = null

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.