View Source WorkOS.MFA (WorkOS SDK for Elixir v1.1.0)

This module is deprecated.

Summary

Functions

Link to this function

challenge_factor(client \\ WorkOS.client(), opts)

View Source

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.

Link to this function

enroll_factor(client \\ WorkOS.client(), opts)

View Source
This function is deprecated. MFA has been replaced by the User Management Multi-Factor API..

Enrolls an Authentication Factor.

Parameter options:

  • :type - The type of the factor to enroll. Only option available is totp. (required)
  • :totp_issuer - For totp factors. Typically your application or company name, this helps users distinguish between factors in authenticator apps.
  • :totp_user - For totp 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.
Link to this function

get_factor(client \\ WorkOS.client(), authentication_factor_id)

View Source

Gets an Authentication Factor.

Link to this function

verify_challenge(client \\ WorkOS.client(), authentication_challenge_id, opts)

View Source

Verifies Authentication Challenge.

Parameter options:

  • :code - The 6 digit code to be verified. (required)