LoginRadius v1.0.0 LoginRadius.MultiFactorAuthentication View Source

Elixir wrapper for the LoginRadius Multi Factor Authentication API module

Link to this section Summary

Functions

GET - MFA Backup Codes by Access Token: Retrieves a set of backup codes using access token to allow user login on a site with MFA enabled in the event that the user does not have a secondary factor available. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-backup-code-by-access-token

GET - MFA Backup Codes by UID: Retrieves a set of backup codes using UID. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-backup-code-by-uid

POST - MFA Email Login: Logs in by Email ID on a Multi-Factor Authentication enabled site. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-email-login

POST - MFA Phone Login: Logs in by Phone ID on a MFA enabled site. API wrapper is identical to email, except data object contains phone instead of email. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-phone-login

POST - MFA UserName Login: Logs in by Username on a MFA enabled site. API wrapper is identical to email, except data object contains username instead of email. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-user-name-login

GET - Reset Backup Codes by Access Token: Resets the backup codes on a given account using access token. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-reset-backup-code-by-access-token

GET - MFA Reset Backup Codes by UID: Resets the backup codes on a given account using UID. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-reset-backup-code-by-uid

DELETE - MFA Reset Google Authenticator by Access Token: Resets the Google Authenticator configurations on a given account using user’s access token. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-reset-google-authenticator-by-token

DELETE - MFA Reset Google Authenticator by UID: Resets the Google Authenticator configurations on a given account using user’s UID. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-reset-google-authenticator-by-uid

DELETE - MFA Reset SMS Authenticator by Access Token: Resets the SMS Authenticator configurations on a given account using user’s access token. Identical to Reset Google Authenticator by Access Token except data object has key otpauthenticator instead of googleauthenticator. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-reset-sms-authenticator-by-token

DELETE - MFA Reset SMS Authenticator by UID: Resets the SMS Authenticator configurations on a given account using user’s UID. Identical to Reset Google Authenticator by UID except data object has key otpauthenticator instead of googleauthenticator. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-reset-sms-authenticator-by-uid

PUT - Update MFA by Access Token: Enables Multi Factor Authentication by access token upon user login. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/update-mfa-by-access-token

PUT - Update MFA Setting: Enables Multi Factor Authentication by OTP upon user login. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/update-mfa-setting

PUT - MFA Update Phone Number: Updates (if configured) the phone number used for MFA. API authenticates using the second factor authentication token. Sends a verification OTP to provided phone number. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-update-phone-number

PUT - MFA Update Phone Number by Access Token: Updates the MFA phone number by sending a verification OTP to the provided phone number. API authenticates using user’s login access token. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-update-phone-number-by-token

GET - MFA Validate Access Token: Configures MFA after login using access token. (For MFA optional) https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-validate-access-token

PUT - MFA Validate Backup Code: Validates the backup code provided by the user, returns an access token allowing user to login. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-validate-backup-code

PUT - MFA Validate Google Auth Code: Validates google authenticator code for use with MFA. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-validate-google-auth-code

PUT - MFA Validate OTP: Validates the One Time Passcode received via SMS for use with MFA. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-validate-otp

Link to this section Functions

Link to this function backup_codes_by_access_token(access_token) View Source
backup_codes_by_access_token(String.t()) :: LoginRadius.response()

GET - MFA Backup Codes by Access Token: Retrieves a set of backup codes using access token to allow user login on a site with MFA enabled in the event that the user does not have a secondary factor available. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-backup-code-by-access-token

Link to this function backup_codes_by_uid(uid) View Source
backup_codes_by_uid(String.t()) :: LoginRadius.response()

GET - MFA Backup Codes by UID: Retrieves a set of backup codes using UID. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-backup-code-by-uid

Link to this function login_by_email(data, login_url \\ "", verification_url \\ "", email_template \\ "", sms_template_2fa \\ "") View Source
login_by_email(map(), String.t(), String.t(), String.t(), String.t()) ::
  LoginRadius.response()

POST - MFA Email Login: Logs in by Email ID on a Multi-Factor Authentication enabled site. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-email-login

Link to this function login_by_phone(data, login_url \\ "", verification_url \\ "", email_template \\ "", sms_template_2fa \\ "") View Source
login_by_phone(map(), String.t(), String.t(), String.t(), String.t()) ::
  LoginRadius.response()

POST - MFA Phone Login: Logs in by Phone ID on a MFA enabled site. API wrapper is identical to email, except data object contains phone instead of email. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-phone-login

Link to this function login_by_username(data, login_url \\ "", verification_url \\ "", email_template \\ "", sms_template_2fa \\ "") View Source
login_by_username(map(), String.t(), String.t(), String.t(), String.t()) ::
  LoginRadius.response()

POST - MFA UserName Login: Logs in by Username on a MFA enabled site. API wrapper is identical to email, except data object contains username instead of email. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-user-name-login

Link to this function reset_backup_codes_by_access_token(access_token) View Source
reset_backup_codes_by_access_token(String.t()) :: LoginRadius.response()

GET - Reset Backup Codes by Access Token: Resets the backup codes on a given account using access token. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-reset-backup-code-by-access-token

Link to this function reset_backup_codes_by_uid(uid) View Source
reset_backup_codes_by_uid(String.t()) :: LoginRadius.response()

GET - MFA Reset Backup Codes by UID: Resets the backup codes on a given account using UID. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-reset-backup-code-by-uid

Link to this function reset_google_authenticator_by_access_token(access_token, data) View Source
reset_google_authenticator_by_access_token(String.t(), map()) ::
  LoginRadius.response()

DELETE - MFA Reset Google Authenticator by Access Token: Resets the Google Authenticator configurations on a given account using user’s access token. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-reset-google-authenticator-by-token

Link to this function reset_google_authenticator_by_uid(uid, data) View Source
reset_google_authenticator_by_uid(String.t(), map()) :: LoginRadius.response()

DELETE - MFA Reset Google Authenticator by UID: Resets the Google Authenticator configurations on a given account using user’s UID. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-reset-google-authenticator-by-uid

Link to this function reset_sms_authenticator_by_access_token(access_token, data) View Source
reset_sms_authenticator_by_access_token(String.t(), map()) ::
  LoginRadius.response()

DELETE - MFA Reset SMS Authenticator by Access Token: Resets the SMS Authenticator configurations on a given account using user’s access token. Identical to Reset Google Authenticator by Access Token except data object has key otpauthenticator instead of googleauthenticator. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-reset-sms-authenticator-by-token

Link to this function reset_sms_authenticator_by_uid(uid, data) View Source
reset_sms_authenticator_by_uid(String.t(), map()) :: LoginRadius.response()

DELETE - MFA Reset SMS Authenticator by UID: Resets the SMS Authenticator configurations on a given account using user’s UID. Identical to Reset Google Authenticator by UID except data object has key otpauthenticator instead of googleauthenticator. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-reset-sms-authenticator-by-uid

Link to this function update_mfa_by_access_token(access_token, data, sms_template \\ "") View Source
update_mfa_by_access_token(String.t(), map(), String.t()) ::
  LoginRadius.response()

PUT - Update MFA by Access Token: Enables Multi Factor Authentication by access token upon user login. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/update-mfa-by-access-token

Link to this function update_mfa_setting(access_token, data) View Source
update_mfa_setting(String.t(), map()) :: LoginRadius.response()

PUT - Update MFA Setting: Enables Multi Factor Authentication by OTP upon user login. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/update-mfa-setting

Link to this function update_phone_number(second_factor_authentication_token, data, sms_template_2fa \\ "") View Source
update_phone_number(String.t(), map(), String.t()) :: LoginRadius.response()

PUT - MFA Update Phone Number: Updates (if configured) the phone number used for MFA. API authenticates using the second factor authentication token. Sends a verification OTP to provided phone number. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-update-phone-number

Link to this function update_phone_number_by_access_token(access_token, data, sms_template_2fa \\ "") View Source
update_phone_number_by_access_token(String.t(), map(), String.t()) ::
  LoginRadius.response()

PUT - MFA Update Phone Number by Access Token: Updates the MFA phone number by sending a verification OTP to the provided phone number. API authenticates using user’s login access token. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-update-phone-number-by-token

Link to this function validate_access_token(access_token, sms_template_2fa \\ "") View Source
validate_access_token(String.t(), String.t()) :: LoginRadius.response()

GET - MFA Validate Access Token: Configures MFA after login using access token. (For MFA optional) https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-validate-access-token

Link to this function validate_backup_code(second_factor_authentication_token, data) View Source
validate_backup_code(String.t(), map()) :: LoginRadius.response()

PUT - MFA Validate Backup Code: Validates the backup code provided by the user, returns an access token allowing user to login. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-validate-backup-code

Link to this function validate_google_auth_code(second_factor_authentication_token, data, sms_template_2fa \\ "") View Source
validate_google_auth_code(String.t(), map(), String.t()) ::
  LoginRadius.response()

PUT - MFA Validate Google Auth Code: Validates google authenticator code for use with MFA. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-validate-google-auth-code

Link to this function validate_otp(second_factor_authentication_token, data, sms_template_2fa \\ "") View Source
validate_otp(String.t(), map(), String.t()) :: LoginRadius.response()

PUT - MFA Validate OTP: Validates the One Time Passcode received via SMS for use with MFA. https://docs.loginradius.com/api/v2/customer-identity-api/multi-factor-authentication/mfa-validate-otp