https://github.com/loginradius/ruby-on-rails-sdk
Ruby wrapper for the LoginRadius API. It will let you integrate LoginRadius' customer identity platform with your Ruby On Rails application(s).
https://github.com/loginradius/ruby-on-rails-sdk
customer-identity hacktoberfest loginradius-api loginradius-platform ruby-gem ruby-on-rails ruby-wrapper social-login
Last synced: about 1 year ago
JSON representation
Ruby wrapper for the LoginRadius API. It will let you integrate LoginRadius' customer identity platform with your Ruby On Rails application(s).
- Host: GitHub
- URL: https://github.com/loginradius/ruby-on-rails-sdk
- Owner: LoginRadius
- License: mit
- Created: 2013-06-19T17:56:39.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2025-04-01T06:28:02.000Z (about 1 year ago)
- Last Synced: 2025-04-01T07:31:47.669Z (about 1 year ago)
- Topics: customer-identity, hacktoberfest, loginradius-api, loginradius-platform, ruby-gem, ruby-on-rails, ruby-wrapper, social-login
- Language: Ruby
- Homepage: http://www.loginradius.com
- Size: 723 KB
- Stars: 6
- Watchers: 9
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# LoginRadius Ruby SDK
## Introduction ##
LoginRadius Customer Registration wrapper provides access to LoginRadius Identity Management Platform API.
LoginRadius is an Identity Management Platform that simplifies user registration while securing data. LoginRadius Platform simplifies and secures your user registration process, increases conversion with Social Login that combines 30 major social platforms, and offers a full solution with Traditional Customer Registration. You can gather a wealth of user profile data from Social Login or Traditional Customer Registration.
LoginRadius centralizes it all in one place, making it easy to manage and access. Easily integrate LoginRadius with all of your third-party applications, like MailChimp, Google Analytics, Livefyre and many more, making it easy to utilize the data you are capturing.
LoginRadius helps businesses boost user engagement on their web/mobile platform, manage online identities, utilize social media for marketing, capture accurate consumer data, and get unique social insight into their customer base.
Please visit [here](http://www.loginradius.com/) for more information.
## Documentation
Welcome to LoginRadius Ruby SDK documentation!
>Disclaimer
This library is meant to help you with a quick implementation of the LoginRadius platform and also to serve as a reference point for the LoginRadius API. Keep in mind that it is an open source library, which means you are free to download and customize the library functions based on your specific application needs.
#### Setup & Installation
Add this line to your application's Gemfile:
````shell
gem "login_radius", :path => "gemfilepath";
````
Or
````shell
gem 'login_radius', '~> 11.5.0'
````
And then execute:
````bash
$ bundle
````
Or install it yourself as:
````bash
$ gem install login_radius
````
#### Usage
1)Before using any of the functions available in the library, its corresponding module must first define the global constant in `config/application.yml`:
```ruby
SITE_NAME: ""
API_KEY: ""
API_SECRET: ""
CUSTOM_API_DOMAIN: ""
API_REQUEST_SIGNING: "false"
```
To know your Site Name,API Key and Secret. Kindly follow the steps in the [Document](https://www.loginradius.com/docs/api/v2/admin-console/platform-security/api-key-and-secret).
### X-Origin-IP
LoginRadius allows you to add X-Origin-IP in your headers and it determines the IP address of the client's request,this can also be useful to overcome analytics discrepancies where the analytics depend on header data.
```ruby
Origin_IP: ""
```
2)After define the configuration key details, its corresponding module must first be instantiated:
Create `login_radius.rb` in `/config/initializers`:
```ruby
require 'login_radius'
::AccountApi = LoginRadius::AccountApi.new
::RoleApi = LoginRadius::RoleApi.new
::SottApi = LoginRadius::SottApi.new
::ConfigurationApi = LoginRadius::ConfigurationApi.new
::ConsentManagementApi = LoginRadius::ConsentManagementApi.new
::CustomObjectApi = LoginRadius::CustomObjectApi.new
::MultiFactorAuthenticationApi = LoginRadius::MultiFactorAuthenticationApi.new
::ReAuthenticationApi = LoginRadius::ReAuthenticationApi.new
::WebHookApi = LoginRadius::WebHookApi.new
::AuthenticationApi = LoginRadius::AuthenticationApi.new
::OneTouchLoginApi = LoginRadius::OneTouchLoginApi.new
::PasswordLessLoginApi = LoginRadius::PasswordLessLoginApi.new
::PhoneAuthenticationApi = LoginRadius::PhoneAuthenticationApi.new
::PINAuthenticationApi = LoginRadius::PINAuthenticationApi.new
::RiskBasedAuthenticationApi = LoginRadius::RiskBasedAuthenticationApi.new
::SmartLoginApi = LoginRadius::SmartLoginApi.new
::NativeSocialApi = LoginRadius::NativeSocialApi.new
::SocialApi = LoginRadius::SocialApi.new
```
Please note that you only have to initiate modules you need.
The API key and secret can be obtained from the LoginRadius Admin-console.
## APIs
### Authentication API
List of APIs in this Section:
* PUT : [Auth Update Profile by Token](#UpdateProfileByAccessToken-put-)
* PUT : [Auth Unlock Account by Access Token](#UnlockAccountByToken-put-)
* PUT : [Auth Verify Email By OTP](#VerifyEmailByOTP-put-)
* PUT : [Auth Reset Password by Security Answer and Email](#ResetPasswordBySecurityAnswerAndEmail-put-)
* PUT : [Auth Reset Password by Security Answer and Phone](#ResetPasswordBySecurityAnswerAndPhone-put-)
* PUT : [Auth Reset Password by Security Answer and UserName](#ResetPasswordBySecurityAnswerAndUserName-put-)
* PUT : [Auth Reset Password by Reset Token](#ResetPasswordByResetToken-put-)
* PUT : [Auth Reset Password by OTP](#ResetPasswordByEmailOTP-put-)
* PUT : [Auth Reset Password by OTP and UserName](#ResetPasswordByOTPAndUserName-put-)
* PUT : [Auth Change Password](#ChangePassword-put-)
* PUT : [Auth Set or Change UserName](#SetOrChangeUserName-put-)
* PUT : [Auth Resend Email Verification](#AuthResendEmailVerification-put-)
* POST : [Auth Add Email](#AddEmail-post-)
* POST : [Auth Login by Email](#LoginByEmail-post-)
* POST : [Auth Login by Username](#LoginByUserName-post-)
* POST : [Auth Forgot Password](#ForgotPassword-post-)
* POST : [Auth Link Social Identities](#LinkSocialIdentities-post-)
* POST : [Auth Link Social Identities By Ping](#LinkSocialIdentitiesByPing-post-)
* POST : [Auth User Registration by Email](#UserRegistrationByEmail-post-)
* POST : [Auth User Registration By Captcha](#UserRegistrationByCaptcha-post-)
* GET : [Get Security Questions By Email](#GetSecurityQuestionsByEmail-get-)
* GET : [Get Security Questions By UserName](#GetSecurityQuestionsByUserName-get-)
* GET : [Get Security Questions By Phone](#GetSecurityQuestionsByPhone-get-)
* GET : [Get Security Questions By Access Token](#GetSecurityQuestionsByAccessToken-get-)
* GET : [Auth Validate Access token](#AuthValidateAccessToken-get-)
* GET : [Access Token Invalidate](#AuthInValidateAccessToken-get-)
* GET : [Access Token Info](#GetAccessTokenInfo-get-)
* GET : [Auth Read all Profiles by Token](#GetProfileByAccessToken-get-)
* GET : [Auth Send Welcome Email](#SendWelcomeEmail-get-)
* GET : [Auth Delete Account](#DeleteAccountByDeleteToken-get-)
* GET : [Get Profile By Ping](#GetProfileByPing-get-)
* GET : [Auth Check Email Availability](#CheckEmailAvailability-get-)
* GET : [Auth Verify Email](#VerifyEmail-get-)
* GET : [Auth Check UserName Availability](#CheckUserNameAvailability-get-)
* GET : [Auth Privacy Policy Accept](#AcceptPrivacyPolicy-get-)
* GET : [Auth Privacy Policy History By Access Token](#GetPrivacyPolicyHistoryByAccessToken-get-)
* DELETE : [Auth Delete Account with Email Confirmation](#DeleteAccountWithEmailConfirmation-delete-)
* DELETE : [Auth Remove Email](#RemoveEmail-delete-)
* DELETE : [Auth Unlink Social Identities](#UnlinkSocialIdentities-delete-)
Auth Update Profile by Token (PUT)
This API is used to update the user's profile by passing the access token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-update-profile-by-token/)
```ruby
access_token = "" #Required
user_profile_update_model ={
"firstName" => "",
"lastName" => ""} #Required
email_template = "" #Optional
fields = nil #Optional
null_support = true #Optional
sms_template = "" #Optional
verification_url = "" #Optional
response = AuthenticationApi.update_profile_by_access_token(access_token, user_profile_update_model, email_template, fields, null_support, sms_template, verification_url)
```
Auth Unlock Account by Access Token (PUT)
This API is used to allow a customer with a valid access token to unlock their account provided that they successfully pass the prompted Bot Protection challenges. The Block or Suspend block types are not applicable for this API. For additional details see our Auth Security Configuration documentation.You are only required to pass the Post Parameters that correspond to the prompted challenges. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-unlock-account-by-access-token/)
```ruby
access_token = "" #Required
unlock_profile_model ={
"g-recaptcha-response" => ""} #Required
response = AuthenticationApi.unlock_account_by_token(access_token, unlock_profile_model)
```
Auth Verify Email By OTP (PUT)
This API is used to verify the email of user when the OTP Email verification flow is enabled, please note that you must contact LoginRadius to have this feature enabled. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-verify-email-by-otp/)
```ruby
email_verification_by_otp_model ={
"email" => "",
"otp" => ""} #Required
fields = nil #Optional
url = "" #Optional
welcome_email_template = "" #Optional
response = AuthenticationApi.verify_email_by_otp(email_verification_by_otp_model, fields, url, welcome_email_template)
```
Auth Reset Password by Security Answer and Email (PUT)
This API is used to reset password for the specified account by security question [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-email)
```ruby
reset_password_by_security_answer_and_email_model ={
"email" => "",
"password" => "",
"securityAnswer" => {"QuestionID"=>"Answer"}} #Required
response = AuthenticationApi.reset_password_by_security_answer_and_email(reset_password_by_security_answer_and_email_model)
```
Auth Reset Password by Security Answer and Phone (PUT)
This API is used to reset password for the specified account by security question [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-phone)
```ruby
reset_password_by_security_answer_and_phone_model ={
"password" => "",
"phone" => "",
"securityAnswer" => {"QuestionID"=>"Answer"}} #Required
response = AuthenticationApi.reset_password_by_security_answer_and_phone(reset_password_by_security_answer_and_phone_model)
```
Auth Reset Password by Security Answer and UserName (PUT)
This API is used to reset password for the specified account by security question [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-username)
```ruby
reset_password_by_security_answer_and_user_name_model ={
"password" => "",
"securityAnswer" => {"QuestionID"=>"Answer"},
"userName" => ""} #Required
response = AuthenticationApi.reset_password_by_security_answer_and_user_name(reset_password_by_security_answer_and_user_name_model)
```
Auth Reset Password by Reset Token (PUT)
This API is used to set a new password for the specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-reset-token)
```ruby
reset_password_by_reset_token_model ={
"password" => "",
"resetToken" => ""} #Required
response = AuthenticationApi.reset_password_by_reset_token(reset_password_by_reset_token_model)
```
Auth Reset Password by OTP (PUT)
This API is used to set a new password for the specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-otp)
```ruby
reset_password_by_email_and_otp_model ={
"email" => "",
"otp" => "",
"password" => ""} #Required
response = AuthenticationApi.reset_password_by_email_otp(reset_password_by_email_and_otp_model)
```
Auth Reset Password by OTP and UserName (PUT)
This API is used to set a new password for the specified account if you are using the username as the unique identifier in your workflow [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-otp-and-username/)
```ruby
reset_password_by_user_name_model ={
"otp" => "",
"password" => "",
"userName" => ""} #Required
response = AuthenticationApi.reset_password_by_otp_and_user_name(reset_password_by_user_name_model)
```
Auth Change Password (PUT)
This API is used to change the accounts password based on the previous password [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-change-password)
```ruby
access_token = "" #Required
new_password = "" #Required
old_password = "" #Required
response = AuthenticationApi.change_password(access_token, new_password, old_password)
```
Auth Set or Change UserName (PUT)
This API is used to set or change UserName by access token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-set-or-change-user-name/)
```ruby
access_token = "" #Required
username = "" #Required
response = AuthenticationApi.set_or_change_user_name(access_token, username)
```
Auth Resend Email Verification (PUT)
This API resends the verification email to the user. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-resend-email-verification/)
```ruby
email = "" #Required
email_template = "" #Optional
verification_url = "" #Optional
response = AuthenticationApi.auth_resend_email_verification(email, email_template, verification_url)
```
Auth Add Email (POST)
This API is used to add additional emails to a user's account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-add-email)
```ruby
access_token = "" #Required
email = "" #Required
type = "" #Required
email_template = "" #Optional
verification_url = "" #Optional
response = AuthenticationApi.add_email(access_token, email, type, email_template, verification_url)
```
Auth Login by Email (POST)
This API retrieves a copy of the user data based on the Email [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-login-by-email)
```ruby
email_authentication_model ={
"email" => "",
"password" => ""} #Required
email_template = "" #Optional
fields = nil #Optional
login_url = "" #Optional
verification_url = "" #Optional
response = AuthenticationApi.login_by_email(email_authentication_model, email_template, fields, login_url, verification_url)
```
Auth Login by Username (POST)
This API retrieves a copy of the user data based on the Username [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-login-by-username)
```ruby
user_name_authentication_model ={
"password" => "",
"username" => ""} #Required
email_template = "" #Optional
fields = nil #Optional
login_url = "" #Optional
verification_url = "" #Optional
response = AuthenticationApi.login_by_user_name(user_name_authentication_model, email_template, fields, login_url, verification_url)
```
Auth Forgot Password (POST)
This API is used to send the reset password url to a specified account. Note: If you have the UserName workflow enabled, you may replace the 'email' parameter with 'username' [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-forgot-password)
```ruby
email = "" #Required
reset_password_url = "" #Required
email_template = "" #Optional
response = AuthenticationApi.forgot_password(email, reset_password_url, email_template)
```
Auth Link Social Identities (POST)
This API is used to link up a social provider account with an existing LoginRadius account on the basis of access token and the social providers user access token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-link-social-identities)
```ruby
access_token = "" #Required
candidate_token = "" #Required
response = AuthenticationApi.link_social_identities(access_token, candidate_token)
```
Auth Link Social Identities By Ping (POST)
This API is used to link up a social provider account with an existing LoginRadius account on the basis of ping and the social providers user access token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-link-social-identities-by-ping)
```ruby
access_token = "" #Required
client_guid = "" #Required
response = AuthenticationApi.link_social_identities_by_ping(access_token, client_guid)
```
Auth User Registration by Email (POST)
This API creates a user in the database as well as sends a verification email to the user. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-user-registration-by-email)
```ruby
auth_user_registration_model ={
"email" => [ {
"type" => "" ,
"value" => ""
} ] ,
"firstName" => "",
"lastName" => "",
"password" => ""} #Required
sott = "" #Required
email_template = "" #Optional
fields = nil #Optional
options = "" #Optional
verification_url = "" #Optional
welcome_email_template = "" #Optional
response = AuthenticationApi.user_registration_by_email(auth_user_registration_model, sott, email_template, fields, options, verification_url, welcome_email_template)
```
Auth User Registration By Captcha (POST)
This API creates a user in the database as well as sends a verification email to the user. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-user-registration-by-recaptcha)
```ruby
auth_user_registration_model_with_captcha ={
"email" => [ {
"type" => "" ,
"value" => ""
} ] ,
"firstName" => "",
"g-recaptcha-response" => "",
"lastName" => "",
"password" => ""} #Required
email_template = "" #Optional
fields = nil #Optional
options = "" #Optional
sms_template = "" #Optional
verification_url = "" #Optional
welcome_email_template = "" #Optional
response = AuthenticationApi.user_registration_by_captcha(auth_user_registration_model_with_captcha, email_template, fields, options, sms_template, verification_url, welcome_email_template)
```
Get Security Questions By Email (GET)
This API is used to retrieve the list of questions that are configured on the respective LoginRadius site. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/security-questions-by-email/)
```ruby
email = "" #Required
response = AuthenticationApi.get_security_questions_by_email(email)
```
Get Security Questions By UserName (GET)
This API is used to retrieve the list of questions that are configured on the respective LoginRadius site. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/security-questions-by-user-name/)
```ruby
user_name = "" #Required
response = AuthenticationApi.get_security_questions_by_user_name(user_name)
```
Get Security Questions By Phone (GET)
This API is used to retrieve the list of questions that are configured on the respective LoginRadius site. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/security-questions-by-phone/)
```ruby
phone = "" #Required
response = AuthenticationApi.get_security_questions_by_phone(phone)
```
Get Security Questions By Access Token (GET)
This API is used to retrieve the list of questions that are configured on the respective LoginRadius site. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/security-questions-by-access-token/)
```ruby
access_token = "" #Required
response = AuthenticationApi.get_security_questions_by_access_token(access_token)
```
Auth Validate Access token (GET)
This api validates access token, if valid then returns a response with its expiry otherwise error. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-validate-access-token/)
```ruby
access_token = "" #Required
response = AuthenticationApi.auth_validate_access_token(access_token)
```
Access Token Invalidate (GET)
This api call invalidates the active access token or expires an access token's validity. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-invalidate-access-token/)
```ruby
access_token = "" #Required
prevent_refresh = true #Optional
response = AuthenticationApi.auth_in_validate_access_token(access_token, prevent_refresh)
```
Access Token Info (GET)
This api call provide the active access token Information [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-access-token-info/)
```ruby
access_token = "" #Required
response = AuthenticationApi.get_access_token_info(access_token)
```
Auth Read all Profiles by Token (GET)
This API retrieves a copy of the user data based on the access token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-read-profiles-by-token/)
```ruby
access_token = "" #Required
fields = nil #Optional
email_template = "" #Optional
verification_url = "" #Optional
welcome_email_template = "" #Optional
response = AuthenticationApi.get_profile_by_access_token(access_token, fields, email_template, verification_url, welcome_email_template)
```
Auth Send Welcome Email (GET)
This API sends a welcome email [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-send-welcome-email/)
```ruby
access_token = "" #Required
welcome_email_template = "" #Optional
response = AuthenticationApi.send_welcome_email(access_token, welcome_email_template)
```
Auth Delete Account (GET)
This API is used to delete an account by passing it a delete token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-delete-account/)
```ruby
deletetoken = "" #Required
response = AuthenticationApi.delete_account_by_delete_token(deletetoken)
```
Get Profile By Ping (GET)
This API is used to get a user's profile using the clientGuid parameter if no callback feature enabled. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/social-login-by-ping/)
```ruby
client_guid = "" #Required
email_template = "" #Optional
fields = nil #Optional
verification_url = "" #Optional
welcome_email_template = "" #Optional
response = AuthenticationApi.get_profile_by_ping(client_guid, email_template, fields, verification_url, welcome_email_template)
```
Auth Check Email Availability (GET)
This API is used to check the email exists or not on your site. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-email-availability/)
```ruby
email = "" #Required
response = AuthenticationApi.check_email_availability(email)
```
Auth Verify Email (GET)
This API is used to verify the email of user. Note: This API will only return the full profile if you have 'Enable auto login after email verification' set in your LoginRadius Admin Console's Email Workflow settings under 'Verification Email'. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-verify-email/)
```ruby
verification_token = "" #Required
fields = nil #Optional
url = "" #Optional
welcome_email_template = "" #Optional
response = AuthenticationApi.verify_email(verification_token, fields, url, welcome_email_template)
```
Auth Check UserName Availability (GET)
This API is used to check the UserName exists or not on your site. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-username-availability/)
```ruby
username = "" #Required
response = AuthenticationApi.check_user_name_availability(username)
```
Auth Privacy Policy Accept (GET)
This API is used to update the privacy policy stored in the user's profile by providing the access token of the user accepting the privacy policy [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-privacy-policy-accept)
```ruby
access_token = "" #Required
fields = nil #Optional
response = AuthenticationApi.accept_privacy_policy(access_token, fields)
```
Auth Privacy Policy History By Access Token (GET)
This API will return all the accepted privacy policies for the user by providing the access token of that user. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/privacy-policy-history-by-access-token/)
```ruby
access_token = "" #Required
response = AuthenticationApi.get_privacy_policy_history_by_access_token(access_token)
```
Auth Delete Account with Email Confirmation (DELETE)
This API will send a confirmation email for account deletion to the customer's email when passed the customer's access token [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-delete-account-with-email-confirmation/)
```ruby
access_token = "" #Required
delete_url = "" #Optional
email_template = "" #Optional
response = AuthenticationApi.delete_account_with_email_confirmation(access_token, delete_url, email_template)
```
Auth Remove Email (DELETE)
This API is used to remove additional emails from a user's account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-remove-email)
```ruby
access_token = "" #Required
email = "" #Required
response = AuthenticationApi.remove_email(access_token, email)
```
Auth Unlink Social Identities (DELETE)
This API is used to unlink up a social provider account with the specified account based on the access token and the social providers user access token. The unlinked account will automatically get removed from your database. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-unlink-social-identities)
```ruby
access_token = "" #Required
provider = "" #Required
provider_id = "" #Required
response = AuthenticationApi.unlink_social_identities(access_token, provider, provider_id)
```
### Account API
List of APIs in this Section:
* PUT : [Account Update](#UpdateAccountByUid-put-)
* PUT : [Update Phone ID by UID](#UpdatePhoneIDByUid-put-)
* PUT : [Account Set Password](#SetAccountPasswordByUid-put-)
* PUT : [Account Invalidate Verification Email](#InvalidateAccountEmailVerification-put-)
* PUT : [Reset phone ID verification](#ResetPhoneIDVerificationByUid-put-)
* PUT : [Upsert Email](#UpsertEmail-put-)
* PUT : [Update UID](#AccountUpdateUid-put-)
* POST : [Account Create](#CreateAccount-post-)
* POST : [Forgot Password token](#GetForgotPasswordToken-post-)
* POST : [Email Verification token](#GetEmailVerificationToken-post-)
* GET : [Get Privacy Policy History By Uid](#GetPrivacyPolicyHistoryByUid-get-)
* GET : [Account Profiles by Email](#GetAccountProfileByEmail-get-)
* GET : [Account Profiles by Username](#GetAccountProfileByUserName-get-)
* GET : [Account Profile by Phone ID](#GetAccountProfileByPhone-get-)
* GET : [Account Profiles by UID](#GetAccountProfileByUid-get-)
* GET : [Account Password](#GetAccountPasswordHashByUid-get-)
* GET : [Access Token based on UID or User impersonation API](#GetAccessTokenByUid-get-)
* GET : [Refresh Access Token by Refresh Token](#RefreshAccessTokenByRefreshToken-get-)
* GET : [Revoke Refresh Token](#RevokeRefreshToken-get-)
* GET : [Account Identities by Email](#GetAccountIdentitiesByEmail-get-)
* DELETE : [Account Delete](#DeleteAccountByUid-delete-)
* DELETE : [Account Remove Email](#RemoveEmail-delete-)
* DELETE : [Delete User Profiles By Email](#AccountDeleteByEmail-delete-)
Account Update (PUT)
This API is used to update the information of existing accounts in your Cloud Storage. See our Advanced API Usage section Here for more capabilities. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-update)
```ruby
account_user_profile_update_model ={
"firstName" => "",
"lastName" => ""} #Required
uid = "" #Required
fields = nil #Optional
null_support = true #Optional
response = AccountApi.update_account_by_uid(account_user_profile_update_model, uid, fields, null_support)
```
Update Phone ID by UID (PUT)
This API is used to update the PhoneId by using the Uid's. Admin can update the PhoneId's for both the verified and unverified profiles. It will directly replace the PhoneId and bypass the OTP verification process. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/update-phoneid-by-uid)
```ruby
phone = "" #Required
uid = "" #Required
fields = nil #Optional
response = AccountApi.update_phone_id_by_uid(phone, uid, fields)
```
Account Set Password (PUT)
This API is used to set the password of an account in Cloud Storage. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-set-password)
```ruby
password = "" #Required
uid = "" #Required
response = AccountApi.set_account_password_by_uid(password, uid)
```
Account Invalidate Verification Email (PUT)
This API is used to invalidate the Email Verification status on an account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-invalidate-verification-email)
```ruby
uid = "" #Required
email_template = "" #Optional
verification_url = "" #Optional
response = AccountApi.invalidate_account_email_verification(uid, email_template, verification_url)
```
Reset phone ID verification (PUT)
This API Allows you to reset the phone no verification of an end user’s account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/reset-phone-id-verification)
```ruby
uid = "" #Required
sms_template = "" #Optional
response = AccountApi.reset_phone_id_verification_by_uid(uid, sms_template)
```
Upsert Email (PUT)
This API is used to add/upsert another emails in account profile by different-different email types. If the email type is same then it will simply update the existing email, otherwise it will add a new email in Email array. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/upsert-email)
```ruby
upsert_email_model ={
"email" => [ {
"type" => "" ,
"value" => ""
} ] } #Required
uid = "" #Required
fields = nil #Optional
response = AccountApi.upsert_email(upsert_email_model, uid, fields)
```
Update UID (PUT)
This API is used to update a user's Uid. It will update all profiles, custom objects and consent management logs associated with the Uid. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-update/)
```ruby
update_uid_model ={
"newUid" => ""} #Required
uid = "" #Required
response = AccountApi.account_update_uid(update_uid_model, uid)
```
Account Create (POST)
This API is used to create an account in Cloud Storage. This API bypass the normal email verification process and manually creates the user.
In order to use this API, you need to format a JSON request body with all of the mandatory fields [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-create)
```ruby
account_create_model ={
"email" => [ {
"type" => "" ,
"value" => ""
} ] ,
"firstName" => "",
"lastName" => "",
"password" => ""} #Required
fields = nil #Optional
response = AccountApi.create_account(account_create_model, fields)
```
Forgot Password token (POST)
This API Returns a Forgot Password Token it can also be used to send a Forgot Password email to the customer. Note: If you have the UserName workflow enabled, you may replace the 'email' parameter with 'username' in the body. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/get-forgot-password-token)
```ruby
email = "" #Required
email_template = "" #Optional
reset_password_url = "" #Optional
send_email = true #Optional
response = AccountApi.get_forgot_password_token(email, email_template, reset_password_url, send_email)
```
Email Verification token (POST)
This API Returns an Email Verification token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/get-email-verification-token)
```ruby
email = "" #Required
response = AccountApi.get_email_verification_token(email)
```
Get Privacy Policy History By Uid (GET)
This API is used to retrieve all of the accepted Policies by the user, associated with their UID. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/privacy-policy-history-by-uid/)
```ruby
uid = "" #Required
response = AccountApi.get_privacy_policy_history_by_uid(uid)
```
Account Profiles by Email (GET)
This API is used to retrieve all of the profile data, associated with the specified account by email in Cloud Storage. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-profiles-by-email)
```ruby
email = "" #Required
fields = nil #Optional
response = AccountApi.get_account_profile_by_email(email, fields)
```
Account Profiles by Username (GET)
This API is used to retrieve all of the profile data associated with the specified account by user name in Cloud Storage. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-profiles-by-user-name)
```ruby
user_name = "" #Required
fields = nil #Optional
response = AccountApi.get_account_profile_by_user_name(user_name, fields)
```
Account Profile by Phone ID (GET)
This API is used to retrieve all of the profile data, associated with the account by phone number in Cloud Storage. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-profiles-by-phone-id/)
```ruby
phone = "" #Required
fields = nil #Optional
response = AccountApi.get_account_profile_by_phone(phone, fields)
```
Account Profiles by UID (GET)
This API is used to retrieve all of the profile data, associated with the account by uid in Cloud Storage. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-profiles-by-uid)
```ruby
uid = "" #Required
fields = nil #Optional
response = AccountApi.get_account_profile_by_uid(uid, fields)
```
Account Password (GET)
This API use to retrive the hashed password of a specified account in Cloud Storage. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-password)
```ruby
uid = "" #Required
response = AccountApi.get_account_password_hash_by_uid(uid)
```
Access Token based on UID or User impersonation API (GET)
The API is used to get LoginRadius access token based on UID. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-impersonation-api)
```ruby
uid = "" #Required
response = AccountApi.get_access_token_by_uid(uid)
```
Refresh Access Token by Refresh Token (GET)
This API is used to refresh an access token via it's associated refresh token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/refresh-token/refresh-access-token-by-refresh-token)
```ruby
refresh_token = "" #Required
response = AccountApi.refresh_access_token_by_refresh_token(refresh_token)
```
Revoke Refresh Token (GET)
The Revoke Refresh Access Token API is used to revoke a refresh token or the Provider Access Token, revoking an existing refresh token will invalidate the refresh token but the associated access token will work until the expiry. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/refresh-token/revoke-refresh-token)
```ruby
refresh_token = "" #Required
response = AccountApi.revoke_refresh_token(refresh_token)
```
Account Identities by Email (GET)
Note: This is intended for specific workflows where an email may be associated to multiple UIDs. This API is used to retrieve all of the identities (UID and Profiles), associated with a specified email in Cloud Storage. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-identities-by-email)
```ruby
email = "" #Required
fields = nil #Optional
response = AccountApi.get_account_identities_by_email(email, fields)
```
Account Delete (DELETE)
This API deletes the Users account and allows them to re-register for a new account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-delete)
```ruby
uid = "" #Required
response = AccountApi.delete_account_by_uid(uid)
```
Account Remove Email (DELETE)
Use this API to Remove emails from a user Account [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-email-delete)
```ruby
email = "" #Required
uid = "" #Required
fields = nil #Optional
response = AccountApi.remove_email(email, uid, fields)
```
Delete User Profiles By Email (DELETE)
This API is used to delete all user profiles associated with an Email. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-email-delete/)
```ruby
email = "" #Required
response = AccountApi.account_delete_by_email(email)
```
### Social API
List of APIs in this Section:
* GET : [Access Token](#ExchangeAccessToken-get-)
* GET : [Refresh Token](#RefreshAccessToken-get-)
* GET : [Token Validate](#ValidateAccessToken-get-)
* GET : [Access Token Invalidate](#InValidateAccessToken-get-)
* GET : [Get Active Session Details](#GetActiveSession-get-)
* GET : [Get Active Session By Account Id](#GetActiveSessionByAccountID-get-)
* GET : [Get Active Session By Profile Id](#GetActiveSessionByProfileID-get-)
Access Token (GET)
This API Is used to translate the Request Token returned during authentication into an Access Token that can be used with other API calls. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/access-token)
```ruby
token = "" #Required
response = SocialApi.exchange_access_token(token)
```
Refresh Token (GET)
The Refresh Access Token API is used to refresh the provider access token after authentication. It will be valid for up to 60 days on LoginRadius depending on the provider. In order to use the access token in other APIs, always refresh the token using this API.
Supported Providers : Facebook,Yahoo,Google,Twitter, Linkedin.
Contact LoginRadius support team to enable this API. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/refresh-token/refresh-token)
```ruby
access_token = "" #Required
expires_in = 0 #Optional
is_web = true #Optional
response = SocialApi.refresh_access_token(access_token, expires_in, is_web)
```
Token Validate (GET)
This API validates access token, if valid then returns a response with its expiry otherwise error. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/validate-access-token)
```ruby
access_token = "" #Required
response = SocialApi.validate_access_token(access_token)
```
Access Token Invalidate (GET)
This api invalidates the active access token or expires an access token validity. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/invalidate-access-token)
```ruby
access_token = "" #Required
response = SocialApi.in_validate_access_token(access_token)
```
Get Active Session Details (GET)
This api is use to get all active session by Access Token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/get-active-session-details)
```ruby
token = "" #Required
response = SocialApi.get_active_session(token)
```
Get Active Session By Account Id (GET)
This api is used to get all active sessions by AccountID(UID). [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/active-session-by-account-id/)
```ruby
account_id = "" #Required
response = SocialApi.get_active_session_by_account_id(account_id)
```
Get Active Session By Profile Id (GET)
This api is used to get all active sessions by ProfileId. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/active-session-by-profile-id/)
```ruby
profile_id = "" #Required
response = SocialApi.get_active_session_by_profile_id(profile_id)
```
### CustomObject API
List of APIs in this Section:
* PUT : [Custom Object Update by Access Token](#UpdateCustomObjectByToken-put-)
* PUT : [Custom Object Update by UID](#UpdateCustomObjectByUid-put-)
* POST : [Create Custom Object by Token](#CreateCustomObjectByToken-post-)
* POST : [Create Custom Object by UID](#CreateCustomObjectByUid-post-)
* GET : [Custom Object by Token](#GetCustomObjectByToken-get-)
* GET : [Custom Object by ObjectRecordId and Token](#GetCustomObjectByRecordIDAndToken-get-)
* GET : [Custom Object By UID](#GetCustomObjectByUid-get-)
* GET : [Custom Object by ObjectRecordId and UID](#GetCustomObjectByRecordID-get-)
* DELETE : [Custom Object Delete by Record Id And Token](#DeleteCustomObjectByToken-delete-)
* DELETE : [Account Delete Custom Object by ObjectRecordId](#DeleteCustomObjectByRecordID-delete-)
Custom Object Update by Access Token (PUT)
This API is used to update the specified custom object data of the specified account. If the value of updatetype is 'replace' then it will fully replace custom object with the new custom object and if the value of updatetype is 'partialreplace' then it will perform an upsert type operation [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-update-by-objectrecordid-and-token)
```ruby
access_token = "" #Required
object_name = "" #Required
object_record_id = "" #Required
object = { "customdata1" => "Store my customdata1 value" } #Required
update_type = "" #Optional
response = CustomObjectApi.update_custom_object_by_token(access_token, object_name, object_record_id, object, update_type)
```
Custom Object Update by UID (PUT)
This API is used to update the specified custom object data of a specified account. If the value of updatetype is 'replace' then it will fully replace custom object with new custom object and if the value of updatetype is partialreplace then it will perform an upsert type operation. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-update-by-objectrecordid-and-uid)
```ruby
object_name = "" #Required
object_record_id = "" #Required
object = { "customdata1" => "Store my customdata1 value" } #Required
uid = "" #Required
update_type = "" #Optional
response = CustomObjectApi.update_custom_object_by_uid(object_name, object_record_id, object, uid, update_type)
```
Create Custom Object by Token (POST)
This API is used to write information in JSON format to the custom object for the specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/create-custom-object-by-token)
```ruby
access_token = "" #Required
object_name = "" #Required
object = { "customdata1" => "Store my customdata1 value" } #Required
response = CustomObjectApi.create_custom_object_by_token(access_token, object_name, object)
```
Create Custom Object by UID (POST)
This API is used to write information in JSON format to the custom object for the specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/create-custom-object-by-uid)
```ruby
object_name = "" #Required
object = { "customdata1" => "Store my customdata1 value" } #Required
uid = "" #Required
response = CustomObjectApi.create_custom_object_by_uid(object_name, object, uid)
```
Custom Object by Token (GET)
This API is used to retrieve the specified Custom Object data for the specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-by-token)
```ruby
access_token = "" #Required
object_name = "" #Required
response = CustomObjectApi.get_custom_object_by_token(access_token, object_name)
```
Custom Object by ObjectRecordId and Token (GET)
This API is used to retrieve the Custom Object data for the specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-by-objectrecordid-and-token)
```ruby
access_token = "" #Required
object_name = "" #Required
object_record_id = "" #Required
response = CustomObjectApi.get_custom_object_by_record_id_and_token(access_token, object_name, object_record_id)
```
Custom Object By UID (GET)
This API is used to retrieve all the custom objects by UID from cloud storage. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-by-uid)
```ruby
object_name = "" #Required
uid = "" #Required
response = CustomObjectApi.get_custom_object_by_uid(object_name, uid)
```
Custom Object by ObjectRecordId and UID (GET)
This API is used to retrieve the Custom Object data for the specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-by-objectrecordid-and-uid)
```ruby
object_name = "" #Required
object_record_id = "" #Required
uid = "" #Required
response = CustomObjectApi.get_custom_object_by_record_id(object_name, object_record_id, uid)
```
Custom Object Delete by Record Id And Token (DELETE)
This API is used to remove the specified Custom Object data using ObjectRecordId of a specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-delete-by-objectrecordid-and-token)
```ruby
access_token = "" #Required
object_name = "" #Required
object_record_id = "" #Required
response = CustomObjectApi.delete_custom_object_by_token(access_token, object_name, object_record_id)
```
Account Delete Custom Object by ObjectRecordId (DELETE)
This API is used to remove the specified Custom Object data using ObjectRecordId of specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-delete-by-objectrecordid-and-uid)
```ruby
object_name = "" #Required
object_record_id = "" #Required
uid = "" #Required
response = CustomObjectApi.delete_custom_object_by_record_id(object_name, object_record_id, uid)
```
### PhoneAuthentication API
List of APIs in this Section:
* PUT : [Phone Reset Password by OTP](#ResetPasswordByPhoneOTP-put-)
* PUT : [Phone Verification OTP](#PhoneVerificationByOTP-put-)
* PUT : [Phone Verification OTP by Token](#PhoneVerificationOTPByAccessToken-put-)
* PUT : [Phone Number Update](#UpdatePhoneNumber-put-)
* POST : [Phone Login](#LoginByPhone-post-)
* POST : [Phone Forgot Password by OTP](#ForgotPasswordByPhoneOTP-post-)
* POST : [Phone Resend Verification OTP](#PhoneResendVerificationOTP-post-)
* POST : [Phone Resend Verification OTP By Token](#PhoneResendVerificationOTPByToken-post-)
* POST : [Phone User Registration by SMS](#UserRegistrationByPhone-post-)
* GET : [Phone Number Availability](#CheckPhoneNumberAvailability-get-)
* DELETE : [Remove Phone ID by Access Token](#RemovePhoneIDByAccessToken-delete-)
Phone Reset Password by OTP (PUT)
This API is used to reset the password [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-reset-password-by-otp)
```ruby
reset_password_by_otp_model ={
"otp" => "",
"password" => "",
"phone" => ""} #Required
response = PhoneAuthenticationApi.reset_password_by_phone_otp(reset_password_by_otp_model)
```
Phone Verification OTP (PUT)
This API is used to validate the verification code sent to verify a user's phone number [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-verify-otp)
```ruby
otp = "" #Required
phone = "" #Required
fields = nil #Optional
sms_template = "" #Optional
response = PhoneAuthenticationApi.phone_verification_by_otp(otp, phone, fields, sms_template)
```
Phone Verification OTP by Token (PUT)
This API is used to consume the verification code sent to verify a user's phone number. Use this call for front-end purposes in cases where the user is already logged in by passing the user's access token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-verify-otp-by-token)
```ruby
access_token = "" #Required
otp = "" #Required
sms_template = "" #Optional
response = PhoneAuthenticationApi.phone_verification_otp_by_access_token(access_token, otp, sms_template)
```
Phone Number Update (PUT)
This API is used to update the login Phone Number of users [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-number-update)
```ruby
access_token = "" #Required
phone = "" #Required
sms_template = "" #Optional
response = PhoneAuthenticationApi.update_phone_number(access_token, phone, sms_template)
```
Phone Login (POST)
This API retrieves a copy of the user data based on the Phone [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-login)
```ruby
phone_authentication_model ={
"password" => "",
"phone" => ""} #Required
fields = nil #Optional
login_url = "" #Optional
sms_template = "" #Optional
response = PhoneAuthenticationApi.login_by_phone(phone_authentication_model, fields, login_url, sms_template)
```
Phone Forgot Password by OTP (POST)
This API is used to send the OTP to reset the account password. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-forgot-password-by-otp)
```ruby
phone = "" #Required
sms_template = "" #Optional
response = PhoneAuthenticationApi.forgot_password_by_phone_otp(phone, sms_template)
```
Phone Resend Verification OTP (POST)
This API is used to resend a verification OTP to verify a user's Phone Number. The user will receive a verification code that they will need to input [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-resend-otp)
```ruby
phone = "" #Required
sms_template = "" #Optional
response = PhoneAuthenticationApi.phone_resend_verification_otp(phone, sms_template)
```
Phone Resend Verification OTP By Token (POST)
This API is used to resend a verification OTP to verify a user's Phone Number in cases in which an active token already exists [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-resend-otp-by-token)
```ruby
access_token = "" #Required
phone = "" #Required
sms_template = "" #Optional
response = PhoneAuthenticationApi.phone_resend_verification_otp_by_token(access_token, phone, sms_template)
```
Phone User Registration by SMS (POST)
This API registers the new users into your Cloud Storage and triggers the phone verification process. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-user-registration-by-sms)
```ruby
auth_user_registration_model ={
"Email"=> [
{
"Type": "",
"Value": ""
}
],
"firstName" => "",
"lastName" => "",
"password" => "",
"phoneId" => ""
} #Required
sott = "" #Required
fields = nil #Optional
options = "" #Optional
sms_template = "" #Optional
verification_url = "" #Optional
welcome_email_template = "" #Optional
email_template = "" #Optional
response = PhoneAuthenticationApi.user_registration_by_phone(auth_user_registration_model, sott, fields, options, sms_template, verification_url, welcome_email_template, email_template)
```
Phone Number Availability (GET)
This API is used to check the Phone Number exists or not on your site. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-number-availability)
```ruby
phone = "" #Required
response = PhoneAuthenticationApi.check_phone_number_availability(phone)
```
Remove Phone ID by Access Token (DELETE)
This API is used to delete the Phone ID on a user's account via the access token [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/remove-phone-id-by-access-token)
```ruby
access_token = "" #Required
response = PhoneAuthenticationApi.remove_phone_id_by_access_token(access_token)
```
### MultiFactorAuthentication API
List of APIs in this Section:
* PUT : [Update MFA Setting](#MFAUpdateSetting-put-)
* PUT : [Update MFA by Access Token](#MFAUpdateByAccessToken-put-)
* PUT : [MFA Update Phone Number by Token](#MFAUpdatePhoneNumberByToken-put-)
* PUT : [Verify MFA Email OTP by Access Token](#MFAValidateEmailOtpByAccessToken-put-)
* PUT : [Update MFA Security Question by Access Token](#MFASecurityQuestionAnswerByAccessToken-put-)
* PUT : [MFA Validate OTP](#MFAValidateOTPByPhone-put-)
* PUT : [MFA Validate Google Auth Code](#MFAValidateGoogleAuthCode-put-)
* PUT : [MFA Validate Backup code](#MFAValidateBackupCode-put-)
* PUT : [MFA Update Phone Number](#MFAUpdatePhoneNumber-put-)
* PUT : [Verify MFA Email OTP by MFA Token](#MFAValidateEmailOtp-put-)
* PUT : [Update MFA Security Question by MFA Token](#MFASecurityQuestionAnswer-put-)
* POST : [MFA Email Login](#MFALoginByEmail-post-)
* POST : [MFA UserName Login](#MFALoginByUserName-post-)
* POST : [MFA Phone Login](#MFALoginByPhone-post-)
* POST : [Send MFA Email OTP by MFA Token](#MFAEmailOTP-post-)
* POST : [Verify MFA Security Question by MFA Token](#MFASecurityQuestionAnswerVerification-post-)
* GET : [MFA Validate Access Token](#MFAConfigureByAccessToken-get-)
* GET : [MFA Backup Code by Access Token](#MFABackupCodeByAccessToken-get-)
* GET : [Reset Backup Code by Access Token](#MFAResetBackupCodeByAccessToken-get-)
* GET : [Send MFA Email OTP by Access Token](#MFAEmailOtpByAccessToken-get-)
* GET : [MFA Resend Otp](#MFAResendOTP-get-)
* GET : [MFA Backup Code by UID](#MFABackupCodeByUid-get-)
* GET : [MFA Reset Backup Code by UID](#MFAResetBackupCodeByUid-get-)
* DELETE : [MFA Reset Google Authenticator by Token](#MFAResetGoogleAuthByToken-delete-)
* DELETE : [MFA Reset SMS Authenticator by Token](#MFAResetSMSAuthByToken-delete-)
* DELETE : [Reset MFA Email OTP Authenticator By Access Token](#MFAResetEmailOtpAuthenticatorByAccessToken-delete-)
* DELETE : [MFA Reset Security Question Authenticator By Access Token](#MFAResetSecurityQuestionAuthenticatorByAccessToken-delete-)
* DELETE : [MFA Reset SMS Authenticator By UID](#MFAResetSMSAuthenticatorByUid-delete-)
* DELETE : [MFA Reset Google Authenticator By UID](#MFAResetGoogleAuthenticatorByUid-delete-)
* DELETE : [Reset MFA Email OTP Authenticator Settings by Uid](#MFAResetEmailOtpAuthenticatorByUid-delete-)
* DELETE : [Reset MFA Security Question Authenticator Settings by Uid](#MFAResetSecurityQuestionAuthenticatorByUid-delete-)
Update MFA Setting (PUT)
This API is used to trigger the Multi-factor authentication settings after login for secure actions [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/update-mfa-setting/)
```ruby
access_token = "" #Required
multi_factor_auth_model_with_lockout ={
"otp" => ""} #Required
fields = nil #Optional
response = MultiFactorAuthenticationApi.mfa_update_setting(access_token, multi_factor_auth_model_with_lockout, fields)
```
Update MFA by Access Token (PUT)
This API is used to Enable Multi-factor authentication by access token on user login [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/google-authenticator/update-mfa-by-access-token/)
```ruby
access_token = "" #Required
multi_factor_auth_model_by_google_authenticator_code ={
"googleAuthenticatorCode" => ""} #Required
fields = nil #Optional
sms_template = "" #Optional
response = MultiFactorAuthenticationApi.mfa_update_by_access_token(access_token, multi_factor_auth_model_by_google_authenticator_code, fields, sms_template)
```
MFA Update Phone Number by Token (PUT)
This API is used to update the Multi-factor authentication phone number by sending the verification OTP to the provided phone number [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/mfa-update-phone-number-by-token/)
```ruby
access_token = "" #Required
phone_no_2fa = "" #Required
sms_template_2fa = "" #Optional
response = MultiFactorAuthenticationApi.mfa_update_phone_number_by_token(access_token, phone_no_2fa, sms_template_2fa)
```
Verify MFA Email OTP by Access Token (PUT)
This API is used to set up MFA Email OTP authenticator on profile after login. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/verify-mfa-otp-by-access-token/)
```ruby
access_token = "" #Required
multi_factor_auth_model_by_email_otp_with_lockout ={
"EmailId"=>"emailId",
"Otp"=>"otp"
} #Required
response = MultiFactorAuthenticationApi.mfa_validate_email_otp_by_access_token(access_token, multi_factor_auth_model_by_email_otp_with_lockout)
```
Update MFA Security Question by Access Token (PUT)
This API is used to set up MFA Security Question authenticator on profile after login. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/update-mfa-security-question-by-access-token)
```ruby
access_token = "" #Required
security_question_answer_model_by_access_token ={
"securityquestionanswer"=> [
{
"QuestionId"=> "db7****8a73e4******bd9****8c20",
"Answer"=> ""
}
],
"ReplaceSecurityQuestionAnswer"=>true
} #Required
response = MultiFactorAuthenticationApi.mfa_security_question_answer_by_access_token(access_token, security_question_answer_model_by_access_token)
```
MFA Validate OTP (PUT)
This API is used to login via Multi-factor authentication by passing the One Time Password received via SMS [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/mfa-validate-otp/)
```ruby
multi_factor_auth_model_with_lockout ={
"otp" => ""} #Required
second_factor_authentication_token = "" #Required
fields = nil #Optional
sms_template_2fa = "" #Optional
rba_browser_email_template = "" #Optional
rba_city_email_template = "" #Optional
rba_country_email_template = "" #Optional
rba_ip_email_template = "" #Optional
response = MultiFactorAuthenticationApi.mfa_validate_otp_by_phone(multi_factor_auth_model_with_lockout, second_factor_authentication_token, fields, sms_template_2fa, rba_browser_email_template, rba_city_email_template, rba_country_email_template, rba_ip_email_template)
```
MFA Validate Google Auth Code (PUT)
This API is used to login via Multi-factor-authentication by passing the google authenticator code. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/google-authenticator/mfa-validate-google-auth-code/)
```ruby
google_authenticator_code = "" #Required
second_factor_authentication_token = "" #Required
fields = nil #Optional
rba_browser_email_template = "" #Optional
rba_city_email_template = "" #Optional
rba_country_email_template = "" #Optional
rba_ip_email_template = "" #Optional
response = MultiFactorAuthenticationApi.mfa_validate_google_auth_code(google_authenticator_code, second_factor_authentication_token, fields, rba_browser_email_template, rba_city_email_template, rba_country_email_template, rba_ip_email_template)
```
MFA Validate Backup code (PUT)
This API is used to validate the backup code provided by the user and if valid, we return an access token allowing the user to login incases where Multi-factor authentication (MFA) is enabled and the secondary factor is unavailable. When a user initially downloads the Backup codes, We generate 10 codes, each code can only be consumed once. if any user attempts to go over the number of invalid login attempts configured in the Dashboard then the account gets blocked automatically [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/mfa-validate-backup-code/)
```ruby
multi_factor_auth_model_by_backup_code ={
"backupCode" => ""} #Required
second_factor_authentication_token = "" #Required
fields = nil #Optional
rba_browser_email_template = "" #Optional
rba_city_email_template = "" #Optional
rba_country_email_template = "