Skip to content
/ python-sdk Public

The LoginRadius Python library will let you integrate LoginRadius' customer identity platform with your Python application(s).

www.loginradius.com

License

MIT license
3 stars 42 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

LoginRadius/python-sdk

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

92 Commits
.github/workflows
.github/workflows
 
 
Demo
Demo
 
 
demo
demo
 
 
lib
lib
 
 
.gitignore
.gitignore
 
 
CHANGELOG.md
CHANGELOG.md
 
 
CONTRIBUTING.md
CONTRIBUTING.md
 
 
LICENCE
LICENCE
 
 
README.md
README.md
 
 

Repository files navigation

Python-SDK

Customer Identity public repo for Python SDK, based on LoginRadius V2 APIs.

Home Image

Introduction

LoginRadius Python SDK Customer Registration wrapper provides access to LoginRadius Identity Management Platform API.

This SDK provides a wrapper for urllib2 or the requests library to easily access the API from https://www.loginradius.com/docs/ in a more "pythonic" way. Providing easier access to essential data in a few lines of code. This will work with 2.0 API specifications.

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 User Registration. You can gather a wealth of user profile data from Social Login or Traditional User Registration.

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.

Prerequisites

You will need at least Python - 2.7 or greater. LoginRadius module utilizes the namedtuple from the collections library and the import_module from importlib.

Install From Package

Using pip

 pip install loginradius-v2==11.6.0

or with easy_install

 easy_install loginradius-v2==11.6.0

Install From Source

You can download the latest version from PyPI

  • Unzip/untar the files.
  • Browse to the directory that you extracted the files to.
  • Run python setup.py install to install the LoginRadius module.

Initialize SDK

Import the class

 from LoginRadius import LoginRadius as LR

When you initialize your application, you will need to set your API Key and Secret. This information can be found in your LoginRadius account as described here.

When your Python application initializes, set your API Key and Secret

 LR.API_KEY = "<API-KEY>"
 LR.API_SECRET = "<API-SECRET>"
 loginradius = LR()

Custom Domain

When initializing the SDK, optionally specify a custom domain.

LR.CUSTOM_DOMAIN = "<CUSTOM-DOMAIN>"

API Request Signing

To enable API request signing, set the value of 'API_REQUEST_SIGNING' to True

LR.API_REQUEST_SIGNING = True

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.

LR.ORIGIN_IP = "<Client-Ip-Address>"

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
user_profile_update_model = { 
"firstName" : "<firstName>",
"lastName" : "<lastName>"
}  #Required 
email_template = "<email_template>" #Optional 
fields = "<fields>" #Optional 
null_support = "True" #Optional 
sms_template = "<sms_template>" #Optional 
verification_url = "<verification_url>" #Optional 
is_voice_otp = "False" #Optional
options = "<options>" #Optional 

result = loginradius.authentication.update_profile_by_access_token(access_token, user_profile_update_model, email_template, fields, null_support, sms_template, verification_url, is_voice_otp, options)
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

result = loginradius.authentication.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

email_verification_by_otp_model = { 
"email" : "<email>",
"otp" : "<otp>"
}  #Required 
fields = "<fields>" #Optional 
url = "<url>" #Optional 
welcome_email_template = "<welcome_email_template>" #Optional

result = loginradius.authentication.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

result = loginradius.authentication.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

result = loginradius.authentication.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

result = loginradius.authentication.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

result = loginradius.authentication.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

result = loginradius.authentication.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

result = loginradius.authentication.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

result = loginradius.authentication.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

 
access_token = "<access_token>" #Required 
username = "<username>" #Required

result = loginradius.authentication.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

result = loginradius.authentication.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

result = loginradius.authentication.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 = "<fields>" #Optional 
login_url = "<login_url>" #Optional 
verification_url = "<verification_url>" #Optional

result = loginradius.authentication.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

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

result = loginradius.authentication.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

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

result = loginradius.authentication.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

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

result = loginradius.authentication.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

 
access_token = "<access_token>" #Required 
client_guid = "<client_guid>" #Required

result = loginradius.authentication.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

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 = "<fields>" #Optional 
options = "<options>" #Optional 
verification_url = "<verification_url>" #Optional 
welcome_email_template = "<welcome_email_template>" #Optional 
is_voice_otp = "False" #Optional

result = loginradius.authentication.user_registration_by_email(auth_user_registration_model, sott, email_template, fields, options, verification_url, welcome_email_template, is_voice_otp)
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 = "<fields>" #Optional 
options = "<options>" #Optional 
sms_template = "<sms_template>" #Optional 
verification_url = "<verification_url>" #Optional 
welcome_email_template = "<welcome_email_template>" #Optional 
is_voice_otp = "False" #Optional

result = loginradius.authentication.user_registration_by_captcha(auth_user_registration_model_with_captcha, email_template, fields, options, sms_template, verification_url, welcome_email_template, is_voice_otp)
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

result = loginradius.authentication.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

result = loginradius.authentication.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

result = loginradius.authentication.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

result = loginradius.authentication.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

result = loginradius.authentication.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

result = loginradius.authentication.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

result = loginradius.authentication.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 = "<fields>" #Optional 
email_template = "<email_template>" #Optional 
verification_url = "<verification_url>" #Optional 
welcome_email_template = "<welcome_email_template>" #Optional

result = loginradius.authentication.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

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

result = loginradius.authentication.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

result = loginradius.authentication.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

 
client_guid = "<client_guid>" #Required 
email_template = "<email_template>" #Optional 
fields = "<fields>" #Optional 
verification_url = "<verification_url>" #Optional 
welcome_email_template = "<welcome_email_template>" #Optional

result = loginradius.authentication.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

 
email = "<email>" #Required

result = loginradius.authentication.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 = "<fields>" #Optional 
url = "<url>" #Optional 
welcome_email_template = "<welcome_email_template>" #Optional
uuid = "<uuid>" #Optional 

result = loginradius.authentication.verify_email(verification_token, fields, url, welcome_email_template, uuid)
Auth Check UserName Availability (GET)

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

 
username = "<username>" #Required

result = loginradius.authentication.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 = "<fields>" #Optional

result = loginradius.authentication.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

result = loginradius.authentication.get_privacy_policy_history_by_access_token(access_token)
Auth send verification Email for linking social profiles (GET)

This API is used to Send verification email to the unverified email of the social profile. This API can be used only incase of optional verification workflow. More Info

 
access_token = "<access_token>" #Required 
clientguid = "<clientguid>" #Required

result = loginradius.authentication.auth_send_verification_email_for_linking_social_profiles(access_token, clientguid)
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

result = loginradius.authentication.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

 
access_token = "<access_token>" #Required 
email = "<email>" #Required

result = loginradius.authentication.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

result = loginradius.authentication.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

account_user_profile_update_model = { 
"firstName" : "<firstName>",
"lastName" : "<lastName>"
}  #Required 
uid = "<uid>" #Required 
fields = "<fields>" #Optional 
null_support = "True" #Optional

result = loginradius.account.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

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

result = loginradius.account.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

result = loginradius.account.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

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

result = loginradius.account.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

 
uid = "<uid>" #Required 
sms_template = "<sms_template>" #Optional 
is_voice_otp = "False" #Optional

result = loginradius.account.reset_phone_id_verification_by_uid(uid, sms_template, is_voice_otp)
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 = "<fields>" #Optional

result = loginradius.account.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

result = loginradius.account.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

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

result = loginradius.account.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

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

result = loginradius.account.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

result = loginradius.account.get_email_verification_token(email)
Multipurpose Email Token Generation API (POST)

This API generate Email tokens and Email OTPs for Email verification, Add email, Forgot password, Delete user, Passwordless login, Forgot pin, One-touch login and Auto login. More Info

multi_email_token = { 
"clientguid" : "<clientguid>",
"email" : "<email>",
"name" : "<name>",
"type" : "<type>",
"uid" : "<uid>",
"userName" : "<userName>"
}  #Required 
tokentype = "<tokentype>" #Required

result = loginradius.account.multipurpose_email_token_generation(multi_email_token, tokentype)
Multipurpose SMS OTP Generation API (POST)

This API generates SMS OTP for Add phone, Phone Id verification, Forgot password, Forgot pin, One-touch login, smart login and Passwordless login. More Info

multi_sms_otp = { 
"name" : "<name>",
"phone" : "<phone>",
"uid" : "<uid>"
}  #Required 
smsotptype = "<smsotptype>" #Required

result = loginradius.account.multipurpose_sms_otp_generation(multi_sms_otp, smsotptype)
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

result = loginradius.account.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 = "<fields>" #Optional

result = loginradius.account.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

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

result = loginradius.account.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

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

result = loginradius.account.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

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

result = loginradius.account.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

 
uid = "<uid>" #Required

result = loginradius.account.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

 
uid = "<uid>" #Required

result = loginradius.account.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

result = loginradius.account.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

result = loginradius.account.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 = "<fields>" #Optional

result = loginradius.account.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

 
uid = "<uid>" #Required

result = loginradius.account.delete_account_by_uid(uid)
Account Remove Email (DELETE)

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

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

result = loginradius.account.remove_email(email, uid, fields)
Revoke All Refresh Token (DELETE)

The Revoke All Refresh Access Token API is used to revoke all refresh tokens for a specific user. More Info

 
uid = "<uid>" #Required

result = loginradius.account.revoke_all_refresh_token(uid)
Delete User Profiles By Email (DELETE)

This API is used to delete all user profiles associated with an Email. More Info

 
email = "<email>" #Required

result = loginradius.account.account_delete_by_email(email)

Social API

List of APIs in this Section:

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

result = loginradius.social.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 
is_web = "True" #Optional

result = loginradius.social.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

 
access_token = "<access_token>" #Required

result = loginradius.social.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

result = loginradius.social.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

result = loginradius.social.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 = "<account_id>" #Required

result = loginradius.social.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

 
profile_id = "<profile_id>" #Required

result = loginradius.social.get_active_session_by_profile_id(profile_id)

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

result = loginradius.custom_object.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

result = loginradius.custom_object.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

result = loginradius.custom_object.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

result = loginradius.custom_object.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

result = loginradius.custom_object.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

result = loginradius.custom_object.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

result = loginradius.custom_object.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

result = loginradius.custom_object.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

result = loginradius.custom_object.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

result = loginradius.custom_object.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

result = loginradius.phone_authentication.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 = "<fields>" #Optional 
sms_template = "<sms_template>" #Optional 
is_voice_otp = "False" #Optional

result = loginradius.phone_authentication.phone_verification_by_otp(otp, phone, fields, sms_template, is_voice_otp)
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 
is_voice_otp = "False" #Optional

result = loginradius.phone_authentication.phone_verification_otp_by_access_token(access_token, otp, sms_template, is_voice_otp)
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
is_voice_otp = "False" #Optional
result = loginradius.phone_authentication.update_phone_number(access_token, phone, sms_template,is_voice_otp)
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 = "<fields>" #Optional 
login_url = "<login_url>" #Optional 
sms_template = "<sms_template>" #Optional

result = loginradius.phone_authentication.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

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

result = loginradius.phone_authentication.forgot_password_by_phone_otp(phone, sms_template, is_voice_otp)
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 
is_voice_otp = "False" #Optional

result = loginradius.phone_authentication.phone_resend_verification_otp(phone, sms_template, is_voice_otp)
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

result = loginradius.phone_authentication.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 = { 
"email" : [   { 
"type" : "<type>"  ,
"value" : "<value>"   
}  ] ,
"firstName" : "<firstName>",
"lastName" : "<lastName>",
"password" : "<password>",
"phoneId" : "<phoneId>"
}  #Required 
sott = "<sott>" #Required 
fields = "<fields>" #Optional 
options = "<options>" #Optional 
sms_template = "<sms_template>" #Optional 
verification_url = "<verification_url>" #Optional 
welcome_email_template = "<welcome_email_template>" #Optional 
email_template = "<email_template>" #Optional 
is_voice_otp = "False" #Optional

result = loginradius.phone_authentication.user_registration_by_phone(auth_user_registration_model, sott, fields, options, sms_template, verification_url, welcome_email_template,email_template, is_voice_otp)
Phone Number Availability (GET)

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

 
phone = "<phone>" #Required

result = loginradius.phone_authentication.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

result = loginradius.phone_authentication.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 = "<fields>" #Optional

result = loginradius.mfa.mfa_update_setting(access_token, multi_factor_auth_model_with_lockout, fields)
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_no2_f_a = "<phone_no2_f_a>" #Required 
sms_template2_f_a = "<sms_template2_f_a>" #Optional 
is_voice_otp = "False" #Optional
options = "<options>" #Optional 

result = loginradius.mfa.mfa_update_phone_number_by_token(access_token, phone_no2_f_a, sms_template2_f_a, is_voice_otp,options)
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

 
access_token = "<access_token>" #Required
multi_factor_auth_model_by_email_otp_with_lockout = { 
"EmailId":"emailId",
"Otp":"otp"
}  #Required

result = loginradius.mfa.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

 
access_token = "<access_token>" #Required
security_question_answer_model_by_access_token = { 
  "securityquestionanswer": [
       {
           "QuestionId": "db7****8a73e4******bd9****8c20",
           "Answer": "<answer>"
       }
   ],
    "ReplaceSecurityQuestionAnswer":"True" 
}  #Required

result = loginradius.mfa.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

multi_factor_auth_model_with_lockout = { 
"otp" : "<otp>"
}  #Required 
second_factor_authentication_token = "<second_factor_authentication_token>" #Required 
fields = "<fields>" #Optional 
sms_template2_f_a = "<sms_template2_f_a>" #Optional
rba_browser_email_template = "<rba_browser_email_template>" #Optional 
rba_city_email_template = "<rba_city_email_template>" #Optional 
rba_country_email_template = "<rba_country_email_template>" #Optional 
rba_ip_email_template = "<rba_ip_email_template>" #Optional 

result = loginradius.mfa.mfa_validate_otp_by_phone(multi_factor_auth_model_with_lockout, second_factor_authentication_token, fields,sms_template2_f_a, 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

multi_factor_auth_model_by_backup_code = { 
"backupCode" : "<backupCode>"
}  #Required 
second_factor_authentication_token = "<second_factor_authentication_token>" #Required 
fields = "<fields>" #Optional 
rba_browser_email_template = "<rba_browser_email_template>" #Optional 
rba_city_email_template = "<rba_city_email_template>" #Optional 
rba_country_email_template = "<rba_country_email_template>" #Optional 
rba_ip_email_template = "<rba_ip_email_template>" #Optional

result = loginradius.mfa.mfa_validate_backup_code(multi_factor_auth_model_by_backup_code, second_factor_authentication_token, fields, rba_browser_email_template, rba_city_email_template, rba_country_email_template, rba_ip_email_template)
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_no2_f_a = "<phone_no2_f_a>" #Required 
second_factor_authentication_token = "<second_factor_authentication_token>" #Required 
sms_template2_f_a = "<sms_template2_f_a>" #Optional 
is_voice_otp = "False" #Optional
options = "<options>" #Optional 

result = loginradius.mfa.mfa_update_phone_number(phone_no2_f_a, second_factor_authentication_token, sms_template2_f_a, is_voice_otp, options)
Verify MFA Email OTP by MFA Token (PUT)

This API is used to Verify MFA Email OTP by MFA Token More Info

multi_factor_auth_model_by_email_otp = { 

   "EmailId":"email",
   "Otp":"otp"
}  #Required 
second_factor_authentication_token = "<second_factor_authentication_token>" #Required 
rba_browser_email_template = "<rba_browser_email_template>" #Optional 
rba_city_email_template = "<rba_city_email_template>" #Optional 
rba_country_email_template = "<rba_country_email_template>" #Optional 
rba_ip_email_template = "<rba_ip_email_template>" #Optional

result = loginradius.mfa.mfa_validate_email_otp(multi_factor_auth_model_by_email_otp, second_factor_authentication_token, rba_browser_email_template, rba_city_email_template, rba_country_email_template, rba_ip_email_template)
Update MFA Security Question by MFA Token (PUT)

This API is used to set the security questions on the profile with the MFA token when MFA flow is required. More Info

security_question_answer_update_model = { 
  "securityquestionanswer": [
       {
           "QuestionId": "db7****8a73e4******bd9****8c20",
           "Answer": "<answer>"
       }
   ]
}  #Required 
second_factor_authentication_token = "<second_factor_authentication_token>" #Required

result = loginradius.mfa.mfa_security_question_answer(security_question_answer_update_model, second_factor_authentication_token)
MFA Validate Authenticator Code (PUT)

This API is used to login to a user's account during the second MFA step with an Authenticator Code. More Info

multi_factor_auth_model_by_authenticator_code = {
 "authenticatorCode" : "<authenticatorCode>"
}  #Required 
secondfactorauthenticationtoken = "<secondfactorauthenticationtoken>" #Required 
fields = "<fields>" #Optional

result = loginradius.mfa.mfa_validate_authenticator_code(multi_factor_auth_model_by_authenticator_code, secondfactorauthenticationtoken, fields)
MFA Verify Authenticator Code (PUT)

This API is used to validate an Authenticator Code as part of the MFA process. More Info

 
access_token = "<access_token>" #Required
multi_factor_auth_model_by_authenticator_code_security_answer = { 
"authenticatorCode" : "<authenticatorCode>"
}  #Required 
fields = "<fields>" #Optional

result = loginradius.mfa.mfa_verify_authenticator_code(access_token, multi_factor_auth_model_by_authenticator_code_security_answer, fields)
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 = "<fields>" #Optional 
login_url = "<login_url>" #Optional 
sms_template = "<sms_template>" #Optional 
sms_template2_f_a = "<sms_template2_f_a>" #Optional 
verification_url = "<verification_url>" #Optional
email_template2_f_a = "<email_template2_f_a>" #Optional 
is_voice_otp = "False" #Optional
options = "<options>" #Optional 

result = loginradius.mfa.mfa_login_by_email(email, password, email_template, fields, login_url, sms_template, sms_template2_f_a, verification_url,email_template2_f_a, is_voice_otp,options)
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 = "<fields>" #Optional 
login_url = "<login_url>" #Optional 
sms_template = "<sms_template>" #Optional 
sms_template2_f_a = "<sms_template2_f_a>" #Optional 
verification_url = "<verification_url>" #Optional
email_template2_f_a = "<email_template2_f_a>" #Optional 
is_voice_otp = "False" #Optional

result = loginradius.mfa.mfa_login_by_user_name(password, username, email_template, fields, login_url, sms_template, sms_template2_f_a, verification_url,email_template2_f_a, is_voice_otp)
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 = "<fields>" #Optional 
login_url = "<login_url>" #Optional 
sms_template = "<sms_template>" #Optional 
sms_template2_f_a = "<sms_template2_f_a>" #Optional 
verification_url = "<verification_url>" #Optional
email_template2_f_a = "<email_template2_f_a>" #Optional 
is_voice_otp = "False" #Optional
options = "<options>" #Optional 

result = loginradius.mfa.mfa_login_by_phone(password, phone, email_template, fields, login_url, sms_template, sms_template2_f_a, verification_url,email_template2_f_a, is_voice_otp, options)
Send MFA Email OTP by MFA Token (POST)

An API designed to send the MFA Email OTP to the email. More Info

email_id_model = {
 "EmailId":"email"
}  #Required 
second_factor_authentication_token = "<second_factor_authentication_token>" #Required 
email_template2_f_a = "<email_template2_f_a>" #Optional

result = loginradius.mfa.mfa_email_otp(email_id_model, second_factor_authentication_token, email_template2_f_a)
Verify MFA Security Question by MFA Token (POST)

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

security_question_answer_update_model = {
  "securityquestionanswer": [
       {
           "QuestionId": "db7****8a73e4******bd9****8c20",
           "Answer": "<answer>"
       }
   ]
}  #Required 
second_factor_authentication_token = "<second_factor_authentication_token>" #Required 
rba_browser_email_template = "<rba_browser_email_template>" #Optional 
rba_city_email_template = "<rba_city_email_template>" #Optional 
rba_country_email_template = "<rba_country_email_template>" #Optional 
rba_ip_email_template = "<rba_ip_email_template>" #Optional

result = loginradius.mfa.mfa_security_question_answer_verification(security_question_answer_update_model, second_factor_authentication_token, rba_browser_email_template, rba_city_email_template, rba_country_email_template, rba_ip_email_template)
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 
is_voice_otp = "False" #Optional

result = loginradius.mfa.mfa_configure_by_access_token(access_token, is_voice_otp)
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

result = loginradius.mfa.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

result = loginradius.mfa.mfa_reset_backup_code_by_access_token(access_token)
Send MFA Email OTP by Access Token (GET)

This API is created to send the OTP to the email if email OTP authenticator is enabled in app's MFA configuration. More Info

 
access_token = "<access_token>" #Required 
email_id = "<email_id>" #Required 
email_template2_f_a = "<email_template2_f_a>" #Optional

result = loginradius.mfa.mfa_email_otp_by_access_token(access_token, email_id, email_template2_f_a)
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_template2_f_a = "<sms_template2_f_a>" #Optional 
is_voice_otp = "False" #Optional

result = loginradius.mfa.mfa_resend_otp(second_factor_authentication_token, sms_template2_f_a, is_voice_otp)
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

result = loginradius.mfa.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

result = loginradius.mfa.mfa_reset_backup_code_by_uid(uid)
MFA Reset Authenticator by Token (DELETE)

This API Resets the Authenticator configurations on a given account via the access_token. More Info

 
access_token = "<access_token>" #Required 
authenticator = True #Required

result = loginradius.mfa.mfa_reset_authenticator_by_token(access_token, authenticator)
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

result = loginradius.mfa.mfa_reset_sms_auth_by_token(access_token, otpauthenticator)
Reset MFA Email OTP Authenticator By Access Token (DELETE)

This API is used to reset the Email OTP Authenticator settings for an MFA-enabled user More Info

 
access_token = "<access_token>" #Required

result = loginradius.mfa.mfa_reset_email_otp_authenticator_by_access_token(access_token)
MFA Reset Security Question Authenticator By Access Token (DELETE)

This API is used to Reset MFA Security Question Authenticator By Access Token More Info

 
access_token = "<access_token>" #Required

result = loginradius.mfa.mfa_reset_security_question_authenticator_by_access_token(access_token)
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

result = loginradius.mfa.mfa_reset_sms_authenticator_by_uid(otpauthenticator, uid)
MFA Reset Authenticator By UID (DELETE)

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

 
authenticator = True #Required 
uid = "<uid>" #Required

result = loginradius.mfa.mfa_reset_authenticator_by_uid(authenticator, uid)
Reset MFA Email OTP Authenticator Settings by Uid (DELETE)

This API is used to reset the Email OTP Authenticator settings for an MFA-enabled user. More Info

 
uid = "<uid>" #Required

result = loginradius.mfa.mfa_reset_email_otp_authenticator_by_uid(uid)
Reset MFA Security Question Authenticator Settings by Uid (DELETE)

This API is used to reset the Security Question Authenticator settings for an MFA-enabled user. More Info

 
uid = "<uid>" #Required

result = loginradius.mfa.mfa_reset_security_question_authenticator_by_uid(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

result = loginradius.pin_authentication.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

result = loginradius.pin_authentication.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

result = loginradius.pin_authentication.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

result = loginradius.pin_authentication.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

result = loginradius.pin_authentication.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

result = loginradius.pin_authentication.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

result = loginradius.pin_authentication.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

result = loginradius.pin_authentication.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

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

result = loginradius.pin_authentication.pin_login(login_by_pin_model, 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

result = loginradius.pin_authentication.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

result = loginradius.pin_authentication.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 
is_voice_otp = "False" #Optional

result = loginradius.pin_authentication.send_forgot_pin_sms_by_phone(forgot_pin_otp_by_phone_model, sms_template, is_voice_otp)
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

result = loginradius.pin_authentication.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

result = loginradius.pin_authentication.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

result = loginradius.re_authentication.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

result = loginradius.re_authentication.mfa_re_authenticate_by_backup_code(access_token, reauth_by_backup_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_template2_f_a = "<sms_template2_f_a>" #Optional

result = loginradius.re_authentication.mfa_re_authenticate_by_password(access_token, password_event_based_auth_model_with_lockout, sms_template2_f_a)
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_template2_f_a = "<sms_template2_f_a>" #Optional

result = loginradius.re_authentication.verify_pin_authentication(access_token, pin_auth_event_based_auth_model_with_lockout, sms_template2_f_a)
MFA Re-authentication by Email OTP (PUT)

This API is used to validate the triggered MFA authentication flow with an Email OTP. More Info

 
access_token = "<access_token>" #Required
reauth_by_email_otp_model = { 
 "EmailId":"email",
 "otp": "otp"
}  #Required

result = loginradius.re_authentication.re_auth_validate_email_otp(access_token, reauth_by_email_otp_model)
MFA Step-Up Authentication by Authenticator Code (PUT)

This API is used to validate the triggered MFA authentication flow with the Authenticator Code. More Info

 
access_token = "<access_token>" #Required
multi_factor_auth_model_by_authenticator_code = {
   "authenticatorCode" : "<authenticatorCode>"
}  #Required

result = loginradius.re_authentication.mfa_re_authenticate_by_authenticator_code(access_token, multi_factor_auth_model_by_authenticator_code)
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

result = loginradius.re_authentication.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

result = loginradius.re_authentication.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

result = loginradius.re_authentication.verify_multi_factor_pin_reauthentication(event_based_multi_factor_token, uid)
MFA Re-authentication by Security Question (POST)

This API is used to validate the triggered MFA re-authentication flow with security questions answers. More Info

 
access_token = "<access_token>" #Required
security_question_answer_update_model = { 
  "securityquestionanswer": [
       {
           "QuestionId": "db7****8a73e4******bd9****8c20",
           "Answer": "<answer>"
       }
   ]
}  #Required

result = loginradius.re_authentication.re_auth_by_security_question(access_token, security_question_answer_update_model)
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_template2_f_a = "<sms_template2_f_a>" #Optional 
is_voice_otp = "False" #Optional

result = loginradius.re_authentication.mfa_re_authenticate(access_token, sms_template2_f_a, is_voice_otp)
Send MFA Re-auth Email OTP by Access Token (GET)

This API is used to send the MFA Email OTP to the email for Re-authentication More Info

 
access_token = "<access_token>" #Required 
email_id = "<email_id>" #Required 
email_template2_f_a = "<email_template2_f_a>" #Optional

result = loginradius.re_authentication.re_auth_send_email_otp(access_token, email_id, email_template2_f_a)

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

result = loginradius.consent_management.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

result = loginradius.consent_management.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

result = loginradius.consent_management.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

result = loginradius.consent_management.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

result = loginradius.consent_management.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

result = loginradius.consent_management.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

result = loginradius.smart_login.smart_login_token_verification(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 = "<smart_login_email_template>" #Optional 
welcome_email_template = "<welcome_email_template>" #Optional

result = loginradius.smart_login.smart_login_by_email(client_guid, email, redirect_url, smart_login_email_template, 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 = "<smart_login_email_template>" #Optional 
welcome_email_template = "<welcome_email_template>" #Optional

result = loginradius.smart_login.smart_login_by_user_name(client_guid, username, redirect_url, smart_login_email_template, 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 = "<fields>" #Optional

result = loginradius.smart_login.smart_login_ping(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 = "<fields>" #Optional 
sms_template = "<sms_template>" #Optional

result = loginradius.one_touch_login.one_touch_login_otp_verification(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

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

result = loginradius.one_touch_login.one_touch_login_by_email(one_touch_login_by_email_model, one_touch_login_email_template, 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

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

result = loginradius.one_touch_login.one_touch_login_by_phone(one_touch_login_by_phone_model, sms_template, is_voice_otp)
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

result = loginradius.one_touch_login.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 = "<fields>" #Optional

result = loginradius.one_touch_login.one_touch_login_ping(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

password_less_login_otp_model = { 
"otp" : "<otp>",
"phone" : "<phone>"
}  #Required 
fields = "<fields>" #Optional 
sms_template = "<sms_template>" #Optional 
is_voice_otp = "False" #Optional

result = loginradius.password_less_login.passwordless_login_phone_verification(password_less_login_otp_model, fields, sms_template, is_voice_otp)
Passwordless Login Verification By Email And OTP (POST)

This API is used to verify the otp sent to the email when doing a passwordless login. More Info

password_less_login_by_email_and_otp_model = {
 "email": "<email>",
 "otp": "<otp>",
 "welcomeemailtemplate": "<welcome_email_template>"
}  #Required 
fields = "<fields>" #Optional

result = loginradius.password_less_login.passwordless_login_verification_by_email_and_otp(password_less_login_by_email_and_otp_model, fields)
Passwordless Login Verification By User Name And OTP (POST)

This API is used to verify the otp sent to the email when doing a passwordless login. More Info

password_less_login_by_user_name_and_otp_model = {
 "username": "<User name>",
 "otp": "<otp>",
 "welcomeemailtemplate": "<welcome_email_template>"
}  #Required 
fields = "<fields>" #Optional

result = loginradius.password_less_login.passwordless_login_verification_by_user_name_and_otp(password_less_login_by_user_name_and_otp_model, fields)
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 
is_voice_otp = "False" #Optional

result = loginradius.password_less_login.passwordless_login_by_phone(phone, sms_template, is_voice_otp)
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 = "<password_less_login_template>" #Optional 
verification_url = "<verification_url>" #Optional

result = loginradius.password_less_login.passwordless_login_by_email(email, password_less_login_template, 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 = "<password_less_login_template>" #Optional 
verification_url = "<verification_url>" #Optional

result = loginradius.password_less_login.passwordless_login_by_user_name(username, password_less_login_template, 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 = "<fields>" #Optional 
welcome_email_template = "<welcome_email_template>" #Optional

result = loginradius.password_less_login.passwordless_login_verification(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

result = loginradius.configuration.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

result = loginradius.configuration.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

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

result = loginradius.role.assign_roles_by_uid(account_roles_model, uid)
Upsert Context (PUT)

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

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

result = loginradius.role.update_role_context_by_uid(account_role_context_model, 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

result = loginradius.role.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

result = loginradius.role.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

result = loginradius.role.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

result = loginradius.role.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

result = loginradius.role.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

result = loginradius.role.get_roles_list()
Unassign Roles by UID (DELETE)

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

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

result = loginradius.role.unassign_roles_by_uid(account_roles_model, uid)
Delete Role Context (DELETE)

This API Deletes the specified Role Context More Info

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

result = loginradius.role.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

result = loginradius.role.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

result = loginradius.role.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

result = loginradius.role.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

result = loginradius.role.remove_role_permissions(permissions_model, role)

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 = "<fields>" #Optional 
login_url = "<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

result = loginradius.risk_based_authentication.rba_login_by_email(email_authentication_model, email_template, fields, login_url, 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 = "<fields>" #Optional 
login_url = "<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

result = loginradius.risk_based_authentication.rba_login_by_user_name(user_name_authentication_model, email_template, fields, login_url, 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 = "<fields>" #Optional 
login_url = "<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

result = loginradius.risk_based_authentication.rba_login_by_phone(phone_authentication_model, email_template, fields, login_url, 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

result = loginradius.sott.generate_sott(time_difference)

NativeSocial API

List of APIs in this Section:

Get Access Token via Custom JWT Token (GET)

This API is used to retrieve a LoginRadius access token by passing in a valid custom JWT token. More Info

 
id_token = "<id_token>" #Required 
providername = "<providername>" #Required

result = loginradius.native_social.access_token_via_custom_j_w_t_token(id_token, providername)
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 
social_app_name = "<social_app_name>" #Optional

result = loginradius.native_social.get_access_token_by_facebook_access_token(fb_access_token, social_app_name)
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 
social_app_name = "<social_app_name>" #Optional

result = loginradius.native_social.get_access_token_by_twitter_access_token(tw_access_token, tw_token_secret, social_app_name)
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 
social_app_name = "<social_app_name>" #Optional

result = loginradius.native_social.get_access_token_by_google_access_token(google_access_token, client_id, refresh_token, social_app_name)
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

result = loginradius.native_social.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 
social_app_name = "<social_app_name>" #Optional

result = loginradius.native_social.get_access_token_by_linkedin_access_token(ln_access_token, social_app_name)
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

result = loginradius.native_social.get_access_token_by_foursquare_access_token(fs_access_token)
Access Token via Apple Id Code (GET)

The API is used to get LoginRadius access token by sending a valid Apple ID OAuth Code. It will be valid for the specific duration of time specified in the response. More Info

 
code = "<code>" #Required 
social_app_name = "<social_app_name>" #Optional

result = loginradius.native_social.get_access_token_by_apple_id_code(code, social_app_name)
Access Token via WeChat Code (GET)

This API is used to retrieve a LoginRadius access token by passing in a valid WeChat OAuth Code. More Info

 
code = "<code>" #Required

result = loginradius.native_social.get_access_token_by_we_chat_code(code)
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 
social_app_name = "<social_app_name>" #Optional

result = loginradius.native_social.get_access_token_by_google_auth_code(google_authcode, social_app_name)

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

result = loginradius.web_hook.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

result = loginradius.web_hook.get_web_hook_subscribed_u_r_ls(event)
Webhook Test (GET)

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

result = loginradius.web_hook.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

result = loginradius.web_hook.web_hook_unsubscribe(web_hook_subscribe_model)

SlidingToken API

List of APIs in this Section:
GET : Get Sliding Access Token

(GET)

This API is used to get access token and refresh token with the expired/nonexpired access token. More Info

access_token = "<access_token>" #Required
result = loginradius.sliding_token.sliding_access_token(access_token)

Error Handling

If the request fails, it can be handled in the following way:

if result.get('ErrorCode') is not None:
    print(result.get('Description'))
else:
    print(result)

Generate SOTT Manually

SOTT is a secure one-time token that can be created using the API key, API secret, and a timestamp ( start time and end time ). You can manually create a SOTT using the following utility function.

startTime="2022-01-16 12:00:00" #(Optional)  // Valid Start Date with Date and time

endTime="2022-03-16 12:15:00" #(Optional) // Valid End Date with Date and time

#do not pass the time difference if you are passing startTime & endTime.

timeDifference='10' #(Optional) The time difference will be used to set the expiration time of SOTT, If you do not pass time difference then the default expiration time of SOTT is 10 minutes.

getLRserverTime=False #(Optional) If True it will call LoginRadius Get Server Time Api and fetch basic server information and server time information which is useful when generating an SOTT token.

# The LoginRadius API key and primary API secret can be passed additionally, If the credentials will not be passed then this SOTT function will pick the API credentials from the SDK configuration.  


apiKey="" #(Optional) LoginRadius Api Key.

apiSecret = "" # (Optional) LoginRadius Api Secret (Only Primary Api Secret is used to generate the SOTT manually).	

sott_data = loginradius.get_sott(timeDifference, getLRserverTime,apiKey,apiSecret,startTime,endTime)

print(sott_data)

Demo

We have a demo web application using the Python 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.


Configuration

1.Have Flask, requests, pbkdf2, cryptography installed or you can install the required dependency using the following command:

pip install -r requirements.txt

2.Fill in credentials in lr.py and static/js/options.js

3.Navigate to demo directory and run: python app.py

4.Demo will appear on http://localhost:5000

About

The LoginRadius Python library will let you integrate LoginRadius' customer identity platform with your Python application(s).

www.loginradius.com

Topics

python-library user-profile python-sdk hacktoberfest user-registration loginradius digital-identity loginradius-platform loginradius-access

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

3 stars

Watchers

8 watching

Forks

42 forks
Report repository

Releases 20

Released Version 11.6.0 Latest
Jul 16, 2024
+ 19 releases

Packages

No packages published

Contributors 8

Languages