LoginRadius v1.0.0 LoginRadius.PhoneAuthentication View Source

Elixir wrapper for the LoginRadius Phone Authentication API module

Link to this section Summary

Functions

POST - Phone Forgot Password by OTP: Sends OTP to reset the account password. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-forgot-password-by-otp

POST - Phone Login: Retrieves a copy of user data based on Phone ID. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-login

PUT - Phone Login Using One Time Passcode: Verifies a login by One Time Passcode. This API is listed under the Passwordless Login section. https://docs.loginradius.com/api/v2/customer-identity-api/passwordless-login/phone-login-using-otp

GET - Phone Number Availability: Checks if the specified phone number already exists on your site. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-number-availability

PUT - Phone Number Update: Updates a user’s login phone number. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-number-update

DELETE - Remove Phone ID by Access Token: Deletes the Phone ID on a user’s account using access token. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/remove-phone-id-by-access-token

POST - Phone Resend Verification OTP: Resends a verification OTP to verify a user’s phone number. User will receive a verification code that they will need to input. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-resend-otp

POST - Phone Resend Verification OTP by Access Token: Resends a verification OTP to verify a user’s phone number in cases where an active token already exists. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-resend-otp-by-token

PUT - Phone Reset Password by OTP: Resets a user’s password using OTP. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-reset-password-by-otp

PUT - Reset Phone ID Verification: Resets phone number verification of a user’s account. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/reset-phone-id-verification

GET - Phone Send One Time Passcode: Sends a One Time Passcode by verified phone ID. This API is listed under the Passwordless Login section. https://docs.loginradius.com/api/v2/customer-identity-api/passwordless-login/phone-send-otp

POST - Phone User Registration by SMS: Registers a new user into Cloud Storage and triggers the phone verification process. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-user-registration-by-sms

PUT - Phone Verification by OTP: Validates the verification code sent to verify a user’s phone number. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-verify-otp

PUT - Phone Verification OTP by Access Token: Consumes the verification code sent to verify a user’s phone number. For use in front-end where user has already logged in by passing user’s access token. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-verify-otp-by-token

Link to this section Functions

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

POST - Phone Forgot Password by OTP: Sends OTP to reset the account password. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-forgot-password-by-otp

Link to this function login(data, login_url \\ "", sms_template \\ "", g_recaptcha_response \\ "") View Source

POST - Phone Login: Retrieves a copy of user data based on Phone ID. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-login

Link to this function login_using_one_time_passcode(data) View Source
login_using_one_time_passcode(map()) :: LoginRadius.response()

PUT - Phone Login Using One Time Passcode: Verifies a login by One Time Passcode. This API is listed under the Passwordless Login section. https://docs.loginradius.com/api/v2/customer-identity-api/passwordless-login/phone-login-using-otp

Link to this function phone_number_availability(phone_id) View Source
phone_number_availability(String.t()) :: LoginRadius.response()

GET - Phone Number Availability: Checks if the specified phone number already exists on your site. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-number-availability

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

PUT - Phone Number Update: Updates a user’s login phone number. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-number-update

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

DELETE - Remove Phone ID by Access Token: Deletes the Phone ID on a user’s account using access token. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/remove-phone-id-by-access-token

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

POST - Phone Resend Verification OTP: Resends a verification OTP to verify a user’s phone number. User will receive a verification code that they will need to input. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-resend-otp

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

POST - Phone Resend Verification OTP by Access Token: Resends a verification OTP to verify a user’s phone number in cases where an active token already exists. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-resend-otp-by-token

Link to this function reset_password_by_otp(data) View Source
reset_password_by_otp(map()) :: LoginRadius.response()

PUT - Phone Reset Password by OTP: Resets a user’s password using OTP. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-reset-password-by-otp

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

PUT - Reset Phone ID Verification: Resets phone number verification of a user’s account. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/reset-phone-id-verification

Link to this function send_one_time_passcode(phone_id, sms_template \\ "") View Source
send_one_time_passcode(String.t(), String.t()) :: LoginRadius.response()

GET - Phone Send One Time Passcode: Sends a One Time Passcode by verified phone ID. This API is listed under the Passwordless Login section. https://docs.loginradius.com/api/v2/customer-identity-api/passwordless-login/phone-send-otp

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

POST - Phone User Registration by SMS: Registers a new user into Cloud Storage and triggers the phone verification process. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-user-registration-by-sms

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

PUT - Phone Verification by OTP: Validates the verification code sent to verify a user’s phone number. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-verify-otp

Link to this function verify_otp_by_access_token(access_token, otp, sms_template \\ "") View Source
verify_otp_by_access_token(String.t(), String.t(), String.t()) ::
  LoginRadius.response()

PUT - Phone Verification OTP by Access Token: Consumes the verification code sent to verify a user’s phone number. For use in front-end where user has already logged in by passing user’s access token. https://docs.loginradius.com/api/v2/customer-identity-api/phone-authentication/phone-verify-otp-by-token