View Source WorkOS.MFA (WorkOS SDK for Elixir v1.1.0)
This module is deprecated.
Summary
Functions
Creates a Challenge for an Authentication Factor.
Deletes an Authentication Factor.
Enrolls an Authentication Factor.
Gets an Authentication Factor.
Verifies Authentication Challenge.
Functions
@spec challenge_factor(WorkOS.Client.t(), map()) :: WorkOS.Client.response(WorkOS.MFA.AuthenticationChallenge.t())
Creates a Challenge for an Authentication Factor.
Parameter options:
:authentication_factor_id
- The ID of the Authentication Factor. (required):sms_template
- A valid phone number for an SMS-enabled device. Required when type is sms.
Link to this function
delete_factor(client \\ WorkOS.client(), authentication_factor_id)
View Source@spec delete_factor(WorkOS.Client.t(), String.t()) :: WorkOS.Client.response(nil)
Deletes an Authentication Factor.
This function is deprecated. MFA has been replaced by the User Management Multi-Factor API..
@spec enroll_factor(WorkOS.Client.t(), map()) :: WorkOS.Client.response(WorkOS.MFA.AuthenticationFactor.t())
Enrolls an Authentication Factor.
Parameter options:
:type
- The type of the factor to enroll. Only option available istotp
. (required):totp_issuer
- Fortotp
factors. Typically your application or company name, this helps users distinguish between factors in authenticator apps.:totp_user
- Fortotp
factors. Used as the account name in authenticator apps. Defaults to the user's email.:phone_number
- A valid phone number for an SMS-enabled device. Required when type is sms.
@spec get_factor(WorkOS.Client.t(), String.t()) :: WorkOS.Client.response(WorkOS.MFA.AuthenticationFactor.t())
Gets an Authentication Factor.
Link to this function
verify_challenge(client \\ WorkOS.client(), authentication_challenge_id, opts)
View Source@spec verify_challenge(WorkOS.Client.t(), String.t(), map()) :: WorkOS.Client.response(WorkOS.MFA.VerifyChallenge.t())
Verifies Authentication Challenge.
Parameter options:
:code
- The 6 digit code to be verified. (required)