https://github.com/LoginRadius/python-sdk
The LoginRadius Python library will let you integrate LoginRadius' customer identity platform with your Python application(s).
https://github.com/LoginRadius/python-sdk
digital-identity hacktoberfest loginradius loginradius-access loginradius-platform python-library python-sdk user-profile user-registration
Last synced: 9 months ago
JSON representation
The LoginRadius Python library will let you integrate LoginRadius' customer identity platform with your Python application(s).
- Host: GitHub
- URL: https://github.com/LoginRadius/python-sdk
- Owner: LoginRadius
- License: mit
- Created: 2012-07-15T02:04:02.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2024-07-16T10:29:33.000Z (over 1 year ago)
- Last Synced: 2025-03-25T06:07:21.855Z (9 months ago)
- Topics: digital-identity, hacktoberfest, loginradius, loginradius-access, loginradius-platform, python-library, python-sdk, user-profile, user-registration
- Language: Python
- Homepage: http://www.loginradius.com
- Size: 1.05 MB
- Stars: 3
- Watchers: 7
- Forks: 42
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Python-SDK
Customer Identity public repo for Python SDK, based on LoginRadius V2 APIs.
## 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](https://docs.python.org/2/library/collections.html#collections.namedtuple) from the collections library and the [import_module](https://docs.python.org/2/library/importlib.html) from importlib.
### Install From Package
Using pip
```py
pip install loginradius-v2==11.7.0
```
or with easy_install
```py
easy_install loginradius-v2==11.7.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
```py
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](https://www.loginradius.com/docs/api/v2/admin-console/platform-security/api-key-and-secret).
When your Python application initializes, set your API Key and Secret
```py
LR.API_KEY = ""
LR.API_SECRET = ""
loginradius = LR()
```
### Custom Domain
When initializing the SDK, optionally specify a custom domain.
```py
LR.CUSTOM_DOMAIN = ""
```
### API Request Signing
To enable API request signing, set the value of 'API_REQUEST_SIGNING' to True
```py
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.
```py
LR.ORIGIN_IP = ""
```
### Authentication API
List of APIs in this Section:
* PUT : [Auth Update Profile by Token](#UpdateProfileByAccessToken-put-)
* PUT : [Auth Unlock Account by Access Token](#UnlockAccountByToken-put-)
* PUT : [Auth Verify Email By OTP](#VerifyEmailByOTP-put-)
* PUT : [Auth Reset Password by Security Answer and Email](#ResetPasswordBySecurityAnswerAndEmail-put-)
* PUT : [Auth Reset Password by Security Answer and Phone](#ResetPasswordBySecurityAnswerAndPhone-put-)
* PUT : [Auth Reset Password by Security Answer and UserName](#ResetPasswordBySecurityAnswerAndUserName-put-)
* PUT : [Auth Reset Password by Reset Token](#ResetPasswordByResetToken-put-)
* PUT : [Auth Reset Password by OTP](#ResetPasswordByEmailOTP-put-)
* PUT : [Auth Reset Password by OTP and UserName](#ResetPasswordByOTPAndUserName-put-)
* PUT : [Auth Change Password](#ChangePassword-put-)
* PUT : [Auth Set or Change UserName](#SetOrChangeUserName-put-)
* PUT : [Auth Resend Email Verification](#AuthResendEmailVerification-put-)
* POST : [Auth Add Email](#AddEmail-post-)
* POST : [Auth Login by Email](#LoginByEmail-post-)
* POST : [Auth Login by Username](#LoginByUserName-post-)
* POST : [Auth Forgot Password](#ForgotPassword-post-)
* POST : [Auth Link Social Identities](#LinkSocialIdentities-post-)
* POST : [Auth Link Social Identities By Ping](#LinkSocialIdentitiesByPing-post-)
* POST : [Auth User Registration by Email](#UserRegistrationByEmail-post-)
* POST : [Auth User Registration By Captcha](#UserRegistrationByCaptcha-post-)
* GET : [Get Security Questions By Email](#GetSecurityQuestionsByEmail-get-)
* GET : [Get Security Questions By UserName](#GetSecurityQuestionsByUserName-get-)
* GET : [Get Security Questions By Phone](#GetSecurityQuestionsByPhone-get-)
* GET : [Get Security Questions By Access Token](#GetSecurityQuestionsByAccessToken-get-)
* GET : [Auth Validate Access token](#AuthValidateAccessToken-get-)
* GET : [Access Token Invalidate](#AuthInValidateAccessToken-get-)
* GET : [Access Token Info](#GetAccessTokenInfo-get-)
* GET : [Auth Read all Profiles by Token](#GetProfileByAccessToken-get-)
* GET : [Auth Send Welcome Email](#SendWelcomeEmail-get-)
* GET : [Auth Delete Account](#DeleteAccountByDeleteToken-get-)
* GET : [Get Profile By Ping](#GetProfileByPing-get-)
* GET : [Auth Check Email Availability](#CheckEmailAvailability-get-)
* GET : [Auth Verify Email](#VerifyEmail-get-)
* GET : [Auth Check UserName Availability](#CheckUserNameAvailability-get-)
* GET : [Auth Privacy Policy Accept](#AcceptPrivacyPolicy-get-)
* GET : [Auth Privacy Policy History By Access Token](#GetPrivacyPolicyHistoryByAccessToken-get-)
* GET : [Auth send verification Email for linking social profiles](#AuthSendVerificationEmailForLinkingSocialProfiles-get-)
* DELETE : [Auth Delete Account with Email Confirmation](#DeleteAccountWithEmailConfirmation-delete-)
* DELETE : [Auth Remove Email](#RemoveEmail-delete-)
* DELETE : [Auth Unlink Social Identities](#UnlinkSocialIdentities-delete-)
Auth Update Profile by Token (PUT)
This API is used to update the user's profile by passing the access token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-update-profile-by-token/)
```py
access_token = "" #Required
user_profile_update_model = {
"firstName" : "",
"lastName" : ""
} #Required
email_template = "" #Optional
fields = "" #Optional
null_support = "True" #Optional
sms_template = "" #Optional
verification_url = "" #Optional
is_voice_otp = "False" #Optional
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-unlock-account-by-access-token/)
```py
access_token = "" #Required
unlock_profile_model = {
"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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-verify-email-by-otp/)
```py
email_verification_by_otp_model = {
"email" : "",
"otp" : ""
} #Required
fields = "" #Optional
url = "" #Optional
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-email)
```py
reset_password_by_security_answer_and_email_model = {
"email" : "",
"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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-phone)
```py
reset_password_by_security_answer_and_phone_model = {
"password" : "",
"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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-username)
```py
reset_password_by_security_answer_and_user_name_model = {
"password" : "",
"securityAnswer" : {"QuestionID":"Answer"},
"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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-reset-token)
```py
reset_password_by_reset_token_model = {
"password" : "",
"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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-otp)
```py
reset_password_by_email_and_otp_model = {
"email" : "",
"otp" : "",
"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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-otp-and-username/)
```py
reset_password_by_user_name_model = {
"otp" : "",
"password" : "",
"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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-change-password)
```py
access_token = "" #Required
new_password = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-set-or-change-user-name/)
```py
access_token = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-resend-email-verification/)
```py
email = "" #Required
email_template = "" #Optional
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-add-email)
```py
access_token = "" #Required
email = "" #Required
type = "" #Required
email_template = "" #Optional
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-login-by-email)
```py
email_authentication_model = {
"email" : "",
"password" : ""
} #Required
email_template = "" #Optional
fields = "" #Optional
login_url = "" #Optional
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-login-by-username)
```py
user_name_authentication_model = {
"password" : "",
"username" : ""
} #Required
email_template = "" #Optional
fields = "" #Optional
login_url = "" #Optional
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-forgot-password)
```py
email = "" #Required
reset_password_url = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-link-social-identities)
```py
access_token = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-link-social-identities-by-ping)
```py
access_token = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-user-registration-by-email)
```py
auth_user_registration_model = {
"email" : [ {
"type" : "" ,
"value" : ""
} ] ,
"firstName" : "",
"lastName" : "",
"password" : ""
} #Required
sott = "" #Required
email_template = "" #Optional
fields = "" #Optional
options = "" #Optional
verification_url = "" #Optional
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-user-registration-by-recaptcha)
```py
auth_user_registration_model_with_captcha = {
"email" : [ {
"type" : "" ,
"value" : ""
} ] ,
"firstName" : "",
"g-recaptcha-response" : "",
"lastName" : "",
"password" : ""
} #Required
email_template = "" #Optional
fields = "" #Optional
options = "" #Optional
sms_template = "" #Optional
verification_url = "" #Optional
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/security-questions-by-email/)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/security-questions-by-user-name/)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/security-questions-by-phone/)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/security-questions-by-access-token/)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-validate-access-token/)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-invalidate-access-token/)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-access-token-info/)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-read-profiles-by-token/)
```py
access_token = "" #Required
fields = "" #Optional
email_template = "" #Optional
verification_url = "" #Optional
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-send-welcome-email/)
```py
access_token = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-delete-account/)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/social-login-by-ping/)
```py
client_guid = "" #Required
email_template = "" #Optional
fields = "" #Optional
verification_url = "" #Optional
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-email-availability/)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-verify-email/)
```py
verification_token = "" #Required
fields = "" #Optional
url = "" #Optional
welcome_email_template = "" #Optional
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-username-availability/)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-privacy-policy-accept)
```py
access_token = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/privacy-policy-history-by-access-token/)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-send-verification-for-social-email/)
```
access_token = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-delete-account-with-email-confirmation/)
```py
access_token = "" #Required
delete_url = "" #Optional
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-remove-email)
```py
access_token = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-unlink-social-identities)
```py
access_token = "" #Required
provider = "" #Required
provider_id = "" #Required
result = loginradius.authentication.unlink_social_identities(access_token, provider, provider_id)
```
### Account API
List of APIs in this Section:
* PUT : [Account Update](#UpdateAccountByUid-put-)
* PUT : [Update Phone ID by UID](#UpdatePhoneIDByUid-put-)
* PUT : [Account Set Password](#SetAccountPasswordByUid-put-)
* PUT : [Account Invalidate Verification Email](#InvalidateAccountEmailVerification-put-)
* PUT : [Reset phone ID verification](#ResetPhoneIDVerificationByUid-put-)
* PUT : [Upsert Email](#UpsertEmail-put-)
* PUT : [Update UID](#AccountUpdateUid-put-)
* POST : [Account Create](#CreateAccount-post-)
* POST : [Forgot Password token](#GetForgotPasswordToken-post-)
* POST : [Email Verification token](#GetEmailVerificationToken-post-)
* POST : [Multipurpose Email Token Generation API](#MultipurposeEmailTokenGeneration-post-)
* POST : [Multipurpose SMS OTP Generation API](#MultipurposeSMSOTPGeneration-post-)
* GET : [Get Privacy Policy History By Uid](#GetPrivacyPolicyHistoryByUid-get-)
* GET : [Account Profiles by Email](#GetAccountProfileByEmail-get-)
* GET : [Account Profiles by Username](#GetAccountProfileByUserName-get-)
* GET : [Account Profile by Phone ID](#GetAccountProfileByPhone-get-)
* GET : [Account Profiles by UID](#GetAccountProfileByUid-get-)
* GET : [Account Password](#GetAccountPasswordHashByUid-get-)
* GET : [Access Token based on UID or User impersonation API](#GetAccessTokenByUid-get-)
* GET : [Refresh Access Token by Refresh Token](#RefreshAccessTokenByRefreshToken-get-)
* GET : [Revoke Refresh Token](#RevokeRefreshToken-get-)
* GET : [Account Identities by Email](#GetAccountIdentitiesByEmail-get-)
* DELETE : [Account Delete](#DeleteAccountByUid-delete-)
* DELETE : [Account Remove Email](#RemoveEmail-delete-)
* DELETE : [Revoke All Refresh Token](#RevokeAllRefreshToken-delete-)
* DELETE : [Delete User Profiles By Email](#AccountDeleteByEmail-delete-)
Account Update (PUT)
This API is used to update the information of existing accounts in your Cloud Storage. See our Advanced API Usage section Here for more capabilities. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-update)
```py
account_user_profile_update_model = {
"firstName" : "",
"lastName" : ""
} #Required
uid = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/update-phoneid-by-uid)
```py
phone = "" #Required
uid = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-set-password)
```py
password = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-invalidate-verification-email)
```py
uid = "" #Required
email_template = "" #Optional
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/reset-phone-id-verification)
```py
uid = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/upsert-email)
```py
upsert_email_model = {
"email" : [ {
"type" : "" ,
"value" : ""
} ]
} #Required
uid = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-update/)
```py
update_uid_model = {
"newUid" : ""
} #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-create)
```py
account_create_model = {
"email" : [ {
"type" : "" ,
"value" : ""
} ] ,
"firstName" : "",
"lastName" : "",
"password" : ""
} #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/get-forgot-password-token)
```py
email = "" #Required
email_template = "" #Optional
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/get-email-verification-token)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/multipurpose-token-and-sms-otp-generation-api/multipurpose-email-token-generation/)
```py
multi_email_token = {
"clientguid" : "",
"email" : "",
"name" : "",
"type" : "",
"uid" : "",
"userName" : ""
} #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/multipurpose-token-and-sms-otp-generation-api/multipurpose-sms-otp-generation/)
```py
multi_sms_otp = {
"name" : "",
"phone" : "",
"uid" : ""
} #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/privacy-policy-history-by-uid/)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-profiles-by-email)
```py
email = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-profiles-by-user-name)
```py
user_name = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-profiles-by-phone-id/)
```py
phone = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-profiles-by-uid)
```py
uid = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-password)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-impersonation-api)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/refresh-token/refresh-access-token-by-refresh-token)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/refresh-token/revoke-refresh-token)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-identities-by-email)
```py
email = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-delete)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-email-delete)
```py
email = "" #Required
uid = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/refresh-token/revoke-all-refresh-token/)
```
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-email-delete/)
```py
email = "" #Required
result = loginradius.account.account_delete_by_email(email)
```
### Social API
List of APIs in this Section:
* GET : [Access Token](#ExchangeAccessToken-get-)
* GET : [Refresh Token](#RefreshAccessToken-get-)
* GET : [Token Validate](#ValidateAccessToken-get-)
* GET : [Access Token Invalidate](#InValidateAccessToken-get-)
* GET : [Get Active Session Details](#GetActiveSession-get-)
* GET : [Get Active Session By Account Id](#GetActiveSessionByAccountID-get-)
* GET : [Get Active Session By Profile Id](#GetActiveSessionByProfileID-get-)
Access Token (GET)
This API Is used to translate the Request Token returned during authentication into an Access Token that can be used with other API calls. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/access-token)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/refresh-token/refresh-token)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/validate-access-token)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/invalidate-access-token)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/get-active-session-details)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/active-session-by-account-id/)
```py
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/active-session-by-profile-id/)
```py
profile_id = "" #Required
result = loginradius.social.get_active_session_by_profile_id(profile_id)
```
### CustomObject API
List of APIs in this Section:
* PUT : [Custom Object Update by Access Token](#UpdateCustomObjectByToken-put-)
* PUT : [Custom Object Update by UID](#UpdateCustomObjectByUid-put-)
* POST : [Create Custom Object by Token](#CreateCustomObjectByToken-post-)
* POST : [Create Custom Object by UID](#CreateCustomObjectByUid-post-)
* GET : [Custom Object by Token](#GetCustomObjectByToken-get-)
* GET : [Custom Object by ObjectRecordId and Token](#GetCustomObjectByRecordIDAndToken-get-)
* GET : [Custom Object By UID](#GetCustomObjectByUid-get-)
* GET : [Custom Object by ObjectRecordId and UID](#GetCustomObjectByRecordID-get-)
* DELETE : [Custom Object Delete by Record Id And Token](#DeleteCustomObjectByToken-delete-)
* DELETE : [Account Delete Custom Object by ObjectRecordId](#DeleteCustomObjectByRecordID-delete-)
Custom Object Update by Access Token (PUT)
This API is used to update the specified custom object data of the specified account. If the value of updatetype is 'replace' then it will fully replace custom object with the new custom object and if the value of updatetype is 'partialreplace' then it will perform an upsert type operation [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-update-by-objectrecordid-and-token)
```py
access_token = "" #Required
object_name = "" #Required
object_record_id = "" #Required
object = { "customdata1": "Store my customdata1 value"} #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-update-by-objectrecordid-and-uid)
```py
object_name = "" #Required
object_record_id = "" #Required
object = { "customdata1": "Store my customdata1 value"} #Required
uid = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/create-custom-object-by-token)
```py
access_token = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/create-custom-object-by-uid)
```py
object_name = "" #Required
object = { "customdata1": "Store my customdata1 value"} #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-by-token)
```py
access_token = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-by-objectrecordid-and-token)
```py
access_token = "" #Required
object_name = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-by-uid)
```py
object_name = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-by-objectrecordid-and-uid)
```py
object_name = "" #Required
object_record_id = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-delete-by-objectrecordid-and-token)
```py
access_token = "" #Required
object_name = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-delete-by-objectrecordid-and-uid)
```py
object_name = "" #Required
object_record_id = "" #Required
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:
* PUT : [Phone Reset Password by OTP](#ResetPasswordByPhoneOTP-put-)
* PUT : [Phone Verification OTP](#PhoneVerificationByOTP-put-)
* PUT : [Phone Verification OTP by Token](#PhoneVerificationOTPByAccessToken-put-)
* PUT : [Phone Number Update](#UpdatePhoneNumber-put-)
* POST : [Phone Login](#LoginByPhone-post-)
* POST : [Phone Forgot Password by OTP](#ForgotPasswordByPhoneOTP-post-)
* POST : [Phone Resend Verification OTP](#PhoneResendVerificationOTP-post-)
* POST : [Phone Resend Verification OTP By Token](#PhoneResendVerificationOTPByToken-post-)
* POST : [Phone User Registration by SMS](#UserRegistrationByPhone-post-)
* GET : [Phone Number Availability](#CheckPhoneNumberAvailability-get-)
* DELETE : [Remove Phone ID by Access Token](#RemovePhoneIDByAccessToken-delete-)
Phone Reset Password by OTP (PUT)
This API is used to reset the password [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-reset-password-by-otp)
```py
reset_password_by_otp_model = {
"otp" : "",
"password" : "",
"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](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-verify-otp)
```py
otp = "" #Required
phone = "" #Required
fields = "" #Optional
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-verify-otp-by-token)
```py
access_token = "" #Required
otp = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-number-update)
```py
access_token = "" #Required
phone = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-login)
```py
phone_authentication_model = {
"password" : "",
"phone" : ""
} #Required
fields = "" #Optional
login_url = "" #Optional
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-forgot-password-by-otp)
```py
phone = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-resend-otp)
```py
phone = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-resend-otp-by-token)
```py
access_token = "" #Required
phone = "" #Required
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](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-user-registration-by-sms)
```py
auth_user_registration_model = {
"email" : [ {
"type" : "" ,
"value" : ""
} ] ,
"firstName" : "",
"lastName" : "",
"password" : "",
"phoneId" : "