LoginRadius Ruby SDK

Home Image

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 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:

 gem "login_radius", :path => "gemfilepath";

Or

 gem 'login_radius', '= 10.0.0.pre.beta'

And then execute:

 $ bundle

Or install it yourself as:

 $ gem install login_radius --pre

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:

SITE_NAME: "<site name>"
API_KEY: "<api-key>"
API_SECRET: "<api-secret>"
CUSTOM_API_DOMAIN: "<custom-domain-url-if-any>"
API_REQUEST_SIGNING: "false"

2)After define the configuration key details, its corresponding module must first be instantiated:

Create login_radius.rb in /config/initializers:

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
::CustomRegistrationDataApi = LoginRadius::CustomRegistrationDataApi.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:

Auth Update Profile by Token (PUT)

This API is used to update the user's profile by passing the access token. More Info


 access_token = "<access_token>" #Required

  ={ 
"firstName" => "<firstName>",
"lastName" => "<lastName>"}  #Required
 email_template = "<email_template>" #Optional
 fields = nil #Optional
 null_support = true #Optional
 sms_template = "<sms_template>" #Optional
 verification_url = "<verification_url>" #Optional

response = AuthenticationApi.update_profile_by_access_token(access_token, , 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


 access_token = "<access_token>" #Required

 unlock_profile_model ={ 
"g-recaptcha-response" => "<g-recaptcha-response>"}  #Required

response = AuthenticationApi.(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



 email_verification_by_otp_model ={ 
"email" => "<email>",
"otp" => "<otp>"}  #Required
 fields = nil #Optional
 url = "<url>" #Optional
 welcome_email_template = "<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



 reset_password_by_security_answer_and_email_model ={ 
"email" => "<email>",
"password" => "<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



 reset_password_by_security_answer_and_phone_model ={ 
"password" => "<password>",
"phone" => "<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



 reset_password_by_security_answer_and_user_name_model ={ 
"password" => "<password>",
"securityAnswer" => {"QuestionID"=>"Answer"},
"userName" => "<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



 reset_password_by_reset_token_model ={ 
"password" => "<password>",
"resetToken" => "<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



 reset_password_by_email_and_otp_model ={ 
"email" => "<email>",
"otp" => "<otp>",
"password" => "<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



 reset_password_by_user_name_model ={ 
"otp" => "<otp>",
"password" => "<password>",
"userName" => "<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


 access_token = "<access_token>" #Required
 new_password = "<new_password>" #Required
 old_password = "<old_password>" #Required

response = AuthenticationApi.change_password(access_token, new_password, old_password)

Auth Link Social Identities (PUT)

This API is used to link up a social provider account with the specified account based on the access token and the social providers user access token. More Info


 access_token = "<access_token>" #Required
 candidate_token = "<candidate_token>" #Required

response = AuthenticationApi.link_social_identities(access_token, candidate_token)

Auth Set or Change UserName (PUT)

This API is used to set or change UserName by access token. More Info


 access_token = "<access_token>" #Required
 username = "<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


 email = "<email>" #Required
 email_template = "<email_template>" #Optional
 verification_url = "<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


 access_token = "<access_token>" #Required
 email = "<email>" #Required
 type = "<type>" #Required
 email_template = "<email_template>" #Optional
 verification_url = "<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



 email_authentication_model ={ 
"email" => "<email>",
"password" => "<password>"}  #Required
 email_template = "<email_template>" #Optional
 fields = nil #Optional
  = "<login_url>" #Optional
 verification_url = "<verification_url>" #Optional

response = AuthenticationApi.(email_authentication_model, email_template, fields, , verification_url)

Auth Login by Username (POST)

This API retrieves a copy of the user data based on the Username More Info



 user_name_authentication_model ={ 
"password" => "<password>",
"username" => "<username>"}  #Required
 email_template = "<email_template>" #Optional
 fields = nil #Optional
  = "<login_url>" #Optional
 verification_url = "<verification_url>" #Optional

response = AuthenticationApi.(user_name_authentication_model, email_template, fields, , 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


 email = "<email>" #Required
 reset_password_url = "<reset_password_url>" #Required
 email_template = "<email_template>" #Optional

response = AuthenticationApi.forgot_password(email, reset_password_url, email_template)

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



 auth_user_registration_model ={ 
"email" => [   { 
 "type" => "<type>"  ,
 "value" => "<value>"   
}  ] ,
"firstName" => "<firstName>",
"lastName" => "<lastName>",
"password" => "<password>"}  #Required
 sott = "<sott>" #Required
 email_template = "<email_template>" #Optional
 fields = nil #Optional
 options = "<options>" #Optional
 verification_url = "<verification_url>" #Optional
 welcome_email_template = "<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



 auth_user_registration_model_with_captcha ={ 
"email" => [   { 
 "type" => "<type>"  ,
 "value" => "<value>"   
}  ] ,
"firstName" => "<firstName>",
"g-recaptcha-response" => "<g-recaptcha-response>",
"lastName" => "<lastName>",
"password" => "<password>"}  #Required
 email_template = "<email_template>" #Optional
 fields = nil #Optional
 options = "<options>" #Optional
 sms_template = "<sms_template>" #Optional
 verification_url = "<verification_url>" #Optional
 welcome_email_template = "<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


 email = "<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


 user_name = "<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


 phone = "<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


 access_token = "<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


 access_token = "<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


 access_token = "<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


 access_token = "<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


 access_token = "<access_token>" #Required
 fields = nil #Optional

response = AuthenticationApi.get_profile_by_access_token(access_token, fields)

Auth Send Welcome Email (GET)

This API sends a welcome email More Info


 access_token = "<access_token>" #Required
 welcome_email_template = "<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


 deletetoken = "<deletetoken>" #Required

response = AuthenticationApi.(deletetoken)

Auth Check Email Availability (GET)

This API is used to check the email exists or not on your site. More Info


 email = "<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


 verification_token = "<verification_token>" #Required
 fields = nil #Optional
 url = "<url>" #Optional
 welcome_email_template = "<welcome_email_template>" #Optional

response = AuthenticationApi.verify_email(verification_token, fields, url, welcome_email_template)

Auth Social Identity (GET)

This API is called just after account linking API and it prevents the raas profile of the second account from getting created. More Info


 access_token = "<access_token>" #Required
 fields = nil #Optional

response = AuthenticationApi.get_social_identity(access_token, fields)

Auth Check UserName Availability (GET)

This API is used to check the UserName exists or not on your site. More Info


 username = "<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


 access_token = "<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


 access_token = "<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


 access_token = "<access_token>" #Required
 delete_url = "<delete_url>" #Optional
 email_template = "<email_template>" #Optional

response = AuthenticationApi.(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


 access_token = "<access_token>" #Required
 email = "<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


 access_token = "<access_token>" #Required
 provider = "<provider>" #Required
 provider_id = "<provider_id>" #Required

response = AuthenticationApi.unlink_social_identities(access_token, provider, provider_id)

Account API

List of APIs in this Section:

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



  ={ 
"firstName" => "<firstName>",
"lastName" => "<lastName>"}  #Required
 uid = "<uid>" #Required
 fields = nil #Optional
 null_support = true #Optional

response = AccountApi.(, 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


 phone = "<phone>" #Required
 uid = "<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


 password = "<password>" #Required
 uid = "<uid>" #Required

response = AccountApi.(password, uid)

Account Invalidate Verification Email (PUT)

This API is used to invalidate the Email Verification status on an account. More Info


 uid = "<uid>" #Required
 email_template = "<email_template>" #Optional
 verification_url = "<verification_url>" #Optional

response = AccountApi.(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


 uid = "<uid>" #Required
 sms_template = "<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



 upsert_email_model ={ 
"email" => [   { 
 "type" => "<type>"  ,
 "value" => "<value>"   
}  ] }  #Required
 uid = "<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



 update_uid_model ={ 
"newUid" => "<newUid>"}  #Required
 uid = "<uid>" #Required

response = AccountApi.(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



  ={ 
"email" => [   { 
 "type" => "<type>"  ,
 "value" => "<value>"   
}  ] ,
"firstName" => "<firstName>",
"lastName" => "<lastName>",
"password" => "<password>"}  #Required
 fields = nil #Optional

response = AccountApi.(, 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


 email = "<email>" #Required
 email_template = "<email_template>" #Optional
 reset_password_url = "<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


 email = "<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


 uid = "<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


 email = "<email>" #Required
 fields = nil #Optional

response = AccountApi.(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


 user_name = "<user_name>" #Required
 fields = nil #Optional

response = AccountApi.(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


 phone = "<phone>" #Required
 fields = nil #Optional

response = AccountApi.(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


 uid = "<uid>" #Required
 fields = nil #Optional

response = AccountApi.(uid, fields)

Account Password (GET)

This API use to retrive the hashed password of a specified account in Cloud Storage. More Info


 uid = "<uid>" #Required

response = AccountApi.(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


 uid = "<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


 refresh_token = "<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


 refresh_token = "<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


 email = "<email>" #Required
 fields = nil #Optional

response = AccountApi.(email, fields)

Account Delete (DELETE)

This API deletes the Users account and allows them to re-register for a new account. More Info


 uid = "<uid>" #Required

response = AccountApi.(uid)

Account Remove Email (DELETE)

Use this API to Remove emails from a user Account More Info


 email = "<email>" #Required
 uid = "<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


 email = "<email>" #Required

response = AccountApi.(email)

Social API

List of APIs in this Section:

Post Message API (POST)

Post Message API is used to post messages to the user's contacts.

Supported Providers: Twitter, LinkedIn

The Message API is used to post messages to the user?s contacts. This is one of the APIs that makes up the LoginRadius Friend Invite System. After using the Contact API, you can send messages to the retrieved contacts. This API requires setting permissions in your LoginRadius Dashboard.

GET & POST Message API work the same way except the API method is different More Info


 access_token = "<access_token>" #Required
 message = "<message>" #Required
 subject = "<subject>" #Required
 to = "<to>" #Required

response = SocialApi.post_message(access_token, message, subject, to)

Status Posting (POST)

The Status API is used to update the status on the user's wall.

Supported Providers: Facebook, Twitter, LinkedIn More Info


 access_token = "<access_token>" #Required
 caption = "<caption>" #Required
 description = "<description>" #Required
 imageurl = "<imageurl>" #Required
 status = "<status>" #Required
 title = "<title>" #Required
 url = "<url>" #Required
 shorturl = "<shorturl>" #Optional

response = SocialApi.status_posting(access_token, caption, description, imageurl, status, title, url, shorturl)

Trackable Status Posting (POST)

The Trackable status API works very similar to the Status API but it returns a Post id that you can use to track the stats(shares, likes, comments) for a specific share/post/status update. This API requires setting permissions in your LoginRadius Dashboard.

The Trackable Status API is used to update the status on the user's wall and return an Post ID value. It is commonly referred to as Permission based sharing or Push notifications.

POST Input Parameter Format: application/x-www-form-urlencoded More Info


 access_token = "<access_token>" #Required

 status_model ={ 
"caption" => "<caption>",
"description" => "<description>",
"imageurl" => "<imageurl>",
"status" => "<status>",
"title" => "<title>",
"url" => "<url>"}  #Required

response = SocialApi.trackable_status_posting(access_token, status_model)

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


 token = "<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


 access_token = "<access_token>" #Required
 expires_in = 0 #Optional

response = SocialApi.refresh_access_token(access_token, expires_in)

Token Validate (GET)

This API validates access token, if valid then returns a response with its expiry otherwise error. More Info


 access_token = "<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


 access_token = "<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


 token = "<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


  = "<account_id>" #Required

response = SocialApi.()

Get Active Session By Profile Id (GET)

This api is used to get all active sessions by ProfileId. More Info


 profile_id = "<profile_id>" #Required

response = SocialApi.get_active_session_by_profile_id(profile_id)

Album (GET)

Supported Providers: Facebook, Google, Live, Vkontakte.

This API returns the photo albums associated with the passed in access tokens Social Profile. More Info


 access_token = "<access_token>" #Required

response = SocialApi.get_albums(access_token)

Get Albums with cursor (GET)

Supported Providers: Facebook, Google, Live, Vkontakte.

This API returns the photo albums associated with the passed in access tokens Social Profile. More Info


 access_token = "<access_token>" #Required
 next_cursor = "<next_cursor>" #Required

response = SocialApi.get_albums_with_cursor(access_token, next_cursor)

Audio (GET)

The Audio API is used to get audio files data from the user's social account.

Supported Providers: Live, Vkontakte More Info


 access_token = "<access_token>" #Required

response = SocialApi.get_audios(access_token)

Get Audio With Cursor (GET)

The Audio API is used to get audio files data from the user's social account.

Supported Providers: Live, Vkontakte More Info


 access_token = "<access_token>" #Required
 next_cursor = "<next_cursor>" #Required

response = SocialApi.get_audios_with_cursor(access_token, next_cursor)

Check In (GET)

The Check In API is used to get check Ins data from the user's social account.

Supported Providers: Facebook, Foursquare, Vkontakte More Info


 access_token = "<access_token>" #Required

response = SocialApi.get_check_ins(access_token)

Get CheckIns With Cursor (GET)

The Check In API is used to get check Ins data from the user's social account.

Supported Providers: Facebook, Foursquare, Vkontakte More Info


 access_token = "<access_token>" #Required
 next_cursor = "<next_cursor>" #Required

response = SocialApi.get_check_ins_with_cursor(access_token, next_cursor)

Contact (GET)

The Contact API is used to get contacts/friends/connections data from the user's social account.This is one of the APIs that makes up the LoginRadius Friend Invite System. The data will normalized into LoginRadius' standard data format. This API requires setting permissions in your LoginRadius Dashboard.

Note: Facebook restricts access to the list of friends that is returned. When using the Contacts API with Facebook you will only receive friends that have accepted some permissions with your app.

Supported Providers: Facebook, Foursquare, Google, LinkedIn, Live, Twitter, Vkontakte, Yahoo More Info


 access_token = "<access_token>" #Required
 next_cursor = "<next_cursor>" #Optional

response = SocialApi.get_contacts(access_token, next_cursor)

Event (GET)

The Event API is used to get the event data from the user's social account.

Supported Providers: Facebook, Live More Info


 access_token = "<access_token>" #Required

response = SocialApi.get_events(access_token)

Get Events With Cursor (GET)

The Event API is used to get the event data from the user's social account.

Supported Providers: Facebook, Live More Info


 access_token = "<access_token>" #Required
 next_cursor = "<next_cursor>" #Required

response = SocialApi.get_events_with_cursor(access_token, next_cursor)

Following (GET)

Get the following user list from the user's social account.

Supported Providers: Twitter More Info


 access_token = "<access_token>" #Required

response = SocialApi.get_followings(access_token)

Get Followings With Cursor (GET)

Get the following user list from the user's social account.

Supported Providers: Twitter More Info


 access_token = "<access_token>" #Required
 next_cursor = "<next_cursor>" #Required

response = SocialApi.get_followings_with_cursor(access_token, next_cursor)

Group (GET)

The Group API is used to get group data from the user's social account.

Supported Providers: Facebook, Vkontakte More Info


 access_token = "<access_token>" #Required

response = SocialApi.get_groups(access_token)

Get Groups With Cursor (GET)

The Group API is used to get group data from the user's social account.

Supported Providers: Facebook, Vkontakte More Info


 access_token = "<access_token>" #Required
 next_cursor = "<next_cursor>" #Required

response = SocialApi.get_groups_with_cursor(access_token, next_cursor)

Like (GET)

The Like API is used to get likes data from the user's social account.

Supported Providers: Facebook More Info


 access_token = "<access_token>" #Required

response = SocialApi.get_likes(access_token)

Get Likes With Cursor (GET)

The Like API is used to get likes data from the user's social account.

Supported Providers: Facebook More Info


 access_token = "<access_token>" #Required
 next_cursor = "<next_cursor>" #Required

response = SocialApi.get_likes_with_cursor(access_token, next_cursor)

Mention (GET)

The Mention API is used to get mentions data from the user's social account.

Supported Providers: Twitter More Info


 access_token = "<access_token>" #Required

response = SocialApi.get_mentions(access_token)

Page (GET)

The Page API is used to get the page data from the user's social account.

Supported Providers: Facebook, LinkedIn More Info


 access_token = "<access_token>" #Required
 page_name = "<page_name>" #Required

response = SocialApi.get_page(access_token, page_name)

Photo (GET)

The Photo API is used to get photo data from the user's social account.

Supported Providers: Facebook, Foursquare, Google, Live, Vkontakte More Info


 access_token = "<access_token>" #Required
 album_id = "<album_id>" #Required

response = SocialApi.get_photos(access_token, album_id)

Get Post (GET)

The Post API is used to get post message data from the user's social account.

Supported Providers: Facebook More Info


 access_token = "<access_token>" #Required

response = SocialApi.get_posts(access_token)

Get Trackable Status Stats (GET)

The Trackable status API works very similar to the Status API but it returns a Post id that you can use to track the stats(shares, likes, comments) for a specific share/post/status update. This API requires setting permissions in your LoginRadius Dashboard.

The Trackable Status API is used to update the status on the user's wall and return an Post ID value. It is commonly referred to as Permission based sharing or Push notifications. More Info


 access_token = "<access_token>" #Required
 caption = "<caption>" #Required
 description = "<description>" #Required
 imageurl = "<imageurl>" #Required
 status = "<status>" #Required
 title = "<title>" #Required
 url = "<url>" #Required

response = SocialApi.get_trackable_status_stats(access_token, caption, description, imageurl, status, title, url)

Trackable Status Fetching (GET)

The Trackable status API works very similar to the Status API but it returns a Post id that you can use to track the stats(shares, likes, comments) for a specific share/post/status update. This API requires setting permissions in your LoginRadius Dashboard.

This API is used to retrieve a tracked post based on the passed in post ID value. This API requires setting permissions in your LoginRadius Dashboard.

Note: To utilize this API you need to find the ID for the post you want to track, which might require using Trackable Status Posting API first. More Info


 post_id = "<post_id>" #Required

response = SocialApi.trackable_status_fetching(post_id)

User Profile (GET)

The User Profile API is used to get social profile data from the user's social account after authentication.

Supported Providers: All More Info


 access_token = "<access_token>" #Required
 fields = nil #Optional

response = SocialApi.(access_token, fields)

Refresh User Profile (GET)

The User Profile API is used to get the latest updated social profile data from the user's social account after authentication. The social profile will be retrieved via oAuth and OpenID protocols. The data is normalized into LoginRadius' standard data format. This API should be called using the access token retrieved from the refresh access token API. More Info


 access_token = "<access_token>" #Required
 fields = nil #Optional

response = SocialApi.(access_token, fields)

Video (GET)

The Video API is used to get video files data from the user's social account.

Supported Providers: Facebook, Google, Live, Vkontakte More Info


 access_token = "<access_token>" #Required
 next_cursor = "<next_cursor>" #Required

response = SocialApi.get_videos(access_token, next_cursor)

CustomObject API

List of APIs in this Section:

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


 access_token = "<access_token>" #Required
 object_name = "<object_name>" #Required
 object_record_id = "<object_record_id>" #Required

 object = { "customdata1" => "Store my customdata1 value" }  #Required
 update_type = "<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


 object_name = "<object_name>" #Required
 object_record_id = "<object_record_id>" #Required

 object = { "customdata1" => "Store my customdata1 value" }  #Required
 uid = "<uid>" #Required
 update_type = "<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


 access_token = "<access_token>" #Required
 object_name = "<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


 object_name = "<object_name>" #Required

 object = { "customdata1" => "Store my customdata1 value" }  #Required
 uid = "<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


 access_token = "<access_token>" #Required
 object_name = "<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


 access_token = "<access_token>" #Required
 object_name = "<object_name>" #Required
 object_record_id = "<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


 object_name = "<object_name>" #Required
 uid = "<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


 object_name = "<object_name>" #Required
 object_record_id = "<object_record_id>" #Required
 uid = "<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


 access_token = "<access_token>" #Required
 object_name = "<object_name>" #Required
 object_record_id = "<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


 object_name = "<object_name>" #Required
 object_record_id = "<object_record_id>" #Required
 uid = "<uid>" #Required

response = CustomObjectApi.delete_custom_object_by_record_id(object_name, object_record_id, uid)

PhoneAuthentication API

List of APIs in this Section:

Phone Reset Password by OTP (PUT)

This API is used to reset the password More Info



 reset_password_by_otp_model ={ 
"otp" => "<otp>",
"password" => "<password>",
"phone" => "<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


 otp = "<otp>" #Required
 phone = "<phone>" #Required
 fields = nil #Optional
 sms_template = "<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


 access_token = "<access_token>" #Required
 otp = "<otp>" #Required
 sms_template = "<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


 access_token = "<access_token>" #Required
 phone = "<phone>" #Required
 sms_template = "<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



 phone_authentication_model ={ 
"password" => "<password>",
"phone" => "<phone>"}  #Required
 fields = nil #Optional
  = "<login_url>" #Optional
 sms_template = "<sms_template>" #Optional

response = PhoneAuthenticationApi.(phone_authentication_model, fields, , sms_template)

Phone Forgot Password by OTP (POST)

This API is used to send the OTP to reset the account password. More Info


 phone = "<phone>" #Required
 sms_template = "<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


 phone = "<phone>" #Required
 sms_template = "<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


 access_token = "<access_token>" #Required
 phone = "<phone>" #Required
 sms_template = "<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



 auth_user_registration_model ={ 
"firstName" => "<firstName>",
"lastName" => "<lastName>",
"password" => "<password>",
"phoneId" => "<phoneId>"}  #Required
 sott = "<sott>" #Required
 fields = nil #Optional
 options = "<options>" #Optional
 sms_template = "<sms_template>" #Optional
 verification_url = "<verification_url>" #Optional
 welcome_email_template = "<welcome_email_template>" #Optional

response = PhoneAuthenticationApi.user_registration_by_phone(auth_user_registration_model, sott, fields, options, sms_template, verification_url, welcome_email_template)

Phone Number Availability (GET)

This API is used to check the Phone Number exists or not on your site. More Info


 phone = "<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


 access_token = "<access_token>" #Required

response = PhoneAuthenticationApi.remove_phone_id_by_access_token(access_token)

MultiFactorAuthentication API

List of APIs in this Section:

Update MFA Setting (PUT)

This API is used to trigger the Multi-factor authentication settings after login for secure actions More Info


 access_token = "<access_token>" #Required

 multi_factor_auth_model_with_lockout ={ 
"otp" => "<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


 access_token = "<access_token>" #Required

 multi_factor_auth_model_by_google_authenticator_code ={ 
"googleAuthenticatorCode" => "<googleAuthenticatorCode>"}  #Required
 fields = nil #Optional
 sms_template = "<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


 access_token = "<access_token>" #Required
 phone_no_2fa = "<phone_no_2fa>" #Required
 sms_template_2fa = "<sms_template_2fa>" #Optional

response = MultiFactorAuthenticationApi.mfa_update_phone_number_by_token(access_token, phone_no_2fa, sms_template_2fa)

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



 multi_factor_auth_model_with_lockout ={ 
"otp" => "<otp>"}  #Required
 second_factor_authentication_token = "<second_factor_authentication_token>" #Required
 fields = nil #Optional
 sms_template_2fa = "<sms_template_2fa>" #Optional

response = MultiFactorAuthenticationApi.mfa_validate_otp_by_phone(multi_factor_auth_model_with_lockout, second_factor_authentication_token, fields, sms_template_2fa)

MFA Validate Google Auth Code (PUT)

This API is used to login via Multi-factor-authentication by passing the google authenticator code. More Info


 google_authenticator_code = "<google_authenticator_code>" #Required
 second_factor_authentication_token = "<second_factor_authentication_token>" #Required
 fields = nil #Optional
 sms_template_2fa = "<sms_template_2fa>" #Optional

response = MultiFactorAuthenticationApi.mfa_validate_google_auth_code(google_authenticator_code, second_factor_authentication_token, fields, sms_template_2fa)

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



 multi_factor_auth_model_by_backup_code ={ 
"backupCode" => "<backupCode>"}  #Required
 second_factor_authentication_token = "<second_factor_authentication_token>" #Required
 fields = nil #Optional

response = MultiFactorAuthenticationApi.mfa_validate_backup_code(multi_factor_auth_model_by_backup_code, second_factor_authentication_token, fields)

MFA Update Phone Number (PUT)

This API is used to update (if configured) the phone number used for Multi-factor authentication by sending the verification OTP to the provided phone number More Info


 phone_no_2fa = "<phone_no_2fa>" #Required
 second_factor_authentication_token = "<second_factor_authentication_token>" #Required
 sms_template_2fa = "<sms_template_2fa>" #Optional

response = MultiFactorAuthenticationApi.mfa_update_phone_number(phone_no_2fa, second_factor_authentication_token, sms_template_2fa)

MFA Email Login (POST)

This API can be used to login by emailid on a Multi-factor authentication enabled LoginRadius site. More Info


 email = "<email>" #Required
 password = "<password>" #Required
 email_template = "<email_template>" #Optional
 fields = nil #Optional
  = "<login_url>" #Optional
 sms_template = "<sms_template>" #Optional
 sms_template_2fa = "<sms_template_2fa>" #Optional
 verification_url = "<verification_url>" #Optional

response = MultiFactorAuthenticationApi.(email, password, email_template, fields, , sms_template, sms_template_2fa, verification_url)

MFA UserName Login (POST)

This API can be used to login by username on a Multi-factor authentication enabled LoginRadius site. More Info


 password = "<password>" #Required
 username = "<username>" #Required
 email_template = "<email_template>" #Optional
 fields = nil #Optional
  = "<login_url>" #Optional
 sms_template = "<sms_template>" #Optional
 sms_template_2fa = "<sms_template_2fa>" #Optional
 verification_url = "<verification_url>" #Optional

response = MultiFactorAuthenticationApi.(password, username, email_template, fields, , sms_template, sms_template_2fa, verification_url)

MFA Phone Login (POST)

This API can be used to login by Phone on a Multi-factor authentication enabled LoginRadius site. More Info


 password = "<password>" #Required
 phone = "<phone>" #Required
 email_template = "<email_template>" #Optional
 fields = nil #Optional
  = "<login_url>" #Optional
 sms_template = "<sms_template>" #Optional
 sms_template_2fa = "<sms_template_2fa>" #Optional
 verification_url = "<verification_url>" #Optional

response = MultiFactorAuthenticationApi.(password, phone, email_template, fields, , sms_template, sms_template_2fa, verification_url)

MFA Validate Access Token (GET)

This API is used to configure the Multi-factor authentication after login by using the access token when MFA is set as optional on the LoginRadius site. More Info


 access_token = "<access_token>" #Required
 sms_template_2fa = "<sms_template_2fa>" #Optional

response = MultiFactorAuthenticationApi.mfa_configure_by_access_token(access_token, sms_template_2fa)

MFA Backup Code by Access Token (GET)

This API is used to get a set of backup codes via access token to allow the user login on a site that has Multi-factor Authentication enabled in the event that the user does not have a secondary factor available. 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


 access_token = "<access_token>" #Required

response = MultiFactorAuthenticationApi.mfa_backup_code_by_access_token(access_token)

Reset Backup Code by Access Token (GET)

API is used to reset the backup codes on a given account via the access token. This API call will generate 10 new codes, each code can only be consumed once More Info


 access_token = "<access_token>" #Required

response = MultiFactorAuthenticationApi.mfa_reset_backup_code_by_access_token(access_token)

MFA Resend Otp (GET)

This API is used to resending the verification OTP to the provided phone number More Info


 second_factor_authentication_token = "<second_factor_authentication_token>" #Required
 sms_template_2fa = "<sms_template_2fa>" #Optional

response = MultiFactorAuthenticationApi.mfa_resend_otp(second_factor_authentication_token, sms_template_2fa)

MFA Backup Code by UID (GET)

This API is used to reset the backup codes on a given account via the UID. This API call will generate 10 new codes, each code can only be consumed once. More Info


 uid = "<uid>" #Required

response = MultiFactorAuthenticationApi.mfa_backup_code_by_uid(uid)

MFA Reset Backup Code by UID (GET)

This API is used to reset the backup codes on a given account via the UID. This API call will generate 10 new codes, each code can only be consumed once. More Info


 uid = "<uid>" #Required

response = MultiFactorAuthenticationApi.mfa_reset_backup_code_by_uid(uid)

MFA Reset Google Authenticator by Token (DELETE)

This API Resets the Google Authenticator configurations on a given account via the access token More Info


 access_token = "<access_token>" #Required
 googleauthenticator = true #Required

response = MultiFactorAuthenticationApi.mfa_reset_google_auth_by_token(access_token, googleauthenticator)

MFA Reset SMS Authenticator by Token (DELETE)

This API resets the SMS Authenticator configurations on a given account via the access token. More Info


 access_token = "<access_token>" #Required
 otpauthenticator = true #Required

response = MultiFactorAuthenticationApi.mfa_reset_sms_auth_by_token(access_token, otpauthenticator)

MFA Reset SMS Authenticator By UID (DELETE)

This API resets the SMS Authenticator configurations on a given account via the UID. More Info


 otpauthenticator = true #Required
 uid = "<uid>" #Required

response = MultiFactorAuthenticationApi.mfa_reset_sms_authenticator_by_uid(otpauthenticator, uid)

MFA Reset Google Authenticator By UID (DELETE)

This API resets the Google Authenticator configurations on a given account via the UID. More Info


 googleauthenticator = true #Required
 uid = "<uid>" #Required

response = MultiFactorAuthenticationApi.mfa_reset_google_authenticator_by_uid(googleauthenticator, uid)

PINAuthentication API

List of APIs in this Section:

Reset PIN By ResetToken (PUT)

This API is used to reset pin using reset token. More Info



 reset_pin_by_reset_token ={ 
"pin" => "<pin>",
"resetToken" => "<resetToken>"}  #Required

response = PINAuthenticationApi.reset_pin_by_reset_token(reset_pin_by_reset_token)

Reset PIN By SecurityAnswer And Email (PUT)

This API is used to reset pin using security question answer and email. More Info



 reset_pin_by_security_question_answer_and_email_model ={ 
"email" => "<email>",
"pin" => "<pin>",
"securityAnswer" => {"QuestionID"=>"Answer"}}  #Required

response = PINAuthenticationApi.reset_pin_by_email_and_security_answer(reset_pin_by_security_question_answer_and_email_model)

Reset PIN By SecurityAnswer And Username (PUT)

This API is used to reset pin using security question answer and username. More Info



 reset_pin_by_security_question_answer_and_username_model ={ 
"pin" => "<pin>",
"securityAnswer" => {"QuestionID"=>"Answer"},
"username" => "<username>"}  #Required

response = PINAuthenticationApi.reset_pin_by_username_and_security_answer(reset_pin_by_security_question_answer_and_username_model)

Reset PIN By SecurityAnswer And Phone (PUT)

This API is used to reset pin using security question answer and phone. More Info



 reset_pin_by_security_question_answer_and_phone_model ={ 
"phone" => "<phone>",
"pin" => "<pin>",
"securityAnswer" => {"QuestionID"=>"Answer"}}  #Required

response = PINAuthenticationApi.reset_pin_by_phone_and_security_answer(reset_pin_by_security_question_answer_and_phone_model)

Change PIN By Token (PUT)

This API is used to change a user's PIN using access token. More Info


 access_token = "<access_token>" #Required

 change_pin_model ={ 
"newPIN" => "<newPIN>",
"oldPIN" => "<oldPIN>"}  #Required

response = PINAuthenticationApi.change_pin_by_access_token(access_token, change_pin_model)

Reset PIN by Phone and OTP (PUT)

This API is used to reset pin using phoneId and OTP. More Info



 reset_pin_by_phone_and_otp_model ={ 
"otp" => "<otp>",
"phone" => "<phone>",
"pin" => "<pin>"}  #Required

response = PINAuthenticationApi.reset_pin_by_phone_and_otp(reset_pin_by_phone_and_otp_model)

Reset PIN by Email and OTP (PUT)

This API is used to reset pin using email and OTP. More Info



 reset_pin_by_email_and_otp_model ={ 
"email" => "<email>",
"otp" => "<otp>",
"pin" => "<pin>"}  #Required

response = PINAuthenticationApi.reset_pin_by_email_and_otp(reset_pin_by_email_and_otp_model)

Reset PIN by Username and OTP (PUT)

This API is used to reset pin using username and OTP. More Info



 reset_pin_by_username_and_otp_model ={ 
"otp" => "<otp>",
"pin" => "<pin>",
"username" => "<username>"}  #Required

response = PINAuthenticationApi.reset_pin_by_username_and_otp(reset_pin_by_username_and_otp_model)

PIN Login (POST)

This API is used to login a user by pin and session token. More Info



  ={ 
"pin" => "<pin>"}  #Required
 session_token = "<session_token>" #Required

response = PINAuthenticationApi.(, session_token)

Forgot PIN By Email (POST)

This API sends the reset pin email to specified email address. More Info



 forgot_pin_link_by_email_model ={ 
"email" => "<email>"}  #Required
 email_template = "<email_template>" #Optional
 reset_pin_url = "<reset_pin_url>" #Optional

response = PINAuthenticationApi.send_forgot_pin_email_by_email(forgot_pin_link_by_email_model, email_template, reset_pin_url)

Forgot PIN By UserName (POST)

This API sends the reset pin email using username. More Info



 forgot_pin_link_by_user_name_model ={ 
"userName" => "<userName>"}  #Required
 email_template = "<email_template>" #Optional
 reset_pin_url = "<reset_pin_url>" #Optional

response = PINAuthenticationApi.send_forgot_pin_email_by_username(forgot_pin_link_by_user_name_model, email_template, reset_pin_url)

Forgot PIN By Phone (POST)

This API sends the OTP to specified phone number More Info



 forgot_pin_otp_by_phone_model ={ 
"phone" => "<phone>"}  #Required
 sms_template = "<sms_template>" #Optional

response = PINAuthenticationApi.send_forgot_pin_sms_by_phone(forgot_pin_otp_by_phone_model, sms_template)

Set PIN By PinAuthToken (POST)

This API is used to change a user's PIN using Pin Auth token. More Info



 pin_required_model ={ 
"pin" => "<pin>"}  #Required
 pin_auth_token = "<pin_auth_token>" #Required

response = PINAuthenticationApi.set_pin_by_pin_auth_token(pin_required_model, pin_auth_token)

Invalidate PIN Session Token (GET)

This API is used to invalidate pin session token. More Info


 session_token = "<session_token>" #Required

response = PINAuthenticationApi.in_validate_pin_session_token(session_token)

ReAuthentication API

List of APIs in this Section:

Validate MFA by OTP (PUT)

This API is used to re-authenticate via Multi-factor authentication by passing the One Time Password received via SMS More Info


 access_token = "<access_token>" #Required

 reauth_by_otp_model ={ 
"otp" => "<otp>"}  #Required

response = ReAuthenticationApi.mfa_re_authenticate_by_otp(access_token, reauth_by_otp_model)

Validate MFA by Backup Code (PUT)

This API is used to re-authenticate by set of backup codes via access token on the site that has Multi-factor authentication enabled in re-authentication for the user that does not have the device More Info


 access_token = "<access_token>" #Required

 reauth_by_backup_code_model ={ 
"backupCode" => "<backupCode>"}  #Required

response = ReAuthenticationApi.mfa_re_authenticate_by_backup_code(access_token, reauth_by_backup_code_model)

Validate MFA by Google Authenticator Code (PUT)

This API is used to re-authenticate via Multi-factor-authentication by passing the google authenticator code More Info


 access_token = "<access_token>" #Required

 reauth_by_google_authenticator_code_model ={ 
"googleAuthenticatorCode" => "<googleAuthenticatorCode>"}  #Required

response = ReAuthenticationApi.mfa_re_authenticate_by_google_auth(access_token, reauth_by_google_authenticator_code_model)

Validate MFA by Password (PUT)

This API is used to re-authenticate via Multi-factor-authentication by passing the password More Info


 access_token = "<access_token>" #Required

 password_event_based_auth_model_with_lockout ={ 
"password" => "<password>"}  #Required
 sms_template_2fa = "<sms_template_2fa>" #Optional

response = ReAuthenticationApi.mfa_re_authenticate_by_password(access_token, password_event_based_auth_model_with_lockout, sms_template_2fa)

MFA Re-authentication by PIN (PUT)

This API is used to validate the triggered MFA authentication flow with a password. More Info


 access_token = "<access_token>" #Required

 pin_auth_event_based_auth_model_with_lockout ={ 
"pin" => "<pin>"}  #Required
 sms_template_2fa = "<sms_template_2fa>" #Optional

response = ReAuthenticationApi.verify_pin_authentication(access_token, pin_auth_event_based_auth_model_with_lockout, sms_template_2fa)

Multi Factor Re-Authenticate (GET)

This API is used to trigger the Multi-Factor Autentication workflow for the provided access token More Info


 access_token = "<access_token>" #Required
 sms_template_2fa = "<sms_template_2fa>" #Optional

response = ReAuthenticationApi.mfa_re_authenticate(access_token, sms_template_2fa)

ConsentManagement API

List of APIs in this Section:

Update Consent By Access Token (PUT)

This API is to update consents using access token. More Info


 access_token = "<access_token>" #Required

 consent_update_model ={ 
"consents" => [   { 
 "consentOptionId" => "<consentOptionId>"  ,
"isAccepted" => true  
}  ] }  #Required

response = ConsentManagementApi.update_consent_profile_by_access_token(access_token, consent_update_model)

Consent By ConsentToken (POST)

This API is to submit consent form using consent token. More Info


 consent_token = "<consent_token>" #Required

 consent_submit_model ={ 
"data" => [   { 
 "consentOptionId" => "<consentOptionId>"  ,
"isAccepted" => true  
}  ] ,
"events" => [   { 
 "event" => "<event>"  ,
"isCustom" => true  
}  ] }  #Required

response = ConsentManagementApi.submit_consent_by_consent_token(consent_token, consent_submit_model)

Post Consent By Access Token (POST)

API to provide a way to end user to submit a consent form for particular event type. More Info


 access_token = "<access_token>" #Required

 consent_submit_model ={ 
"data" => [   { 
 "consentOptionId" => "<consentOptionId>"  ,
"isAccepted" => true  
}  ] ,
"events" => [   { 
 "event" => "<event>"  ,
"isCustom" => true  
}  ] }  #Required

response = ConsentManagementApi.submit_consent_by_access_token(access_token, consent_submit_model)

Get Consent Logs By Uid (GET)

This API is used to get the Consent logs of the user. More Info


 uid = "<uid>" #Required

response = ConsentManagementApi.get_consent_logs_by_uid(uid)

Get Consent Log by Access Token (GET)

This API is used to fetch consent logs. More Info


 access_token = "<access_token>" #Required

response = ConsentManagementApi.get_consent_logs(access_token)

Get Verify Consent By Access Token (GET)

This API is used to check if consent is submitted for a particular event or not. More Info


 access_token = "<access_token>" #Required
 event = "<event>" #Required
 is_custom = true #Required

response = ConsentManagementApi.verify_consent_by_access_token(access_token, event, is_custom)

SmartLogin API

List of APIs in this Section:

Smart Login Verify Token (GET)

This API verifies the provided token for Smart Login More Info


 verification_token = "<verification_token>" #Required
 welcome_email_template = "<welcome_email_template>" #Optional

response = SmartLoginApi.(verification_token, welcome_email_template)

Smart Login By Email (GET)

This API sends a Smart Login link to the user's Email Id. More Info


 client_guid = "<client_guid>" #Required
 email = "<email>" #Required
 redirect_url = "<redirect_url>" #Optional
  = "<smart_login_email_template>" #Optional
 welcome_email_template = "<welcome_email_template>" #Optional

response = SmartLoginApi.(client_guid, email, redirect_url, , welcome_email_template)

Smart Login By Username (GET)

This API sends a Smart Login link to the user's Email Id. More Info


 client_guid = "<client_guid>" #Required
 username = "<username>" #Required
 redirect_url = "<redirect_url>" #Optional
  = "<smart_login_email_template>" #Optional
 welcome_email_template = "<welcome_email_template>" #Optional

response = SmartLoginApi.(client_guid, username, redirect_url, , welcome_email_template)

Smart Login Ping (GET)

This API is used to check if the Smart Login link has been clicked or not More Info


 client_guid = "<client_guid>" #Required
 fields = nil #Optional

response = SmartLoginApi.(client_guid, fields)

OneTouchLogin API

List of APIs in this Section:

One Touch OTP Verification (PUT)

This API is used to verify the otp for One Touch Login. More Info


 otp = "<otp>" #Required
 phone = "<phone>" #Required
 fields = nil #Optional
 sms_template = "<sms_template>" #Optional

response = OneTouchLoginApi.(otp, phone, fields, sms_template)

One Touch Login by Email (POST)

This API is used to send a link to a specified email for a frictionless login/registration More Info



  ={ 
"clientguid" => "<clientguid>",
"email" => "<email>",
"g-recaptcha-response" => "<g-recaptcha-response>"}  #Required
  = "<one_touch_login_email_template>" #Optional
 redirecturl = "<redirecturl>" #Optional
 welcomeemailtemplate = "<welcomeemailtemplate>" #Optional

response = OneTouchLoginApi.(, , redirecturl, welcomeemailtemplate)

One Touch Login by Phone (POST)

This API is used to send one time password to a given phone number for a frictionless login/registration. More Info



  ={ 
"g-recaptcha-response" => "<g-recaptcha-response>",
"phone" => "<phone>"}  #Required
 sms_template = "<sms_template>" #Optional

response = OneTouchLoginApi.(, sms_template)

One Touch Email Verification (GET)

This API verifies the provided token for One Touch Login More Info


 verification_token = "<verification_token>" #Required
 welcome_email_template = "<welcome_email_template>" #Optional

response = OneTouchLoginApi.one_touch_email_verification(verification_token, welcome_email_template)

One Touch Login Ping (GET)

This API is used to check if the One Touch Login link has been clicked or not. More Info


 client_guid = "<client_guid>" #Required
 fields = nil #Optional

response = OneTouchLoginApi.(client_guid, fields)

PasswordLessLogin API

List of APIs in this Section:

Passwordless Login Phone Verification (PUT)

This API verifies an account by OTP and allows the customer to login. More Info



  ={ 
"otp" => "<otp>",
"phone" => "<phone>"}  #Required
 fields = nil #Optional
 sms_template = "<sms_template>" #Optional

response = PasswordLessLoginApi.(, fields, sms_template)

Passwordless Login by Phone (GET)

API can be used to send a One-time Passcode (OTP) provided that the account has a verified PhoneID More Info


 phone = "<phone>" #Required
 sms_template = "<sms_template>" #Optional

response = PasswordLessLoginApi.(phone, sms_template)

Passwordless Login By Email (GET)

This API is used to send a Passwordless Login verification link to the provided Email ID More Info


 email = "<email>" #Required
  = "<password_less_login_template>" #Optional
 verification_url = "<verification_url>" #Optional

response = PasswordLessLoginApi.(email, , verification_url)

Passwordless Login By UserName (GET)

This API is used to send a Passwordless Login Verification Link to a customer by providing their UserName More Info


 username = "<username>" #Required
  = "<password_less_login_template>" #Optional
 verification_url = "<verification_url>" #Optional

response = PasswordLessLoginApi.(username, , verification_url)

Passwordless Login Verification (GET)

This API is used to verify the Passwordless Login verification link. Note: If you are using Passwordless Login by Phone you will need to use the Passwordless Login Phone Verification API More Info


 verification_token = "<verification_token>" #Required
 fields = nil #Optional
 welcome_email_template = "<welcome_email_template>" #Optional

response = PasswordLessLoginApi.(verification_token, fields, welcome_email_template)

Configuration API

List of APIs in this Section:

Get Server Time (GET)

This API allows you to query your LoginRadius account for basic server information and server time information which is useful when generating an SOTT token. More Info


 time_difference = 0 #Optional

response = ConfigurationApi.get_server_info(time_difference)

Get Configuration (GET)
This API is used to get the configurations which are set in the LoginRadius Admin Console for a particular LoginRadius site/environment. More info

  response = ConfigurationApi.get_configurations()

Role API

List of APIs in this Section:

Assign Roles by UID (PUT)

This API is used to assign your desired roles to a given user. More Info



  ={ 
"roles" => [  "roles" ] }  #Required
 uid = "<uid>" #Required

response = RoleApi.assign_roles_by_uid(, uid)

Upsert Context (PUT)

This API creates a Context with a set of Roles More Info



  ={ 
"roleContext" => [   { 
  "additionalPermissions" => ["<additionalPermissions>" ] ,
 "context" => "<context>"  ,
 "expiration" => "<expiration>"  ,
  "roles" => ["<roles>" ]  
}  ] }  #Required
 uid = "<uid>" #Required

response = RoleApi.update_role_context_by_uid(, uid)

Add Permissions to Role (PUT)

This API is used to add permissions to a given role. More Info



 permissions_model ={ 
"permissions" => [  "permissions" ] }  #Required
 role = "<role>" #Required

response = RoleApi.add_role_permissions(permissions_model, role)

Roles Create (POST)

This API creates a role with permissions. More Info



 roles_model ={ 
"roles" => [   { 
 "name" => "<name>"  ,
"permissions" => {"Permission_name"=>true}  
}  ] }  #Required

response = RoleApi.create_roles(roles_model)

Roles by UID (GET)

API is used to retrieve all the assigned roles of a particular User. More Info


 uid = "<uid>" #Required

response = RoleApi.get_roles_by_uid(uid)

Get Context with Roles and Permissions (GET)

This API Gets the contexts that have been configured and the associated roles and permissions. More Info


 uid = "<uid>" #Required

response = RoleApi.get_role_context_by_uid(uid)

Role Context profile (GET)

The API is used to retrieve role context by the context name. More Info


 context_name = "<context_name>" #Required

response = RoleApi.get_role_context_by_context_name(context_name)

Roles List (GET)

This API retrieves the complete list of created roles with permissions of your app. More Info



response = RoleApi.get_roles_list()

Unassign Roles by UID (DELETE)

This API is used to unassign roles from a user. More Info



  ={ 
"roles" => [  "roles" ] }  #Required
 uid = "<uid>" #Required

response = RoleApi.unassign_roles_by_uid(, uid)

Delete Role Context (DELETE)

This API Deletes the specified Role Context More Info


 context_name = "<context_name>" #Required
 uid = "<uid>" #Required

response = RoleApi.delete_role_context_by_uid(context_name, uid)

Delete Role from Context (DELETE)

This API Deletes the specified Role from a Context. More Info


 context_name = "<context_name>" #Required

 role_context_remove_role_model ={ 
"roles" => [  "roles" ] }  #Required
 uid = "<uid>" #Required

response = RoleApi.delete_roles_from_role_context_by_uid(context_name, role_context_remove_role_model, uid)

Delete Additional Permission from Context (DELETE)

This API Deletes Additional Permissions from Context. More Info


 context_name = "<context_name>" #Required

 role_context_additional_permission_remove_role_model ={ 
"additionalPermissions" => [  "additionalPermissions" ] }  #Required
 uid = "<uid>" #Required

response = RoleApi.delete_additional_permission_from_role_context_by_uid(context_name, role_context_additional_permission_remove_role_model, uid)

Account Delete Role (DELETE)

This API is used to delete the role. More Info


 role = "<role>" #Required

response = RoleApi.delete_role(role)

Remove Permissions (DELETE)

API is used to remove permissions from a role. More Info



 permissions_model ={ 
"permissions" => [  "permissions" ] }  #Required
 role = "<role>" #Required

response = RoleApi.remove_role_permissions(permissions_model, role)

CustomRegistrationData API

List of APIs in this Section:

Update Registration Data (PUT)

This API allows you to update a dropdown item More Info



 registration_data_update_model ={ 
"isActive" => true,
"key" => "<key>",
"type" => "<type>",
"value" => "<value>"}  #Required
 record_id = "<record_id>" #Required

response = CustomRegistrationDataApi.update_registration_data(registration_data_update_model, record_id)

Validate secret code (POST)

This API allows you to validate code for a particular dropdown member. More Info


 code = "<code>" #Required
 record_id = "<record_id>" #Required

response = CustomRegistrationDataApi.validate_registration_data_code(code, record_id)

Add Registration Data (POST)

This API allows you to fill data into a dropdown list which you have created for user Registration. For more details on how to use this API please see our Custom Registration Data Overview More Info



 registration_data_create_model_list ={ 
"data" => [   { 
 "code" => "<code>"  ,
"isActive" => true ,
 "key" => "<key>"  ,
 "parentId" => "<parentId>"  ,
 "type" => "<type>"  ,
 "value" => "<value>"   
}  ] }  #Required

response = CustomRegistrationDataApi.add_registration_data(registration_data_create_model_list)

Auth Get Registration Data Server (GET)

This API is used to retrieve dropdown data. More Info


 type = "<type>" #Required
 limit = 0 #Optional
 parent_id = "<parent_id>" #Optional
 skip = 0 #Optional

response = CustomRegistrationDataApi.auth_get_registration_data(type, limit, parent_id, skip)

Get Registration Data (GET)

This API is used to retrieve dropdown data. More Info


 type = "<type>" #Required
 limit = 0 #Optional
 parent_id = "<parent_id>" #Optional
 skip = 0 #Optional

response = CustomRegistrationDataApi.get_registration_data(type, limit, parent_id, skip)

Delete Registration Data (DELETE)

This API allows you to delete an item from a dropdown list. More Info


 record_id = "<record_id>" #Required

response = CustomRegistrationDataApi.delete_registration_data(record_id)

Delete All Records by Datasource (DELETE)

This API allows you to delete all records contained in a datasource. More Info


 type = "<type>" #Required

response = CustomRegistrationDataApi.delete_all_records_by_data_source(type)

RiskBasedAuthentication API

List of APIs in this Section:

Risk Based Authentication Login by Email (POST)

This API retrieves a copy of the user data based on the Email More Info



 email_authentication_model ={ 
"email" => "<email>",
"password" => "<password>"}  #Required
 email_template = "<email_template>" #Optional
 fields = nil #Optional
  = "<login_url>" #Optional
 password_delegation = true #Optional
 password_delegation_app = "<password_delegation_app>" #Optional
 rba_browser_email_template = "<rba_browser_email_template>" #Optional
 rba_browser_sms_template = "<rba_browser_sms_template>" #Optional
 rba_city_email_template = "<rba_city_email_template>" #Optional
 rba_city_sms_template = "<rba_city_sms_template>" #Optional
 rba_country_email_template = "<rba_country_email_template>" #Optional
 rba_country_sms_template = "<rba_country_sms_template>" #Optional
 rba_ip_email_template = "<rba_ip_email_template>" #Optional
 rba_ip_sms_template = "<rba_ip_sms_template>" #Optional
 rba_oneclick_email_template = "<rba_oneclick_email_template>" #Optional
 rba_otp_sms_template = "<rba_otp_sms_template>" #Optional
 sms_template = "<sms_template>" #Optional
 verification_url = "<verification_url>" #Optional

response = RiskBasedAuthenticationApi.(email_authentication_model, email_template, fields, , password_delegation, password_delegation_app, rba_browser_email_template, rba_browser_sms_template, rba_city_email_template, rba_city_sms_template, rba_country_email_template, rba_country_sms_template, rba_ip_email_template, rba_ip_sms_template, rba_oneclick_email_template, rba_otp_sms_template, sms_template, verification_url)

Risk Based Authentication Login by Username (POST)

This API retrieves a copy of the user data based on the Username More Info



 user_name_authentication_model ={ 
"password" => "<password>",
"username" => "<username>"}  #Required
 email_template = "<email_template>" #Optional
 fields = nil #Optional
  = "<login_url>" #Optional
 password_delegation = true #Optional
 password_delegation_app = "<password_delegation_app>" #Optional
 rba_browser_email_template = "<rba_browser_email_template>" #Optional
 rba_browser_sms_template = "<rba_browser_sms_template>" #Optional
 rba_city_email_template = "<rba_city_email_template>" #Optional
 rba_city_sms_template = "<rba_city_sms_template>" #Optional
 rba_country_email_template = "<rba_country_email_template>" #Optional
 rba_country_sms_template = "<rba_country_sms_template>" #Optional
 rba_ip_email_template = "<rba_ip_email_template>" #Optional
 rba_ip_sms_template = "<rba_ip_sms_template>" #Optional
 rba_oneclick_email_template = "<rba_oneclick_email_template>" #Optional
 rba_otp_sms_template = "<rba_otp_sms_template>" #Optional
 sms_template = "<sms_template>" #Optional
 verification_url = "<verification_url>" #Optional

response = RiskBasedAuthenticationApi.(user_name_authentication_model, email_template, fields, , password_delegation, password_delegation_app, rba_browser_email_template, rba_browser_sms_template, rba_city_email_template, rba_city_sms_template, rba_country_email_template, rba_country_sms_template, rba_ip_email_template, rba_ip_sms_template, rba_oneclick_email_template, rba_otp_sms_template, sms_template, verification_url)

Risk Based Authentication Phone Login (POST)

This API retrieves a copy of the user data based on the Phone More Info



 phone_authentication_model ={ 
"password" => "<password>",
"phone" => "<phone>"}  #Required
 email_template = "<email_template>" #Optional
 fields = nil #Optional
  = "<login_url>" #Optional
 password_delegation = true #Optional
 password_delegation_app = "<password_delegation_app>" #Optional
 rba_browser_email_template = "<rba_browser_email_template>" #Optional
 rba_browser_sms_template = "<rba_browser_sms_template>" #Optional
 rba_city_email_template = "<rba_city_email_template>" #Optional
 rba_city_sms_template = "<rba_city_sms_template>" #Optional
 rba_country_email_template = "<rba_country_email_template>" #Optional
 rba_country_sms_template = "<rba_country_sms_template>" #Optional
 rba_ip_email_template = "<rba_ip_email_template>" #Optional
 rba_ip_sms_template = "<rba_ip_sms_template>" #Optional
 rba_oneclick_email_template = "<rba_oneclick_email_template>" #Optional
 rba_otp_sms_template = "<rba_otp_sms_template>" #Optional
 sms_template = "<sms_template>" #Optional
 verification_url = "<verification_url>" #Optional

response = RiskBasedAuthenticationApi.(phone_authentication_model, email_template, fields, , password_delegation, password_delegation_app, rba_browser_email_template, rba_browser_sms_template, rba_city_email_template, rba_city_sms_template, rba_country_email_template, rba_country_sms_template, rba_ip_email_template, rba_ip_sms_template, rba_oneclick_email_template, rba_otp_sms_template, sms_template, verification_url)

Sott API

List of APIs in this Section:

Generate SOTT (GET)

This API allows you to generate SOTT with a given expiration time. More Info


 time_difference = 0 #Optional

response = SottApi.generate_sott(time_difference)

NativeSocial API

List of APIs in this Section:

Access Token via Facebook Token (GET)

The API is used to get LoginRadius access token by sending Facebook's access token. It will be valid for the specific duration of time specified in the response. More Info


 fb_access_token = "<fb_access_token>" #Required

response = NativeSocialApi.get_access_token_by_facebook_access_token(fb_access_token)

Access Token via Twitter Token (GET)

The API is used to get LoginRadius access token by sending Twitter's access token. It will be valid for the specific duration of time specified in the response. More Info


 tw_access_token = "<tw_access_token>" #Required
 tw_token_secret = "<tw_token_secret>" #Required

response = NativeSocialApi.get_access_token_by_twitter_access_token(tw_access_token, tw_token_secret)

Access Token via Google Token (GET)

The API is used to get LoginRadius access token by sending Google's access token. It will be valid for the specific duration of time specified in the response. More Info


 google_access_token = "<google_access_token>" #Required
 client_id = "<client_id>" #Optional
 refresh_token = "<refresh_token>" #Optional

response = NativeSocialApi.get_access_token_by_google_access_token(google_access_token, client_id, refresh_token)

Access Token using google JWT token for Native Mobile Login (GET)

This API is used to Get LoginRadius Access Token using google jwt id token for google native mobile login/registration. More Info


 id_token = "<id_token>" #Required

response = NativeSocialApi.get_access_token_by_google_j_w_t_access_token(id_token)

Access Token via Linkedin Token (GET)

The API is used to get LoginRadius access token by sending Linkedin's access token. It will be valid for the specific duration of time specified in the response. More Info


 ln_access_token = "<ln_access_token>" #Required

response = NativeSocialApi.get_access_token_by_linkedin_access_token(ln_access_token)

Get Access Token By Foursquare Access Token (GET)

The API is used to get LoginRadius access token by sending Foursquare's access token. It will be valid for the specific duration of time specified in the response. More Info


 fs_access_token = "<fs_access_token>" #Required

response = NativeSocialApi.get_access_token_by_foursquare_access_token(fs_access_token)

Access Token via Vkontakte Token (GET)

The API is used to get LoginRadius access token by sending Vkontakte's access token. It will be valid for the specific duration of time specified in the response. More Info


 vk_access_token = "<vk_access_token>" #Required

response = NativeSocialApi.get_access_token_by_vkontakte_access_token(vk_access_token)

Access Token via Google AuthCode (GET)

The API is used to get LoginRadius access token by sending Google's AuthCode. It will be valid for the specific duration of time specified in the response. More Info


 google_authcode = "<google_authcode>" #Required

response = NativeSocialApi.get_access_token_by_google_auth_code(google_authcode)

WebHook API

List of APIs in this Section:

Webhook Subscribe (POST)

API can be used to configure a WebHook on your LoginRadius site. Webhooks also work on subscribe and notification model, subscribe your hook and get a notification. Equivalent to RESThook but these provide security on basis of signature and RESThook work on unique URL. Following are the events that are allowed by LoginRadius to trigger a WebHook service call. More Info



 web_hook_subscribe_model ={ 
"event" => "<event>",
"targetUrl" => "<targetUrl>"}  #Required

response = WebHookApi.web_hook_subscribe(web_hook_subscribe_model)

Webhook Subscribed URLs (GET)

This API is used to fatch all the subscribed URLs, for particular event More Info


 event = "<event>" #Required

response = WebHookApi.get_web_hook_subscribed_u_r_ls(event)

Webhook Test (GET)

API can be used to test a subscribed WebHook. More Info



response = WebHookApi.webhook_test()

WebHook Unsubscribe (DELETE)

API can be used to unsubscribe a WebHook configured on your LoginRadius site. More Info



 web_hook_subscribe_model ={ 
"event" => "<event>",
"targetUrl" => "<targetUrl>"}  #Required

response = WebHookApi.web_hook_unsubscribe(web_hook_subscribe_model)

ReAuthentication API

List of APIs in this Section:

Verify Multifactor OTP Authentication (POST)

This API is used on the server-side to validate and verify the re-authentication token created by the MFA re-authentication API. This API checks re-authentications created by OTP. More Info



 event_based_multi_factor_token ={ 
"secondFactorValidationToken" => "<secondFactorValidationToken>"}  #Required
 uid = "<uid>" #Required

response = ReAuthenticationApi.verify_multi_factor_otp_reauthentication(event_based_multi_factor_token, uid)

Verify Multifactor Password Authentication (POST)

This API is used on the server-side to validate and verify the re-authentication token created by the MFA re-authentication API. This API checks re-authentications created by password. More Info



 event_based_multi_factor_token ={ 
"secondFactorValidationToken" => "<secondFactorValidationToken>"}  #Required
 uid = "<uid>" #Required

response = ReAuthenticationApi.verify_multi_factor_password_reauthentication(event_based_multi_factor_token, uid)

Verify Multifactor PIN Authentication (POST)

This API is used on the server-side to validate and verify the re-authentication token created by the MFA re-authentication API. This API checks re-authentications created by PIN. More Info



 event_based_multi_factor_token ={ 
"secondFactorValidationToken" => "<secondFactorValidationToken>"}  #Required
 uid = "<uid>" #Required

response = ReAuthenticationApi.verify_multi_factor_pin_reauthentication(event_based_multi_factor_token, uid)

Demo

We have a demo web application using the Ruby SDK, which includes the following features:

  • Traditional email login
  • Multi-Factor login
  • Passwordless login
  • Social login
  • Register
  • Email verification
  • Forgot password
  • Reset password
  • Change password
  • Set password
  • Update account
  • Account linking
  • Custom object management
  • Roles management

You can get a copy of our demo project at GitHub.


Prerequisites

Follow this guide to install Ruby, and this guide to install Rails.

SET UP:

  1. Run bundle install
  2. Run bundle exec figaro install, then configure the generated /config/application.yml based on config/application.yml.example
  3. Run the server using rails server

To configure the login screen implementation, create options.js in /public/js based on the example provided in /public/options.js.sample