{"id":18611093,"url":"https://github.com/loginradius/python-sdk","last_synced_at":"2025-08-13T21:34:37.485Z","repository":{"id":3959201,"uuid":"5052777","full_name":"LoginRadius/python-sdk","owner":"LoginRadius","description":"The LoginRadius Python library will let you integrate LoginRadius' customer identity platform with your Python application(s).","archived":false,"fork":false,"pushed_at":"2024-07-16T10:29:33.000Z","size":1103,"stargazers_count":3,"open_issues_count":0,"forks_count":42,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-11-07T00:43:25.250Z","etag":null,"topics":["digital-identity","hacktoberfest","loginradius","loginradius-access","loginradius-platform","python-library","python-sdk","user-profile","user-registration"],"latest_commit_sha":null,"homepage":"http://www.loginradius.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LoginRadius.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-07-15T02:04:02.000Z","updated_at":"2024-07-16T10:15:34.000Z","dependencies_parsed_at":"2024-07-16T09:29:11.150Z","dependency_job_id":"1ac1689e-accf-440e-877a-f762af170234","html_url":"https://github.com/LoginRadius/python-sdk","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LoginRadius%2Fpython-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LoginRadius%2Fpython-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LoginRadius%2Fpython-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LoginRadius%2Fpython-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LoginRadius","download_url":"https://codeload.github.com/LoginRadius/python-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223449813,"owners_count":17146984,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["digital-identity","hacktoberfest","loginradius","loginradius-access","loginradius-platform","python-library","python-sdk","user-profile","user-registration"],"created_at":"2024-11-07T03:12:36.855Z","updated_at":"2025-04-10T22:32:59.901Z","avatar_url":"https://github.com/LoginRadius.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Python-SDK\n\nCustomer Identity public repo for Python SDK, based on LoginRadius V2 APIs.\n\n![Home Image](http://docs.lrcontent.com/resources/github/banner-1544x500.png)\n\n\n## Introduction ##\n\nLoginRadius Python SDK Customer Registration wrapper provides access to LoginRadius Identity Management Platform API.\n\nThis SDK provides a wrapper for urllib2 or the requests library to easily access the API from\nhttps://www.loginradius.com/docs/ in a more \"pythonic\" way. Providing easier access to essential data in a few lines of code.\nThis will work with 2.0 API specifications.\n\nLoginRadius 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.\n\n## Documentation\n\n-------\n\u003eDisclaimer:\u003cbr\u003e\nThis 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.\n\n\n### Prerequisites\nYou 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.\n\n### Install From Package\nUsing pip\n\n```py\n pip install loginradius-v2==11.7.0\n```\n\nor with easy_install\n\n```py\n easy_install loginradius-v2==11.7.0\n```\n\n### Install From Source\nYou can download the latest version from PyPI\n\n- Unzip/untar the files.\n- Browse to the directory that you extracted the files to.\n- Run ```python setup.py install``` to install the LoginRadius module.\n\n\n## Initialize SDK\nImport the class\n\n```py\n from LoginRadius import LoginRadius as LR\n```\nWhen 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).\n\n\n\nWhen your Python application initializes, set your API Key and Secret\n\n```py\n LR.API_KEY = \"\u003cAPI-KEY\u003e\"\n LR.API_SECRET = \"\u003cAPI-SECRET\u003e\"\n loginradius = LR()\n```\n\n### Custom Domain\nWhen initializing the SDK, optionally specify a custom domain.\n\n```py\nLR.CUSTOM_DOMAIN = \"\u003cCUSTOM-DOMAIN\u003e\"\n```\n\n### API Request Signing\nTo enable API request signing, set the value of 'API_REQUEST_SIGNING' to True\n\n```py\nLR.API_REQUEST_SIGNING = True\n```\n### X-Origin-IP\nLoginRadius 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.\n\n```py\nLR.ORIGIN_IP = \"\u003cClient-Ip-Address\u003e\"\n```\n\n### Authentication API\n\n\nList of APIs in this Section:\u003cbr\u003e\n\n* PUT : [Auth Update Profile by Token](#UpdateProfileByAccessToken-put-)\u003cbr\u003e\n* PUT : [Auth Unlock Account by Access Token](#UnlockAccountByToken-put-)\u003cbr\u003e\n* PUT : [Auth Verify Email By OTP](#VerifyEmailByOTP-put-)\u003cbr\u003e\n* PUT : [Auth Reset Password by Security Answer and Email](#ResetPasswordBySecurityAnswerAndEmail-put-)\u003cbr\u003e\n* PUT : [Auth Reset Password by Security Answer and Phone](#ResetPasswordBySecurityAnswerAndPhone-put-)\u003cbr\u003e\n* PUT : [Auth Reset Password by Security Answer and UserName](#ResetPasswordBySecurityAnswerAndUserName-put-)\u003cbr\u003e\n* PUT : [Auth Reset Password by Reset Token](#ResetPasswordByResetToken-put-)\u003cbr\u003e\n* PUT : [Auth Reset Password by OTP](#ResetPasswordByEmailOTP-put-)\u003cbr\u003e\n* PUT : [Auth Reset Password by OTP and UserName](#ResetPasswordByOTPAndUserName-put-)\u003cbr\u003e\n* PUT : [Auth Change Password](#ChangePassword-put-)\u003cbr\u003e\n* PUT : [Auth Set or Change UserName](#SetOrChangeUserName-put-)\u003cbr\u003e\n* PUT : [Auth Resend Email Verification](#AuthResendEmailVerification-put-)\u003cbr\u003e\n* POST : [Auth Add Email](#AddEmail-post-)\u003cbr\u003e\n* POST : [Auth Login by Email](#LoginByEmail-post-)\u003cbr\u003e\n* POST : [Auth Login by Username](#LoginByUserName-post-)\u003cbr\u003e\n* POST : [Auth Forgot Password](#ForgotPassword-post-)\u003cbr\u003e\n* POST : [Auth Link Social Identities](#LinkSocialIdentities-post-)\u003cbr\u003e\n* POST : [Auth Link Social Identities By Ping](#LinkSocialIdentitiesByPing-post-)\u003cbr\u003e\n* POST : [Auth User Registration by Email](#UserRegistrationByEmail-post-)\u003cbr\u003e\n* POST : [Auth User Registration By Captcha](#UserRegistrationByCaptcha-post-)\u003cbr\u003e\n* GET : [Get Security Questions By Email](#GetSecurityQuestionsByEmail-get-)\u003cbr\u003e\n* GET : [Get Security Questions By UserName](#GetSecurityQuestionsByUserName-get-)\u003cbr\u003e\n* GET : [Get Security Questions By Phone](#GetSecurityQuestionsByPhone-get-)\u003cbr\u003e\n* GET : [Get Security Questions By Access Token](#GetSecurityQuestionsByAccessToken-get-)\u003cbr\u003e\n* GET : [Auth Validate Access token](#AuthValidateAccessToken-get-)\u003cbr\u003e\n* GET : [Access Token Invalidate](#AuthInValidateAccessToken-get-)\u003cbr\u003e\n* GET : [Access Token Info](#GetAccessTokenInfo-get-)\u003cbr\u003e\n* GET : [Auth Read all Profiles by Token](#GetProfileByAccessToken-get-)\u003cbr\u003e\n* GET : [Auth Send Welcome Email](#SendWelcomeEmail-get-)\u003cbr\u003e\n* GET : [Auth Delete Account](#DeleteAccountByDeleteToken-get-)\u003cbr\u003e\n* GET : [Get Profile By Ping](#GetProfileByPing-get-)\u003cbr\u003e\n* GET : [Auth Check Email Availability](#CheckEmailAvailability-get-)\u003cbr\u003e\n* GET : [Auth Verify Email](#VerifyEmail-get-)\u003cbr\u003e\n* GET : [Auth Check UserName Availability](#CheckUserNameAvailability-get-)\u003cbr\u003e\n* GET : [Auth Privacy Policy Accept](#AcceptPrivacyPolicy-get-)\u003cbr\u003e\n* GET : [Auth Privacy Policy History By Access Token](#GetPrivacyPolicyHistoryByAccessToken-get-)\u003cbr\u003e\n* GET : [Auth send verification Email for linking social profiles](#AuthSendVerificationEmailForLinkingSocialProfiles-get-)\u003cbr\u003e\n* DELETE : [Auth Delete Account with Email Confirmation](#DeleteAccountWithEmailConfirmation-delete-)\u003cbr\u003e\n* DELETE : [Auth Remove Email](#RemoveEmail-delete-)\u003cbr\u003e\n* DELETE : [Auth Unlink Social Identities](#UnlinkSocialIdentities-delete-)\u003cbr\u003e\n\n\n\n\n\u003ch6 id=\"UpdateProfileByAccessToken-put-\"\u003e Auth Update Profile by Token (PUT)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\nuser_profile_update_model = { \n\"firstName\" : \"\u003cfirstName\u003e\",\n\"lastName\" : \"\u003clastName\u003e\"\n}  #Required \nemail_template = \"\u003cemail_template\u003e\" #Optional \nfields = \"\u003cfields\u003e\" #Optional \nnull_support = \"True\" #Optional \nsms_template = \"\u003csms_template\u003e\" #Optional \nverification_url = \"\u003cverification_url\u003e\" #Optional \nis_voice_otp = \"False\" #Optional\noptions = \"\u003coptions\u003e\" #Optional \n\nresult = 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)\n ```\n \n  \n  \n \n\u003ch6 id=\"UnlockAccountByToken-put-\"\u003e Auth Unlock Account by Access Token (PUT)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\nunlock_profile_model = { \n\"g-recaptcha-response\" : \"\u003cg-recaptcha-response\u003e\"\n}  #Required\n\nresult = loginradius.authentication.unlock_account_by_token(access_token, unlock_profile_model)\n ```\n \n  \n  \n \n\u003ch6 id=\"VerifyEmailByOTP-put-\"\u003e Auth Verify Email By OTP (PUT)\u003c/h6\u003e\n\n 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/)\n\n ```py\n \nemail_verification_by_otp_model = { \n\"email\" : \"\u003cemail\u003e\",\n\"otp\" : \"\u003cotp\u003e\"\n}  #Required \nfields = \"\u003cfields\u003e\" #Optional \nurl = \"\u003curl\u003e\" #Optional \nwelcome_email_template = \"\u003cwelcome_email_template\u003e\" #Optional\n\nresult = loginradius.authentication.verify_email_by_otp(email_verification_by_otp_model, fields, url, welcome_email_template)\n ```\n \n  \n  \n \n\u003ch6 id=\"ResetPasswordBySecurityAnswerAndEmail-put-\"\u003e Auth Reset Password by Security Answer and Email (PUT)\u003c/h6\u003e\n\n 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)\n\n ```py\n \nreset_password_by_security_answer_and_email_model = { \n\"email\" : \"\u003cemail\u003e\",\n\"password\" : \"\u003cpassword\u003e\",\n\"securityAnswer\" : {\"QuestionID\":\"Answer\"}\n}  #Required\n\nresult = loginradius.authentication.reset_password_by_security_answer_and_email(reset_password_by_security_answer_and_email_model)\n ```\n \n  \n  \n \n\u003ch6 id=\"ResetPasswordBySecurityAnswerAndPhone-put-\"\u003e Auth Reset Password by Security Answer and Phone (PUT)\u003c/h6\u003e\n\n 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)\n\n ```py\n \nreset_password_by_security_answer_and_phone_model = { \n\"password\" : \"\u003cpassword\u003e\",\n\"phone\" : \"\u003cphone\u003e\",\n\"securityAnswer\" : {\"QuestionID\":\"Answer\"}\n}  #Required\n\nresult = loginradius.authentication.reset_password_by_security_answer_and_phone(reset_password_by_security_answer_and_phone_model)\n ```\n \n  \n  \n \n\u003ch6 id=\"ResetPasswordBySecurityAnswerAndUserName-put-\"\u003e Auth Reset Password by Security Answer and UserName (PUT)\u003c/h6\u003e\n\n 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)\n\n ```py\n \nreset_password_by_security_answer_and_user_name_model = { \n\"password\" : \"\u003cpassword\u003e\",\n\"securityAnswer\" : {\"QuestionID\":\"Answer\"},\n\"userName\" : \"\u003cuserName\u003e\"\n}  #Required\n\nresult = loginradius.authentication.reset_password_by_security_answer_and_user_name(reset_password_by_security_answer_and_user_name_model)\n ```\n \n  \n  \n \n\u003ch6 id=\"ResetPasswordByResetToken-put-\"\u003e Auth Reset Password by Reset Token (PUT)\u003c/h6\u003e\n\n 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)\n\n ```py\n \nreset_password_by_reset_token_model = { \n\"password\" : \"\u003cpassword\u003e\",\n\"resetToken\" : \"\u003cresetToken\u003e\"\n}  #Required\n\nresult = loginradius.authentication.reset_password_by_reset_token(reset_password_by_reset_token_model)\n ```\n \n  \n  \n \n\u003ch6 id=\"ResetPasswordByEmailOTP-put-\"\u003e Auth Reset Password by OTP (PUT)\u003c/h6\u003e\n\n 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)\n\n ```py\n \nreset_password_by_email_and_otp_model = { \n\"email\" : \"\u003cemail\u003e\",\n\"otp\" : \"\u003cotp\u003e\",\n\"password\" : \"\u003cpassword\u003e\"\n}  #Required\n\nresult = loginradius.authentication.reset_password_by_email_otp(reset_password_by_email_and_otp_model)\n ```\n \n  \n  \n \n\u003ch6 id=\"ResetPasswordByOTPAndUserName-put-\"\u003e Auth Reset Password by OTP and UserName (PUT)\u003c/h6\u003e\n\n 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/)\n\n ```py\n \nreset_password_by_user_name_model = { \n\"otp\" : \"\u003cotp\u003e\",\n\"password\" : \"\u003cpassword\u003e\",\n\"userName\" : \"\u003cuserName\u003e\"\n}  #Required\n\nresult = loginradius.authentication.reset_password_by_otp_and_user_name(reset_password_by_user_name_model)\n ```\n \n  \n  \n \n\u003ch6 id=\"ChangePassword-put-\"\u003e Auth Change Password (PUT)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nnew_password = \"\u003cnew_password\u003e\" #Required \nold_password = \"\u003cold_password\u003e\" #Required\n\nresult = loginradius.authentication.change_password(access_token, new_password, old_password)\n ```\n \n  \n  \n \n\u003ch6 id=\"SetOrChangeUserName-put-\"\u003e Auth Set or Change UserName (PUT)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nusername = \"\u003cusername\u003e\" #Required\n\nresult = loginradius.authentication.set_or_change_user_name(access_token, username)\n ```\n \n  \n  \n \n\u003ch6 id=\"AuthResendEmailVerification-put-\"\u003e Auth Resend Email Verification (PUT)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \nemail = \"\u003cemail\u003e\" #Required \nemail_template = \"\u003cemail_template\u003e\" #Optional \nverification_url = \"\u003cverification_url\u003e\" #Optional\n\nresult = loginradius.authentication.auth_resend_email_verification(email, email_template, verification_url)\n ```\n \n  \n  \n \n\u003ch6 id=\"AddEmail-post-\"\u003e Auth Add Email (POST)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nemail = \"\u003cemail\u003e\" #Required \ntype = \"\u003ctype\u003e\" #Required \nemail_template = \"\u003cemail_template\u003e\" #Optional \nverification_url = \"\u003cverification_url\u003e\" #Optional\n\nresult = loginradius.authentication.add_email(access_token, email, type, email_template, verification_url)\n ```\n \n  \n  \n \n\u003ch6 id=\"LoginByEmail-post-\"\u003e Auth Login by Email (POST)\u003c/h6\u003e\n\n 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)\n\n ```py\n \nemail_authentication_model = { \n\"email\" : \"\u003cemail\u003e\",\n\"password\" : \"\u003cpassword\u003e\"\n}  #Required \nemail_template = \"\u003cemail_template\u003e\" #Optional \nfields = \"\u003cfields\u003e\" #Optional \nlogin_url = \"\u003clogin_url\u003e\" #Optional \nverification_url = \"\u003cverification_url\u003e\" #Optional\n\nresult = loginradius.authentication.login_by_email(email_authentication_model, email_template, fields, login_url, verification_url)\n ```\n \n  \n  \n \n\u003ch6 id=\"LoginByUserName-post-\"\u003e Auth Login by Username (POST)\u003c/h6\u003e\n\n 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)\n\n ```py\n \nuser_name_authentication_model = { \n\"password\" : \"\u003cpassword\u003e\",\n\"username\" : \"\u003cusername\u003e\"\n}  #Required \nemail_template = \"\u003cemail_template\u003e\" #Optional \nfields = \"\u003cfields\u003e\" #Optional \nlogin_url = \"\u003clogin_url\u003e\" #Optional \nverification_url = \"\u003cverification_url\u003e\" #Optional\n\nresult = loginradius.authentication.login_by_user_name(user_name_authentication_model, email_template, fields, login_url, verification_url)\n ```\n \n  \n  \n \n\u003ch6 id=\"ForgotPassword-post-\"\u003e Auth Forgot Password (POST)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nemail = \"\u003cemail\u003e\" #Required \nreset_password_url = \"\u003creset_password_url\u003e\" #Required \nemail_template = \"\u003cemail_template\u003e\" #Optional\n\nresult = loginradius.authentication.forgot_password(email, reset_password_url, email_template)\n ```\n \n  \n  \n \n\u003ch6 id=\"LinkSocialIdentities-post-\"\u003e Auth Link Social Identities (POST)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \ncandidate_token = \"\u003ccandidate_token\u003e\" #Required\n\nresult = loginradius.authentication.link_social_identities(access_token, candidate_token)\n ```\n \n  \n  \n \n\u003ch6 id=\"LinkSocialIdentitiesByPing-post-\"\u003e Auth Link Social Identities By Ping (POST)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nclient_guid = \"\u003cclient_guid\u003e\" #Required\n\nresult = loginradius.authentication.link_social_identities_by_ping(access_token, client_guid)\n ```\n \n  \n  \n \n\u003ch6 id=\"UserRegistrationByEmail-post-\"\u003e Auth User Registration by Email (POST)\u003c/h6\u003e\n\n 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)\n\n ```py\n \nauth_user_registration_model = { \n\"email\" : [   { \n \"type\" : \"\u003ctype\u003e\"  ,\n \"value\" : \"\u003cvalue\u003e\"   \n}  ] ,\n\"firstName\" : \"\u003cfirstName\u003e\",\n\"lastName\" : \"\u003clastName\u003e\",\n\"password\" : \"\u003cpassword\u003e\"\n}  #Required \nsott = \"\u003csott\u003e\" #Required \nemail_template = \"\u003cemail_template\u003e\" #Optional \nfields = \"\u003cfields\u003e\" #Optional \noptions = \"\u003coptions\u003e\" #Optional \nverification_url = \"\u003cverification_url\u003e\" #Optional \nwelcome_email_template = \"\u003cwelcome_email_template\u003e\" #Optional \nis_voice_otp = \"False\" #Optional\n\nresult = loginradius.authentication.user_registration_by_email(auth_user_registration_model, sott, email_template, fields, options, verification_url, welcome_email_template, is_voice_otp)\n ```\n \n  \n  \n \n\u003ch6 id=\"UserRegistrationByCaptcha-post-\"\u003e Auth User Registration By Captcha (POST)\u003c/h6\u003e\n\n 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)\n\n ```py\n \nauth_user_registration_model_with_captcha = { \n\"email\" : [   { \n \"type\" : \"\u003ctype\u003e\"  ,\n \"value\" : \"\u003cvalue\u003e\"   \n}  ] ,\n\"firstName\" : \"\u003cfirstName\u003e\",\n\"g-recaptcha-response\" : \"\u003cg-recaptcha-response\u003e\",\n\"lastName\" : \"\u003clastName\u003e\",\n\"password\" : \"\u003cpassword\u003e\"\n}  #Required \nemail_template = \"\u003cemail_template\u003e\" #Optional \nfields = \"\u003cfields\u003e\" #Optional \noptions = \"\u003coptions\u003e\" #Optional \nsms_template = \"\u003csms_template\u003e\" #Optional \nverification_url = \"\u003cverification_url\u003e\" #Optional \nwelcome_email_template = \"\u003cwelcome_email_template\u003e\" #Optional \nis_voice_otp = \"False\" #Optional\n\nresult = 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)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetSecurityQuestionsByEmail-get-\"\u003e Get Security Questions By Email (GET)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \nemail = \"\u003cemail\u003e\" #Required\n\nresult = loginradius.authentication.get_security_questions_by_email(email)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetSecurityQuestionsByUserName-get-\"\u003e Get Security Questions By UserName (GET)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \nuser_name = \"\u003cuser_name\u003e\" #Required\n\nresult = loginradius.authentication.get_security_questions_by_user_name(user_name)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetSecurityQuestionsByPhone-get-\"\u003e Get Security Questions By Phone (GET)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \nphone = \"\u003cphone\u003e\" #Required\n\nresult = loginradius.authentication.get_security_questions_by_phone(phone)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetSecurityQuestionsByAccessToken-get-\"\u003e Get Security Questions By Access Token (GET)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\n\nresult = loginradius.authentication.get_security_questions_by_access_token(access_token)\n ```\n \n  \n  \n \n\u003ch6 id=\"AuthValidateAccessToken-get-\"\u003e Auth Validate Access token (GET)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\n\nresult = loginradius.authentication.auth_validate_access_token(access_token)\n ```\n \n  \n  \n \n\u003ch6 id=\"AuthInValidateAccessToken-get-\"\u003e Access Token Invalidate (GET)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nprevent_refresh = \"True\" #Optional\n\nresult = loginradius.authentication.auth_in_validate_access_token(access_token, prevent_refresh)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetAccessTokenInfo-get-\"\u003e Access Token Info (GET)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\n\nresult = loginradius.authentication.get_access_token_info(access_token)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetProfileByAccessToken-get-\"\u003e Auth Read all Profiles by Token (GET)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nfields = \"\u003cfields\u003e\" #Optional \nemail_template = \"\u003cemail_template\u003e\" #Optional \nverification_url = \"\u003cverification_url\u003e\" #Optional \nwelcome_email_template = \"\u003cwelcome_email_template\u003e\" #Optional\n\nresult = loginradius.authentication.get_profile_by_access_token(access_token, fields,email_template, verification_url, welcome_email_template)\n ```\n \n  \n  \n \n\u003ch6 id=\"SendWelcomeEmail-get-\"\u003e Auth Send Welcome Email (GET)\u003c/h6\u003e\n\n This API sends a welcome email  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-send-welcome-email/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nwelcome_email_template = \"\u003cwelcome_email_template\u003e\" #Optional\n\nresult = loginradius.authentication.send_welcome_email(access_token, welcome_email_template)\n ```\n \n  \n  \n \n\u003ch6 id=\"DeleteAccountByDeleteToken-get-\"\u003e Auth Delete Account (GET)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \ndeletetoken = \"\u003cdeletetoken\u003e\" #Required\n\nresult = loginradius.authentication.delete_account_by_delete_token(deletetoken)\n ```\n \n \n\u003ch6 id=\"GetProfileByPing-get-\"\u003eGet Profile By Ping  (GET)\u003c/h6\u003e\n\nThis 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/)\n\n ```py\n  \nclient_guid = \"\u003cclient_guid\u003e\" #Required \nemail_template = \"\u003cemail_template\u003e\" #Optional \nfields = \"\u003cfields\u003e\" #Optional \nverification_url = \"\u003cverification_url\u003e\" #Optional \nwelcome_email_template = \"\u003cwelcome_email_template\u003e\" #Optional\n\nresult = loginradius.authentication.get_profile_by_ping(client_guid, email_template, fields, verification_url, welcome_email_template)\n ```\n \n    \n  \n \n\u003ch6 id=\"CheckEmailAvailability-get-\"\u003e Auth Check Email Availability (GET)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \nemail = \"\u003cemail\u003e\" #Required\n\nresult = loginradius.authentication.check_email_availability(email)\n ```\n \n  \n  \n \n\u003ch6 id=\"VerifyEmail-get-\"\u003e Auth Verify Email (GET)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \nverification_token = \"\u003cverification_token\u003e\" #Required \nfields = \"\u003cfields\u003e\" #Optional \nurl = \"\u003curl\u003e\" #Optional \nwelcome_email_template = \"\u003cwelcome_email_template\u003e\" #Optional\nuuid = \"\u003cuuid\u003e\" #Optional \n\nresult = loginradius.authentication.verify_email(verification_token, fields, url, welcome_email_template, uuid)\n ```\n \n  \n  \n \n\u003ch6 id=\"CheckUserNameAvailability-get-\"\u003e Auth Check UserName Availability (GET)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \nusername = \"\u003cusername\u003e\" #Required\n\nresult = loginradius.authentication.check_user_name_availability(username)\n ```\n \n  \n  \n \n\u003ch6 id=\"AcceptPrivacyPolicy-get-\"\u003e Auth Privacy Policy Accept (GET)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nfields = \"\u003cfields\u003e\" #Optional\n\nresult = loginradius.authentication.accept_privacy_policy(access_token, fields)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetPrivacyPolicyHistoryByAccessToken-get-\"\u003e Auth Privacy Policy History By Access Token (GET)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\n\nresult = loginradius.authentication.get_privacy_policy_history_by_access_token(access_token)\n ```\n \n \u003ch6 id=\"AuthSendVerificationEmailForLinkingSocialProfiles-get-\"\u003e Auth send verification Email for linking social profiles (GET)\u003c/h6\u003e\n\nThis 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/)\n\n ```\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nclientguid = \"\u003cclientguid\u003e\" #Required\n\nresult = loginradius.authentication.auth_send_verification_email_for_linking_social_profiles(access_token, clientguid)\n ```\n  \n  \n \n\u003ch6 id=\"DeleteAccountWithEmailConfirmation-delete-\"\u003e Auth Delete Account with Email Confirmation (DELETE)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \ndelete_url = \"\u003cdelete_url\u003e\" #Optional \nemail_template = \"\u003cemail_template\u003e\" #Optional\n\nresult = loginradius.authentication.delete_account_with_email_confirmation(access_token, delete_url, email_template)\n ```\n \n  \n  \n \n\u003ch6 id=\"RemoveEmail-delete-\"\u003e Auth Remove Email (DELETE)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nemail = \"\u003cemail\u003e\" #Required\n\nresult = loginradius.authentication.remove_email(access_token, email)\n ```\n \n  \n  \n \n\u003ch6 id=\"UnlinkSocialIdentities-delete-\"\u003e Auth Unlink Social Identities (DELETE)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nprovider = \"\u003cprovider\u003e\" #Required \nprovider_id = \"\u003cprovider_id\u003e\" #Required\n\nresult = loginradius.authentication.unlink_social_identities(access_token, provider, provider_id)\n ```\n \n  \n  \n \n\n\n### Account API\n\n\nList of APIs in this Section:\u003cbr\u003e\n\n* PUT : [Account Update](#UpdateAccountByUid-put-)\u003cbr\u003e\n* PUT : [Update Phone ID by UID](#UpdatePhoneIDByUid-put-)\u003cbr\u003e\n* PUT : [Account Set Password](#SetAccountPasswordByUid-put-)\u003cbr\u003e\n* PUT : [Account Invalidate Verification Email](#InvalidateAccountEmailVerification-put-)\u003cbr\u003e\n* PUT : [Reset phone ID verification](#ResetPhoneIDVerificationByUid-put-)\u003cbr\u003e\n* PUT : [Upsert Email](#UpsertEmail-put-)\u003cbr\u003e\n* PUT : [Update UID](#AccountUpdateUid-put-)\u003cbr\u003e\n* POST : [Account Create](#CreateAccount-post-)\u003cbr\u003e\n* POST : [Forgot Password token](#GetForgotPasswordToken-post-)\u003cbr\u003e\n* POST : [Email Verification token](#GetEmailVerificationToken-post-)\u003cbr\u003e\n* POST : [Multipurpose Email Token Generation API](#MultipurposeEmailTokenGeneration-post-)\u003cbr\u003e\n* POST : [Multipurpose SMS OTP Generation API](#MultipurposeSMSOTPGeneration-post-)\u003cbr\u003e\n* GET : [Get Privacy Policy History By Uid](#GetPrivacyPolicyHistoryByUid-get-)\u003cbr\u003e\n* GET : [Account Profiles by Email](#GetAccountProfileByEmail-get-)\u003cbr\u003e\n* GET : [Account Profiles by Username](#GetAccountProfileByUserName-get-)\u003cbr\u003e\n* GET : [Account Profile by Phone ID](#GetAccountProfileByPhone-get-)\u003cbr\u003e\n* GET : [Account Profiles by UID](#GetAccountProfileByUid-get-)\u003cbr\u003e\n* GET : [Account Password](#GetAccountPasswordHashByUid-get-)\u003cbr\u003e\n* GET : [Access Token based on UID or User impersonation API](#GetAccessTokenByUid-get-)\u003cbr\u003e\n* GET : [Refresh Access Token by Refresh Token](#RefreshAccessTokenByRefreshToken-get-)\u003cbr\u003e\n* GET : [Revoke Refresh Token](#RevokeRefreshToken-get-)\u003cbr\u003e\n* GET : [Account Identities by Email](#GetAccountIdentitiesByEmail-get-)\u003cbr\u003e\n* DELETE : [Account Delete](#DeleteAccountByUid-delete-)\u003cbr\u003e\n* DELETE : [Account Remove Email](#RemoveEmail-delete-)\u003cbr\u003e\n* DELETE : [Revoke All Refresh Token](#RevokeAllRefreshToken-delete-)\u003cbr\u003e\n* DELETE : [Delete User Profiles By Email](#AccountDeleteByEmail-delete-)\u003cbr\u003e\n\n\n\n\n\u003ch6 id=\"UpdateAccountByUid-put-\"\u003e Account Update (PUT)\u003c/h6\u003e\n\n This API is used to update the information of existing accounts in your Cloud Storage. See our Advanced API Usage section \u003ca href='https://www.loginradius.com/docs/api/v2/customer-identity-api/advanced-api-usage/'\u003eHere\u003c/a\u003e for more capabilities.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-update)\n\n ```py\n \naccount_user_profile_update_model = { \n\"firstName\" : \"\u003cfirstName\u003e\",\n\"lastName\" : \"\u003clastName\u003e\"\n}  #Required \nuid = \"\u003cuid\u003e\" #Required \nfields = \"\u003cfields\u003e\" #Optional \nnull_support = \"True\" #Optional\n\nresult = loginradius.account.update_account_by_uid(account_user_profile_update_model, uid, fields, null_support)\n ```\n \n  \n  \n \n\u003ch6 id=\"UpdatePhoneIDByUid-put-\"\u003e Update Phone ID by UID (PUT)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nphone = \"\u003cphone\u003e\" #Required \nuid = \"\u003cuid\u003e\" #Required \nfields = \"\u003cfields\u003e\" #Optional\n\nresult = loginradius.account.update_phone_id_by_uid(phone, uid, fields)\n ```\n \n  \n  \n \n\u003ch6 id=\"SetAccountPasswordByUid-put-\"\u003e Account Set Password (PUT)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \npassword = \"\u003cpassword\u003e\" #Required \nuid = \"\u003cuid\u003e\" #Required\n\nresult = loginradius.account.set_account_password_by_uid(password, uid)\n ```\n \n  \n  \n \n\u003ch6 id=\"InvalidateAccountEmailVerification-put-\"\u003e Account Invalidate Verification Email (PUT)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nuid = \"\u003cuid\u003e\" #Required \nemail_template = \"\u003cemail_template\u003e\" #Optional \nverification_url = \"\u003cverification_url\u003e\" #Optional\n\nresult = loginradius.account.invalidate_account_email_verification(uid, email_template, verification_url)\n ```\n \n  \n  \n \n\u003ch6 id=\"ResetPhoneIDVerificationByUid-put-\"\u003e Reset phone ID verification (PUT)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nuid = \"\u003cuid\u003e\" #Required \nsms_template = \"\u003csms_template\u003e\" #Optional \nis_voice_otp = \"False\" #Optional\n\nresult = loginradius.account.reset_phone_id_verification_by_uid(uid, sms_template, is_voice_otp)\n ```\n \n  \n  \n \n\u003ch6 id=\"UpsertEmail-put-\"\u003e Upsert Email (PUT)\u003c/h6\u003e\n\n 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)\n\n ```py\n \nupsert_email_model = { \n\"email\" : [   { \n \"type\" : \"\u003ctype\u003e\"  ,\n \"value\" : \"\u003cvalue\u003e\"   \n}  ] \n}  #Required \nuid = \"\u003cuid\u003e\" #Required \nfields = \"\u003cfields\u003e\" #Optional\n\nresult = loginradius.account.upsert_email(upsert_email_model, uid, fields)\n ```\n \n  \n  \n \n\u003ch6 id=\"AccountUpdateUid-put-\"\u003e Update UID (PUT)\u003c/h6\u003e\n\n 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/)\n\n ```py\n \nupdate_uid_model = { \n\"newUid\" : \"\u003cnewUid\u003e\"\n}  #Required \nuid = \"\u003cuid\u003e\" #Required\n\nresult = loginradius.account.account_update_uid(update_uid_model, uid)\n ```\n \n  \n  \n \n\u003ch6 id=\"CreateAccount-post-\"\u003e Account Create (POST)\u003c/h6\u003e\n\n This API is used to create an account in Cloud Storage. This API bypass the normal email verification process and manually creates the user. \u003cbr\u003e\u003cbr\u003eIn 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)\n\n ```py\n \naccount_create_model = { \n\"email\" : [   { \n \"type\" : \"\u003ctype\u003e\"  ,\n \"value\" : \"\u003cvalue\u003e\"   \n}  ] ,\n\"firstName\" : \"\u003cfirstName\u003e\",\n\"lastName\" : \"\u003clastName\u003e\",\n\"password\" : \"\u003cpassword\u003e\"\n}  #Required \nfields = \"\u003cfields\u003e\" #Optional\n\nresult = loginradius.account.create_account(account_create_model, fields)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetForgotPasswordToken-post-\"\u003e Forgot Password token (POST)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nemail = \"\u003cemail\u003e\" #Required \nemail_template = \"\u003cemail_template\u003e\" #Optional \nreset_password_url = \"\u003creset_password_url\u003e\" #Optional \nsend_email = \"True\" #Optional\n\nresult = loginradius.account.get_forgot_password_token(email, email_template, reset_password_url, send_email)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetEmailVerificationToken-post-\"\u003e Email Verification token (POST)\u003c/h6\u003e\n\n This API Returns an Email Verification token.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/get-email-verification-token)\n\n ```py\n  \nemail = \"\u003cemail\u003e\" #Required\n\nresult = loginradius.account.get_email_verification_token(email)\n ```\n \n\n\u003ch6 id=\"MultipurposeEmailTokenGeneration-post-\"\u003e Multipurpose Email Token Generation API (POST)\u003c/h6\u003e\n\nThis 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/)\n\n ```py\n \nmulti_email_token = { \n\"clientguid\" : \"\u003cclientguid\u003e\",\n\"email\" : \"\u003cemail\u003e\",\n\"name\" : \"\u003cname\u003e\",\n\"type\" : \"\u003ctype\u003e\",\n\"uid\" : \"\u003cuid\u003e\",\n\"userName\" : \"\u003cuserName\u003e\"\n}  #Required \ntokentype = \"\u003ctokentype\u003e\" #Required\n\nresult = loginradius.account.multipurpose_email_token_generation(multi_email_token, tokentype)\n ```\n \n  \n  \n \n\u003ch6 id=\"MultipurposeSMSOTPGeneration-post-\"\u003e Multipurpose SMS OTP Generation API (POST)\u003c/h6\u003e\n\nThis 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/)\n\n ```py\n \nmulti_sms_otp = { \n\"name\" : \"\u003cname\u003e\",\n\"phone\" : \"\u003cphone\u003e\",\n\"uid\" : \"\u003cuid\u003e\"\n}  #Required \nsmsotptype = \"\u003csmsotptype\u003e\" #Required\n\nresult = loginradius.account.multipurpose_sms_otp_generation(multi_sms_otp, smsotptype)\n ```\n  \n \n\u003ch6 id=\"GetPrivacyPolicyHistoryByUid-get-\"\u003e Get Privacy Policy History By Uid (GET)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \nuid = \"\u003cuid\u003e\" #Required\n\nresult = loginradius.account.get_privacy_policy_history_by_uid(uid)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetAccountProfileByEmail-get-\"\u003e Account Profiles by Email (GET)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nemail = \"\u003cemail\u003e\" #Required \nfields = \"\u003cfields\u003e\" #Optional\n\nresult = loginradius.account.get_account_profile_by_email(email, fields)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetAccountProfileByUserName-get-\"\u003e Account Profiles by Username (GET)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nuser_name = \"\u003cuser_name\u003e\" #Required \nfields = \"\u003cfields\u003e\" #Optional\n\nresult = loginradius.account.get_account_profile_by_user_name(user_name, fields)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetAccountProfileByPhone-get-\"\u003e Account Profile by Phone ID (GET)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \nphone = \"\u003cphone\u003e\" #Required \nfields = \"\u003cfields\u003e\" #Optional\n\nresult = loginradius.account.get_account_profile_by_phone(phone, fields)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetAccountProfileByUid-get-\"\u003e Account Profiles by UID (GET)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nuid = \"\u003cuid\u003e\" #Required \nfields = \"\u003cfields\u003e\" #Optional\n\nresult = loginradius.account.get_account_profile_by_uid(uid, fields)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetAccountPasswordHashByUid-get-\"\u003e Account Password (GET)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nuid = \"\u003cuid\u003e\" #Required\n\nresult = loginradius.account.get_account_password_hash_by_uid(uid)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetAccessTokenByUid-get-\"\u003e Access Token based on UID or User impersonation API (GET)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nuid = \"\u003cuid\u003e\" #Required\n\nresult = loginradius.account.get_access_token_by_uid(uid)\n ```\n \n  \n  \n \n\u003ch6 id=\"RefreshAccessTokenByRefreshToken-get-\"\u003e Refresh Access Token by Refresh Token (GET)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nrefresh_token = \"\u003crefresh_token\u003e\" #Required\n\nresult = loginradius.account.refresh_access_token_by_refresh_token(refresh_token)\n ```\n \n  \n  \n \n\u003ch6 id=\"RevokeRefreshToken-get-\"\u003e Revoke Refresh Token (GET)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nrefresh_token = \"\u003crefresh_token\u003e\" #Required\n\nresult = loginradius.account.revoke_refresh_token(refresh_token)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetAccountIdentitiesByEmail-get-\"\u003e Account Identities by Email (GET)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nemail = \"\u003cemail\u003e\" #Required \nfields = \"\u003cfields\u003e\" #Optional\n\nresult = loginradius.account.get_account_identities_by_email(email, fields)\n ```\n \n  \n  \n \n\u003ch6 id=\"DeleteAccountByUid-delete-\"\u003e Account Delete (DELETE)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nuid = \"\u003cuid\u003e\" #Required\n\nresult = loginradius.account.delete_account_by_uid(uid)\n ```\n \n  \n  \n \n\u003ch6 id=\"RemoveEmail-delete-\"\u003e Account Remove Email (DELETE)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nemail = \"\u003cemail\u003e\" #Required \nuid = \"\u003cuid\u003e\" #Required \nfields = \"\u003cfields\u003e\" #Optional\n\nresult = loginradius.account.remove_email(email, uid, fields)\n ```\n \n\u003ch6 id=\"RevokeAllRefreshToken-delete-\"\u003e Revoke All Refresh Token (DELETE)\u003c/h6\u003e\n\nThe 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/)\n\n ```\n  \nuid = \"\u003cuid\u003e\" #Required\n\nresult = loginradius.account.revoke_all_refresh_token(uid)\n ```\n  \n \n\u003ch6 id=\"AccountDeleteByEmail-delete-\"\u003e Delete User Profiles By Email (DELETE)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \nemail = \"\u003cemail\u003e\" #Required\n\nresult = loginradius.account.account_delete_by_email(email)\n ```\n \n  \n  \n \n\n\n### Social API\n\n\nList of APIs in this Section:\u003cbr\u003e\n\n* GET : [Access Token](#ExchangeAccessToken-get-)\u003cbr\u003e\n* GET : [Refresh Token](#RefreshAccessToken-get-)\u003cbr\u003e\n* GET : [Token Validate](#ValidateAccessToken-get-)\u003cbr\u003e\n* GET : [Access Token Invalidate](#InValidateAccessToken-get-)\u003cbr\u003e\n* GET : [Get Active Session Details](#GetActiveSession-get-)\u003cbr\u003e\n* GET : [Get Active Session By Account Id](#GetActiveSessionByAccountID-get-)\u003cbr\u003e\n* GET : [Get Active Session By Profile Id](#GetActiveSessionByProfileID-get-)\u003cbr\u003e\n \n  \n  \n \n\u003ch6 id=\"ExchangeAccessToken-get-\"\u003e Access Token (GET)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \ntoken = \"\u003ctoken\u003e\" #Required\n\nresult = loginradius.social.exchange_access_token(token)\n ```\n \n  \n  \n \n\u003ch6 id=\"RefreshAccessToken-get-\"\u003e Refresh Token (GET)\u003c/h6\u003e\n\n 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.\u003cbr\u003e\u003cbr\u003e\u003cb\u003eSupported Providers :\u003c/b\u003e Facebook,Yahoo,Google,Twitter, Linkedin.\u003cbr\u003e\u003cbr\u003e Contact LoginRadius support team to enable this API.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/refresh-token/refresh-token)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nexpires_in = 0 #Optional \nis_web = \"True\" #Optional\n\nresult = loginradius.social.refresh_access_token(access_token, expires_in, is_web)\n ```\n \n  \n  \n \n\u003ch6 id=\"ValidateAccessToken-get-\"\u003e Token Validate (GET)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\n\nresult = loginradius.social.validate_access_token(access_token)\n ```\n \n  \n  \n \n\u003ch6 id=\"InValidateAccessToken-get-\"\u003e Access Token Invalidate (GET)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\n\nresult = loginradius.social.in_validate_access_token(access_token)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetActiveSession-get-\"\u003e Get Active Session Details (GET)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \ntoken = \"\u003ctoken\u003e\" #Required\n\nresult = loginradius.social.get_active_session(token)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetActiveSessionByAccountID-get-\"\u003e Get Active Session By Account Id (GET)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \naccount_id = \"\u003caccount_id\u003e\" #Required\n\nresult = loginradius.social.get_active_session_by_account_id(account_id)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetActiveSessionByProfileID-get-\"\u003e Get Active Session By Profile Id (GET)\u003c/h6\u003e\n\n 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/)\n\n ```py\n  \nprofile_id = \"\u003cprofile_id\u003e\" #Required\n\nresult = loginradius.social.get_active_session_by_profile_id(profile_id)\n ```\n \n  \n  \n \n\n\n### CustomObject API\n\n\nList of APIs in this Section:\u003cbr\u003e\n\n* PUT : [Custom Object Update by Access Token](#UpdateCustomObjectByToken-put-)\u003cbr\u003e\n* PUT : [Custom Object Update by UID](#UpdateCustomObjectByUid-put-)\u003cbr\u003e\n* POST : [Create Custom Object by Token](#CreateCustomObjectByToken-post-)\u003cbr\u003e\n* POST : [Create Custom Object by UID](#CreateCustomObjectByUid-post-)\u003cbr\u003e\n* GET : [Custom Object by Token](#GetCustomObjectByToken-get-)\u003cbr\u003e\n* GET : [Custom Object by ObjectRecordId and Token](#GetCustomObjectByRecordIDAndToken-get-)\u003cbr\u003e\n* GET : [Custom Object By UID](#GetCustomObjectByUid-get-)\u003cbr\u003e\n* GET : [Custom Object by ObjectRecordId and UID](#GetCustomObjectByRecordID-get-)\u003cbr\u003e\n* DELETE : [Custom Object Delete by Record Id And Token](#DeleteCustomObjectByToken-delete-)\u003cbr\u003e\n* DELETE : [Account Delete Custom Object by ObjectRecordId](#DeleteCustomObjectByRecordID-delete-)\u003cbr\u003e\n\n\n\n\n\u003ch6 id=\"UpdateCustomObjectByToken-put-\"\u003e Custom Object Update by Access Token (PUT)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nobject_name = \"\u003cobject_name\u003e\" #Required \nobject_record_id = \"\u003cobject_record_id\u003e\" #Required\nobject = { \"customdata1\": \"Store my customdata1 value\"}  #Required \nupdate_type = \"\u003cupdate_type\u003e\" #Optional\n\nresult = loginradius.custom_object.update_custom_object_by_token(access_token, object_name, object_record_id, object, update_type)\n ```\n \n  \n  \n \n\u003ch6 id=\"UpdateCustomObjectByUid-put-\"\u003e Custom Object Update by UID (PUT)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nobject_name = \"\u003cobject_name\u003e\" #Required \nobject_record_id = \"\u003cobject_record_id\u003e\" #Required\nobject = { \"customdata1\": \"Store my customdata1 value\"}  #Required \nuid = \"\u003cuid\u003e\" #Required \nupdate_type = \"\u003cupdate_type\u003e\" #Optional\n\nresult = loginradius.custom_object.update_custom_object_by_uid(object_name, object_record_id, object, uid, update_type)\n ```\n \n  \n  \n \n\u003ch6 id=\"CreateCustomObjectByToken-post-\"\u003e Create Custom Object by Token (POST)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nobject_name = \"\u003cobject_name\u003e\" #Required\nobject = { \"customdata1\": \"Store my customdata1 value\"}  #Required\n\nresult = loginradius.custom_object.create_custom_object_by_token(access_token, object_name, object)\n ```\n \n  \n  \n \n\u003ch6 id=\"CreateCustomObjectByUid-post-\"\u003e Create Custom Object by UID (POST)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nobject_name = \"\u003cobject_name\u003e\" #Required\nobject = { \"customdata1\": \"Store my customdata1 value\"}  #Required \nuid = \"\u003cuid\u003e\" #Required\n\nresult = loginradius.custom_object.create_custom_object_by_uid(object_name, object, uid)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetCustomObjectByToken-get-\"\u003e Custom Object by Token (GET)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nobject_name = \"\u003cobject_name\u003e\" #Required\n\nresult = loginradius.custom_object.get_custom_object_by_token(access_token, object_name)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetCustomObjectByRecordIDAndToken-get-\"\u003e Custom Object by ObjectRecordId and Token (GET)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nobject_name = \"\u003cobject_name\u003e\" #Required \nobject_record_id = \"\u003cobject_record_id\u003e\" #Required\n\nresult = loginradius.custom_object.get_custom_object_by_record_id_and_token(access_token, object_name, object_record_id)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetCustomObjectByUid-get-\"\u003e Custom Object By UID (GET)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nobject_name = \"\u003cobject_name\u003e\" #Required \nuid = \"\u003cuid\u003e\" #Required\n\nresult = loginradius.custom_object.get_custom_object_by_uid(object_name, uid)\n ```\n \n  \n  \n \n\u003ch6 id=\"GetCustomObjectByRecordID-get-\"\u003e Custom Object by ObjectRecordId and UID (GET)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nobject_name = \"\u003cobject_name\u003e\" #Required \nobject_record_id = \"\u003cobject_record_id\u003e\" #Required \nuid = \"\u003cuid\u003e\" #Required\n\nresult = loginradius.custom_object.get_custom_object_by_record_id(object_name, object_record_id, uid)\n ```\n \n  \n  \n \n\u003ch6 id=\"DeleteCustomObjectByToken-delete-\"\u003e Custom Object Delete by Record Id And Token (DELETE)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nobject_name = \"\u003cobject_name\u003e\" #Required \nobject_record_id = \"\u003cobject_record_id\u003e\" #Required\n\nresult = loginradius.custom_object.delete_custom_object_by_token(access_token, object_name, object_record_id)\n ```\n \n  \n  \n \n\u003ch6 id=\"DeleteCustomObjectByRecordID-delete-\"\u003e Account Delete Custom Object by ObjectRecordId (DELETE)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nobject_name = \"\u003cobject_name\u003e\" #Required \nobject_record_id = \"\u003cobject_record_id\u003e\" #Required \nuid = \"\u003cuid\u003e\" #Required\n\nresult = loginradius.custom_object.delete_custom_object_by_record_id(object_name, object_record_id, uid)\n ```\n \n  \n  \n \n\n\n### PhoneAuthentication API\n\n\nList of APIs in this Section:\u003cbr\u003e\n\n* PUT : [Phone Reset Password by OTP](#ResetPasswordByPhoneOTP-put-)\u003cbr\u003e\n* PUT : [Phone Verification OTP](#PhoneVerificationByOTP-put-)\u003cbr\u003e\n* PUT : [Phone Verification OTP by Token](#PhoneVerificationOTPByAccessToken-put-)\u003cbr\u003e\n* PUT : [Phone Number Update](#UpdatePhoneNumber-put-)\u003cbr\u003e\n* POST : [Phone Login](#LoginByPhone-post-)\u003cbr\u003e\n* POST : [Phone Forgot Password by OTP](#ForgotPasswordByPhoneOTP-post-)\u003cbr\u003e\n* POST : [Phone Resend Verification OTP](#PhoneResendVerificationOTP-post-)\u003cbr\u003e\n* POST : [Phone Resend Verification OTP By Token](#PhoneResendVerificationOTPByToken-post-)\u003cbr\u003e\n* POST : [Phone User Registration by SMS](#UserRegistrationByPhone-post-)\u003cbr\u003e\n* GET : [Phone Number Availability](#CheckPhoneNumberAvailability-get-)\u003cbr\u003e\n* DELETE : [Remove Phone ID by Access Token](#RemovePhoneIDByAccessToken-delete-)\u003cbr\u003e\n\n\n\n\n\u003ch6 id=\"ResetPasswordByPhoneOTP-put-\"\u003e Phone Reset Password by OTP (PUT)\u003c/h6\u003e\n\n 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)\n\n ```py\n \nreset_password_by_otp_model = { \n\"otp\" : \"\u003cotp\u003e\",\n\"password\" : \"\u003cpassword\u003e\",\n\"phone\" : \"\u003cphone\u003e\"\n}  #Required\n\nresult = loginradius.phone_authentication.reset_password_by_phone_otp(reset_password_by_otp_model)\n ```\n \n  \n  \n \n\u003ch6 id=\"PhoneVerificationByOTP-put-\"\u003e Phone Verification OTP (PUT)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \notp = \"\u003cotp\u003e\" #Required \nphone = \"\u003cphone\u003e\" #Required \nfields = \"\u003cfields\u003e\" #Optional \nsms_template = \"\u003csms_template\u003e\" #Optional \nis_voice_otp = \"False\" #Optional\n\nresult = loginradius.phone_authentication.phone_verification_by_otp(otp, phone, fields, sms_template, is_voice_otp)\n ```\n \n  \n  \n \n\u003ch6 id=\"PhoneVerificationOTPByAccessToken-put-\"\u003e Phone Verification OTP by Token (PUT)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \notp = \"\u003cotp\u003e\" #Required \nsms_template = \"\u003csms_template\u003e\" #Optional \nis_voice_otp = \"False\" #Optional\n\nresult = loginradius.phone_authentication.phone_verification_otp_by_access_token(access_token, otp, sms_template, is_voice_otp)\n ```\n \n  \n  \n \n\u003ch6 id=\"UpdatePhoneNumber-put-\"\u003e Phone Number Update (PUT)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nphone = \"\u003cphone\u003e\" #Required \nsms_template = \"\u003csms_template\u003e\" #Optional\nis_voice_otp = \"False\" #Optional\nresult = loginradius.phone_authentication.update_phone_number(access_token, phone, sms_template,is_voice_otp)\n ```\n \n  \n  \n \n\u003ch6 id=\"LoginByPhone-post-\"\u003e Phone Login (POST)\u003c/h6\u003e\n\n 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)\n\n ```py\n \nphone_authentication_model = { \n\"password\" : \"\u003cpassword\u003e\",\n\"phone\" : \"\u003cphone\u003e\"\n}  #Required \nfields = \"\u003cfields\u003e\" #Optional \nlogin_url = \"\u003clogin_url\u003e\" #Optional \nsms_template = \"\u003csms_template\u003e\" #Optional\n\nresult = loginradius.phone_authentication.login_by_phone(phone_authentication_model, fields, login_url, sms_template)\n ```\n \n  \n  \n \n\u003ch6 id=\"ForgotPasswordByPhoneOTP-post-\"\u003e Phone Forgot Password by OTP (POST)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nphone = \"\u003cphone\u003e\" #Required \nsms_template = \"\u003csms_template\u003e\" #Optional \nis_voice_otp = \"False\" #Optional\n\nresult = loginradius.phone_authentication.forgot_password_by_phone_otp(phone, sms_template, is_voice_otp)\n ```\n \n  \n  \n \n\u003ch6 id=\"PhoneResendVerificationOTP-post-\"\u003e Phone Resend Verification OTP (POST)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \nphone = \"\u003cphone\u003e\" #Required \nsms_template = \"\u003csms_template\u003e\" #Optional \nis_voice_otp = \"False\" #Optional\n\nresult = loginradius.phone_authentication.phone_resend_verification_otp(phone, sms_template, is_voice_otp)\n ```\n \n  \n  \n \n\u003ch6 id=\"PhoneResendVerificationOTPByToken-post-\"\u003e Phone Resend Verification OTP By Token (POST)\u003c/h6\u003e\n\n 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)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nphone = \"\u003cphone\u003e\" #Required \nsms_template = \"\u003csms_template\u003e\" #Optional\n\nresult = loginradius.phone_authentication.phone_resend_verification_otp_by_token(access_token, phone, sms_template)\n ```\n \n  \n  \n \n\u003ch6 id=\"UserRegistrationByPhone-post-\"\u003e Phone User Registration by SMS (POST)\u003c/h6\u003e\n\n 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)\n\n ```py\n \nauth_user_registration_model = { \n\"email\" : [   { \n \"type\" : \"\u003ctype\u003e\"  ,\n \"value\" : \"\u003cvalue\u003e\"   \n}  ] ,\n\"firstName\" : \"\u003cfirstName\u003e\",\n\"lastName\" : \"\u003clastName\u003e\",\n\"password\" : \"\u003cpassword\u003e\",\n\"phoneId\" : \"\u003cphoneId\u003e\"\n}  #Required \nsott = \"\u003csott\u003e\" #Required \nfields = \"\u003cfields\u003e\" #Optional \noptions = \"\u003coptions\u003e\" #Optional \nsms_template = \"\u003csms_template\u003e\" #Optional \nverification_url = \"\u003cverification_url\u003e\" #Optional \nwelcome_email_template = \"\u003cwelcome_email_template\u003e\" #Optional \nemail_template = \"\u003cemail_template\u003e\" #Optional \nis_voice_otp = \"False\" #Optional\n\nresult = 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)\n ```\n \n  \n  \n \n\u003ch6 id=\"CheckPhoneNumberAvailability-get-\"\u003e Phone Number Availability (GET)\u003c/h6\u003e\n\n This API is used to check the Phone Number exists or not on your site.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-number-availability)\n\n ```py\n  \nphone = \"\u003cphone\u003e\" #Required\n\nresult = loginradius.phone_authentication.check_phone_number_availability(phone)\n ```\n \n  \n  \n \n\u003ch6 id=\"RemovePhoneIDByAccessToken-delete-\"\u003e Remove Phone ID by Access Token (DELETE)\u003c/h6\u003e\n\n This API is used to delete the Phone ID on a user's account via the access token  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/remove-phone-id-by-access-token)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\n\nresult = loginradius.phone_authentication.remove_phone_id_by_access_token(access_token)\n ```\n \n  \n  \n \n\n\n### MultiFactorAuthentication API\n\n\nList of APIs in this Section:\u003cbr\u003e\n\n* PUT : [Update MFA Setting](#MFAUpdateSetting-put-)\u003cbr\u003e\n* PUT : [MFA Update Phone Number by Token](#MFAUpdatePhoneNumberByToken-put-)\u003cbr\u003e\n* PUT : [Verify MFA Email OTP by Access Token](#MFAValidateEmailOtpByAccessToken-put-)\u003cbr\u003e\n* PUT : [Update MFA Security Question by Access Token](#MFASecurityQuestionAnswerByAccessToken-put-)\u003cbr\u003e\n* PUT : [MFA Validate OTP](#MFAValidateOTPByPhone-put-)\u003cbr\u003e\n* PUT : [MFA Validate Backup code](#MFAValidateBackupCode-put-)\u003cbr\u003e\n* PUT : [MFA Update Phone Number](#MFAUpdatePhoneNumber-put-)\u003cbr\u003e\n* PUT : [Verify MFA Email OTP by MFA Token](#MFAValidateEmailOtp-put-)\u003cbr\u003e\n* PUT : [Update MFA Security Question by MFA Token](#MFASecurityQuestionAnswer-put-)\u003cbr\u003e\n* PUT : [MFA Validate Authenticator Code](#MFAValidateAuthenticatorCode-put-)\u003cbr\u003e\n* PUT : [MFA Verify Authenticator Code](#MFAVerifyAuthenticatorCode-put-)\u003cbr\u003e\n* POST : [MFA Email Login](#MFALoginByEmail-post-)\u003cbr\u003e\n* POST : [MFA UserName Login](#MFALoginByUserName-post-)\u003cbr\u003e\n* POST : [MFA Phone Login](#MFALoginByPhone-post-)\u003cbr\u003e\n* POST : [Send MFA Email OTP by MFA Token](#MFAEmailOTP-post-)\u003cbr\u003e\n* POST : [Verify MFA Security Question by MFA Token](#MFASecurityQuestionAnswerVerification-post-)\u003cbr\u003e\n* GET : [MFA Validate Access Token](#MFAConfigureByAccessToken-get-)\u003cbr\u003e\n* GET : [MFA Backup Code by Access Token](#MFABackupCodeByAccessToken-get-)\u003cbr\u003e\n* GET : [Reset Backup Code by Access Token](#MFAResetBackupCodeByAccessToken-get-)\u003cbr\u003e\n* GET : [Send MFA Email OTP by Access Token](#MFAEmailOtpByAccessToken-get-)\u003cbr\u003e\n* GET : [MFA Resend Otp](#MFAResendOTP-get-)\u003cbr\u003e\n* GET : [MFA Backup Code by UID](#MFABackupCodeByUid-get-)\u003cbr\u003e\n* GET : [MFA Reset Backup Code by UID](#MFAResetBackupCodeByUid-get-)\u003cbr\u003e\n* DELETE : [MFA Reset Authenticator by Token](#MFAResetAuthenticatorByToken-delete-)\u003cbr\u003e\n* DELETE : [MFA Reset SMS Authenticator by Token](#MFAResetSMSAuthByToken-delete-)\u003cbr\u003e\n* DELETE : [Reset MFA Email OTP Authenticator By Access Token](#MFAResetEmailOtpAuthenticatorByAccessToken-delete-)\u003cbr\u003e\n* DELETE : [MFA Reset Security Question Authenticator By Access Token](#MFAResetSecurityQuestionAuthenticatorByAccessToken-delete-)\u003cbr\u003e\n* DELETE : [MFA Reset SMS Authenticator By UID](#MFAResetSMSAuthenticatorByUid-delete-)\u003cbr\u003e\n* DELETE : [MFA Reset Authenticator By UID](#MFAResetAuthenticatorByUid-delete-)\u003cbr\u003e\n* DELETE : [Reset MFA Email OTP Authenticator Settings by Uid](#MFAResetEmailOtpAuthenticatorByUid-delete-)\u003cbr\u003e\n* DELETE : [Reset MFA Security Question Authenticator Settings by Uid](#MFAResetSecurityQuestionAuthenticatorByUid-delete-)\u003cbr\u003e\n\n\n\n\n\u003ch6 id=\"MFAUpdateSetting-put-\"\u003e Update MFA Setting (PUT)\u003c/h6\u003e\n\n This API is used to trigger the Multi-factor authentication settings after login for secure actions  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/update-mfa-setting/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\nmulti_factor_auth_model_with_lockout = { \n\"otp\" : \"\u003cotp\u003e\"\n}  #Required \nfields = \"\u003cfields\u003e\" #Optional\n\nresult = loginradius.mfa.mfa_update_setting(access_token, multi_factor_auth_model_with_lockout, fields)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAUpdatePhoneNumberByToken-put-\"\u003e MFA Update Phone Number by Token (PUT)\u003c/h6\u003e\n\n This API is used to update the Multi-factor authentication phone number by sending the verification OTP to the provided phone number  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/mfa-update-phone-number-by-token/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nphone_no2_f_a = \"\u003cphone_no2_f_a\u003e\" #Required \nsms_template2_f_a = \"\u003csms_template2_f_a\u003e\" #Optional \nis_voice_otp = \"False\" #Optional\noptions = \"\u003coptions\u003e\" #Optional \n\nresult = loginradius.mfa.mfa_update_phone_number_by_token(access_token, phone_no2_f_a, sms_template2_f_a, is_voice_otp,options)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAValidateEmailOtpByAccessToken-put-\"\u003e Verify MFA Email OTP by Access Token (PUT)\u003c/h6\u003e\n\n This API is used to set up MFA Email OTP authenticator on profile after login.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/verify-mfa-otp-by-access-token/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\nmulti_factor_auth_model_by_email_otp_with_lockout = { \n\"EmailId\":\"emailId\",\n\"Otp\":\"otp\"\n}  #Required\n\nresult = loginradius.mfa.mfa_validate_email_otp_by_access_token(access_token, multi_factor_auth_model_by_email_otp_with_lockout)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFASecurityQuestionAnswerByAccessToken-put-\"\u003e Update MFA Security Question by Access Token (PUT)\u003c/h6\u003e\n\n This API is used to set up MFA Security Question authenticator on profile after login.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/update-mfa-security-question-by-access-token)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\nsecurity_question_answer_model_by_access_token = { \n   \"securityquestionanswer\": [\n        {\n            \"QuestionId\": \"db7****8a73e4******bd9****8c20\",\n            \"Answer\": \"\u003canswer\u003e\"\n        }\n    ],\n     \"ReplaceSecurityQuestionAnswer\":\"True\" \n}  #Required\n\nresult = loginradius.mfa.mfa_security_question_answer_by_access_token(access_token, security_question_answer_model_by_access_token)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAValidateOTPByPhone-put-\"\u003e MFA Validate OTP (PUT)\u003c/h6\u003e\n\n This API is used to login via Multi-factor authentication by passing the One Time Password received via SMS  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/mfa-validate-otp/)\n\n ```py\n \nmulti_factor_auth_model_with_lockout = { \n\"otp\" : \"\u003cotp\u003e\"\n}  #Required \nsecond_factor_authentication_token = \"\u003csecond_factor_authentication_token\u003e\" #Required \nfields = \"\u003cfields\u003e\" #Optional \nsms_template2_f_a = \"\u003csms_template2_f_a\u003e\" #Optional\nrba_browser_email_template = \"\u003crba_browser_email_template\u003e\" #Optional \nrba_city_email_template = \"\u003crba_city_email_template\u003e\" #Optional \nrba_country_email_template = \"\u003crba_country_email_template\u003e\" #Optional \nrba_ip_email_template = \"\u003crba_ip_email_template\u003e\" #Optional \n\nresult = 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)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAValidateBackupCode-put-\"\u003e MFA Validate Backup code (PUT)\u003c/h6\u003e\n\n This API is used to validate the backup code provided by the user and if valid, we return an access token allowing the user to login incases where Multi-factor authentication (MFA) is enabled and the secondary factor is unavailable. When a user initially downloads the Backup codes, We generate 10 codes, each code can only be consumed once. if any user attempts to go over the number of invalid login attempts configured in the Dashboard then the account gets blocked automatically  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/mfa-validate-backup-code/)\n\n ```py\n \nmulti_factor_auth_model_by_backup_code = { \n\"backupCode\" : \"\u003cbackupCode\u003e\"\n}  #Required \nsecond_factor_authentication_token = \"\u003csecond_factor_authentication_token\u003e\" #Required \nfields = \"\u003cfields\u003e\" #Optional \nrba_browser_email_template = \"\u003crba_browser_email_template\u003e\" #Optional \nrba_city_email_template = \"\u003crba_city_email_template\u003e\" #Optional \nrba_country_email_template = \"\u003crba_country_email_template\u003e\" #Optional \nrba_ip_email_template = \"\u003crba_ip_email_template\u003e\" #Optional\n\nresult = 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)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAUpdatePhoneNumber-put-\"\u003e MFA Update Phone Number (PUT)\u003c/h6\u003e\n\n 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](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/mfa-update-phone-number/)\n\n ```py\n  \nphone_no2_f_a = \"\u003cphone_no2_f_a\u003e\" #Required \nsecond_factor_authentication_token = \"\u003csecond_factor_authentication_token\u003e\" #Required \nsms_template2_f_a = \"\u003csms_template2_f_a\u003e\" #Optional \nis_voice_otp = \"False\" #Optional\noptions = \"\u003coptions\u003e\" #Optional \n\nresult = loginradius.mfa.mfa_update_phone_number(phone_no2_f_a, second_factor_authentication_token, sms_template2_f_a, is_voice_otp, options)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAValidateEmailOtp-put-\"\u003e Verify MFA Email OTP by MFA Token (PUT)\u003c/h6\u003e\n\n This API is used to Verify MFA Email OTP by MFA Token  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/verify-mfa-email-otp-by-mfa-token/)\n\n ```py\n \nmulti_factor_auth_model_by_email_otp = { \n\n    \"EmailId\":\"email\",\n    \"Otp\":\"otp\"\n}  #Required \nsecond_factor_authentication_token = \"\u003csecond_factor_authentication_token\u003e\" #Required \nrba_browser_email_template = \"\u003crba_browser_email_template\u003e\" #Optional \nrba_city_email_template = \"\u003crba_city_email_template\u003e\" #Optional \nrba_country_email_template = \"\u003crba_country_email_template\u003e\" #Optional \nrba_ip_email_template = \"\u003crba_ip_email_template\u003e\" #Optional\n\nresult = 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)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFASecurityQuestionAnswer-put-\"\u003e Update MFA Security Question by MFA Token (PUT)\u003c/h6\u003e\n\n This API is used to set the security questions on the profile with the MFA token when MFA flow is required.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/update-mfa-security-question-by-mfa-token/)\n\n ```py\n \nsecurity_question_answer_update_model = { \n   \"securityquestionanswer\": [\n        {\n            \"QuestionId\": \"db7****8a73e4******bd9****8c20\",\n            \"Answer\": \"\u003canswer\u003e\"\n        }\n    ]\n}  #Required \nsecond_factor_authentication_token = \"\u003csecond_factor_authentication_token\u003e\" #Required\n\nresult = loginradius.mfa.mfa_security_question_answer(security_question_answer_update_model, second_factor_authentication_token)\n ```\n \n\u003ch6 id=\"MFAValidateAuthenticatorCode-put-\"\u003e MFA Validate Authenticator Code (PUT)\u003c/h6\u003e\n\nThis API is used to login to a user's account during the second MFA step with an Authenticator Code. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/authenticator/mfa-validate-authenticator-code/)\n\n ```py\n \nmulti_factor_auth_model_by_authenticator_code = {\n  \"authenticatorCode\" : \"\u003cauthenticatorCode\u003e\"\n }  #Required \nsecondfactorauthenticationtoken = \"\u003csecondfactorauthenticationtoken\u003e\" #Required \nfields = \"\u003cfields\u003e\" #Optional\n\nresult = loginradius.mfa.mfa_validate_authenticator_code(multi_factor_auth_model_by_authenticator_code, secondfactorauthenticationtoken, fields)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAVerifyAuthenticatorCode-put-\"\u003e MFA Verify Authenticator Code (PUT)\u003c/h6\u003e\n\nThis API is used to validate an Authenticator Code as part of the MFA process. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/authenticator/mfa-verify-authenticator-code/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\nmulti_factor_auth_model_by_authenticator_code_security_answer = { \n\"authenticatorCode\" : \"\u003cauthenticatorCode\u003e\"\n}  #Required \nfields = \"\u003cfields\u003e\" #Optional\n\nresult = loginradius.mfa.mfa_verify_authenticator_code(access_token, multi_factor_auth_model_by_authenticator_code_security_answer, fields)\n ```\n  \n \n\u003ch6 id=\"MFALoginByEmail-post-\"\u003e MFA Email Login (POST)\u003c/h6\u003e\n\n This API can be used to login by emailid on a Multi-factor authentication enabled LoginRadius site.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/mfa-email-login)\n\n ```py\n  \nemail = \"\u003cemail\u003e\" #Required \npassword = \"\u003cpassword\u003e\" #Required \nemail_template = \"\u003cemail_template\u003e\" #Optional \nfields = \"\u003cfields\u003e\" #Optional \nlogin_url = \"\u003clogin_url\u003e\" #Optional \nsms_template = \"\u003csms_template\u003e\" #Optional \nsms_template2_f_a = \"\u003csms_template2_f_a\u003e\" #Optional \nverification_url = \"\u003cverification_url\u003e\" #Optional\nemail_template2_f_a = \"\u003cemail_template2_f_a\u003e\" #Optional \nis_voice_otp = \"False\" #Optional\noptions = \"\u003coptions\u003e\" #Optional \n\nresult = 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)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFALoginByUserName-post-\"\u003e MFA UserName Login (POST)\u003c/h6\u003e\n\n This API can be used to login by username on a Multi-factor authentication enabled LoginRadius site.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/mfa-user-name-login)\n\n ```py\n  \npassword = \"\u003cpassword\u003e\" #Required \nusername = \"\u003cusername\u003e\" #Required \nemail_template = \"\u003cemail_template\u003e\" #Optional \nfields = \"\u003cfields\u003e\" #Optional \nlogin_url = \"\u003clogin_url\u003e\" #Optional \nsms_template = \"\u003csms_template\u003e\" #Optional \nsms_template2_f_a = \"\u003csms_template2_f_a\u003e\" #Optional \nverification_url = \"\u003cverification_url\u003e\" #Optional\nemail_template2_f_a = \"\u003cemail_template2_f_a\u003e\" #Optional \nis_voice_otp = \"False\" #Optional\n\nresult = 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)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFALoginByPhone-post-\"\u003e MFA Phone Login (POST)\u003c/h6\u003e\n\n This API can be used to login by Phone on a Multi-factor authentication enabled LoginRadius site.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/mfa-phone-login)\n\n ```py\n  \npassword = \"\u003cpassword\u003e\" #Required \nphone = \"\u003cphone\u003e\" #Required \nemail_template = \"\u003cemail_template\u003e\" #Optional \nfields = \"\u003cfields\u003e\" #Optional \nlogin_url = \"\u003clogin_url\u003e\" #Optional \nsms_template = \"\u003csms_template\u003e\" #Optional \nsms_template2_f_a = \"\u003csms_template2_f_a\u003e\" #Optional \nverification_url = \"\u003cverification_url\u003e\" #Optional\nemail_template2_f_a = \"\u003cemail_template2_f_a\u003e\" #Optional \nis_voice_otp = \"False\" #Optional\noptions = \"\u003coptions\u003e\" #Optional \n\nresult = 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)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAEmailOTP-post-\"\u003e Send MFA Email OTP by MFA Token (POST)\u003c/h6\u003e\n\n An API designed to send the MFA Email OTP to the email.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/send-mfa-email-otp-by-mfa-token/)\n\n ```py\n \nemail_id_model = {\n  \"EmailId\":\"email\"\n }  #Required \nsecond_factor_authentication_token = \"\u003csecond_factor_authentication_token\u003e\" #Required \nemail_template2_f_a = \"\u003cemail_template2_f_a\u003e\" #Optional\n\nresult = loginradius.mfa.mfa_email_otp(email_id_model, second_factor_authentication_token, email_template2_f_a)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFASecurityQuestionAnswerVerification-post-\"\u003e Verify MFA Security Question by MFA Token (POST)\u003c/h6\u003e\n\n This API is used to resending the verification OTP to the provided phone number  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/verify-mfa-security-question-by-mfa-token/)\n\n ```py\n \nsecurity_question_answer_update_model = {\n   \"securityquestionanswer\": [\n        {\n            \"QuestionId\": \"db7****8a73e4******bd9****8c20\",\n            \"Answer\": \"\u003canswer\u003e\"\n        }\n    ]\n }  #Required \nsecond_factor_authentication_token = \"\u003csecond_factor_authentication_token\u003e\" #Required \nrba_browser_email_template = \"\u003crba_browser_email_template\u003e\" #Optional \nrba_city_email_template = \"\u003crba_city_email_template\u003e\" #Optional \nrba_country_email_template = \"\u003crba_country_email_template\u003e\" #Optional \nrba_ip_email_template = \"\u003crba_ip_email_template\u003e\" #Optional\n\nresult = 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)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAConfigureByAccessToken-get-\"\u003e MFA Validate Access Token (GET)\u003c/h6\u003e\n\n 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](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/mfa-validate-access-token/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nis_voice_otp = \"False\" #Optional\n\nresult = loginradius.mfa.mfa_configure_by_access_token(access_token, is_voice_otp)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFABackupCodeByAccessToken-get-\"\u003e MFA Backup Code by Access Token (GET)\u003c/h6\u003e\n\n 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](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/mfa-backup-code-by-access-token/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\n\nresult = loginradius.mfa.mfa_backup_code_by_access_token(access_token)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAResetBackupCodeByAccessToken-get-\"\u003e Reset Backup Code by Access Token (GET)\u003c/h6\u003e\n\n 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](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/mfa-reset-backup-code-by-access-token/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\n\nresult = loginradius.mfa.mfa_reset_backup_code_by_access_token(access_token)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAEmailOtpByAccessToken-get-\"\u003e Send MFA Email OTP by Access Token (GET)\u003c/h6\u003e\n\n This API is created to send the OTP to the email if email OTP authenticator is enabled in app's MFA configuration.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/send-mfa-email-otp-by-access-token/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nemail_id = \"\u003cemail_id\u003e\" #Required \nemail_template2_f_a = \"\u003cemail_template2_f_a\u003e\" #Optional\n\nresult = loginradius.mfa.mfa_email_otp_by_access_token(access_token, email_id, email_template2_f_a)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAResendOTP-get-\"\u003e MFA Resend Otp (GET)\u003c/h6\u003e\n\n This API is used to resending the verification OTP to the provided phone number  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/resend-twofactorauthentication-otp/)\n\n ```py\n  \nsecond_factor_authentication_token = \"\u003csecond_factor_authentication_token\u003e\" #Required \nsms_template2_f_a = \"\u003csms_template2_f_a\u003e\" #Optional \nis_voice_otp = \"False\" #Optional\n\nresult = loginradius.mfa.mfa_resend_otp(second_factor_authentication_token, sms_template2_f_a, is_voice_otp)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFABackupCodeByUid-get-\"\u003e MFA Backup Code by UID (GET)\u003c/h6\u003e\n\n 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](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/mfa-backup-code-by-uid/)\n\n ```py\n  \nuid = \"\u003cuid\u003e\" #Required\n\nresult = loginradius.mfa.mfa_backup_code_by_uid(uid)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAResetBackupCodeByUid-get-\"\u003e MFA Reset Backup Code by UID (GET)\u003c/h6\u003e\n\n 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](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/mfa-reset-backup-code-by-uid/)\n\n ```py\n  \nuid = \"\u003cuid\u003e\" #Required\n\nresult = loginradius.mfa.mfa_reset_backup_code_by_uid(uid)\n ```\n \n\n\n \u003ch6 id=\"MFAResetAuthenticatorByToken-delete-\"\u003e MFA Reset Authenticator by Token (DELETE)\u003c/h6\u003e\n \n This API Resets the Authenticator configurations on a given account via the access_token.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/authenticator/mfa-reset-authenticator-by-token/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \nauthenticator = True #Required\n\nresult = loginradius.mfa.mfa_reset_authenticator_by_token(access_token, authenticator)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAResetSMSAuthByToken-delete-\"\u003e MFA Reset SMS Authenticator by Token (DELETE)\u003c/h6\u003e\n\n This API resets the SMS Authenticator configurations on a given account via the access token.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/mfa-reset-sms-authenticator-by-token/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required \notpauthenticator =True #Required\n\nresult = loginradius.mfa.mfa_reset_sms_auth_by_token(access_token, otpauthenticator)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAResetEmailOtpAuthenticatorByAccessToken-delete-\"\u003e Reset MFA Email OTP Authenticator By Access Token (DELETE)\u003c/h6\u003e\n\n This API is used to reset the Email OTP Authenticator settings for an MFA-enabled user  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/reset-mfa-email-otp-authenticator-access-token/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\n\nresult = loginradius.mfa.mfa_reset_email_otp_authenticator_by_access_token(access_token)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAResetSecurityQuestionAuthenticatorByAccessToken-delete-\"\u003e MFA Reset Security Question Authenticator By Access Token (DELETE)\u003c/h6\u003e\n\n This API is used to Reset MFA Security Question Authenticator By Access Token  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/reset-mfa-security-question-by-access-token/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\n\nresult = loginradius.mfa.mfa_reset_security_question_authenticator_by_access_token(access_token)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAResetSMSAuthenticatorByUid-delete-\"\u003e MFA Reset SMS Authenticator By UID (DELETE)\u003c/h6\u003e\n\n This API resets the SMS Authenticator configurations on a given account via the UID.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/mfa-reset-sms-authenticator-by-uid/)\n\n ```py\n  \notpauthenticator = \"True\" #Required \nuid = \"\u003cuid\u003e\" #Required\n\nresult = loginradius.mfa.mfa_reset_sms_authenticator_by_uid(otpauthenticator, uid)\n ```\n \n \u003ch6 id=\"MFAResetAuthenticatorByUid-delete-\"\u003e MFA Reset Authenticator By UID (DELETE)\u003c/h6\u003e\n\nThis API resets the Google Authenticator configurations on a given account via the UID. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/authenticator/mfa-reset-authenticator-by-uid/)\n\n ```py\n  \nauthenticator = True #Required \nuid = \"\u003cuid\u003e\" #Required\n\nresult = loginradius.mfa.mfa_reset_authenticator_by_uid(authenticator, uid)\n ```\n  \n  \n \n\u003ch6 id=\"MFAResetEmailOtpAuthenticatorByUid-delete-\"\u003e Reset MFA Email OTP Authenticator Settings by Uid (DELETE)\u003c/h6\u003e\n\n This API is used to reset the Email OTP Authenticator settings for an MFA-enabled user.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/reset-mfa-email-otp-authenticator-settings-by-uid/)\n\n ```py\n  \nuid = \"\u003cuid\u003e\" #Required\n\nresult = loginradius.mfa.mfa_reset_email_otp_authenticator_by_uid(uid)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAResetSecurityQuestionAuthenticatorByUid-delete-\"\u003e Reset MFA Security Question Authenticator Settings by Uid (DELETE)\u003c/h6\u003e\n\n This API is used to reset the Security Question Authenticator settings for an MFA-enabled user.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/reset-mfa-security-question-authenticator-settings-by-uid/)\n\n ```py\n  \nuid = \"\u003cuid\u003e\" #Required\n\nresult = loginradius.mfa.mfa_reset_security_question_authenticator_by_uid(uid)\n ```\n \n  \n  \n \n\n\n### PINAuthentication API\n\n\nList of APIs in this Section:\u003cbr\u003e\n\n* PUT : [Reset PIN By ResetToken](#ResetPINByResetToken-put-)\u003cbr\u003e\n* PUT : [Reset PIN By SecurityAnswer And Email](#ResetPINByEmailAndSecurityAnswer-put-)\u003cbr\u003e\n* PUT : [Reset PIN By SecurityAnswer And Username](#ResetPINByUsernameAndSecurityAnswer-put-)\u003cbr\u003e\n* PUT : [Reset PIN By SecurityAnswer And Phone](#ResetPINByPhoneAndSecurityAnswer-put-)\u003cbr\u003e\n* PUT : [Change PIN By Token](#ChangePINByAccessToken-put-)\u003cbr\u003e\n* PUT : [Reset PIN by Phone and OTP](#ResetPINByPhoneAndOtp-put-)\u003cbr\u003e\n* PUT : [Reset PIN by Email and OTP](#ResetPINByEmailAndOtp-put-)\u003cbr\u003e\n* PUT : [Reset PIN by Username and OTP](#ResetPINByUsernameAndOtp-put-)\u003cbr\u003e\n* POST : [PIN Login](#PINLogin-post-)\u003cbr\u003e\n* POST : [Forgot PIN By Email](#SendForgotPINEmailByEmail-post-)\u003cbr\u003e\n* POST : [Forgot PIN By UserName](#SendForgotPINEmailByUsername-post-)\u003cbr\u003e\n* POST : [Forgot PIN By Phone](#SendForgotPINSMSByPhone-post-)\u003cbr\u003e\n* POST : [Set PIN By PinAuthToken](#SetPINByPinAuthToken-post-)\u003cbr\u003e\n* GET : [Invalidate PIN Session Token](#InValidatePinSessionToken-get-)\u003cbr\u003e\n\n\n\n\n\u003ch6 id=\"ResetPINByResetToken-put-\"\u003e Reset PIN By ResetToken (PUT)\u003c/h6\u003e\n\n This API is used to reset pin using reset token.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/reset-pin-by-resettoken/)\n\n ```py\n \nreset_pin_by_reset_token = { \n\"pin\" : \"\u003cpin\u003e\",\n\"resetToken\" : \"\u003cresetToken\u003e\"\n}  #Required\n\nresult = loginradius.pin_authentication.reset_pin_by_reset_token(reset_pin_by_reset_token)\n ```\n \n  \n  \n \n\u003ch6 id=\"ResetPINByEmailAndSecurityAnswer-put-\"\u003e Reset PIN By SecurityAnswer And Email (PUT)\u003c/h6\u003e\n\n This API is used to reset pin using security question answer and email.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/reset-pin-by-securityanswer-and-email/)\n\n ```py\n \nreset_pin_by_security_question_answer_and_email_model = { \n\"email\" : \"\u003cemail\u003e\",\n\"pin\" : \"\u003cpin\u003e\",\n\"securityAnswer\" : {\"QuestionID\":\"Answer\"}\n}  #Required\n\nresult = loginradius.pin_authentication.reset_pin_by_email_and_security_answer(reset_pin_by_security_question_answer_and_email_model)\n ```\n \n  \n  \n \n\u003ch6 id=\"ResetPINByUsernameAndSecurityAnswer-put-\"\u003e Reset PIN By SecurityAnswer And Username (PUT)\u003c/h6\u003e\n\n This API is used to reset pin using security question answer and username.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/reset-pin-by-securityanswer-and-username/)\n\n ```py\n \nreset_pin_by_security_question_answer_and_username_model = { \n\"pin\" : \"\u003cpin\u003e\",\n\"securityAnswer\" : {\"QuestionID\":\"Answer\"},\n\"username\" : \"\u003cusername\u003e\"\n}  #Required\n\nresult = loginradius.pin_authentication.reset_pin_by_username_and_security_answer(reset_pin_by_security_question_answer_and_username_model)\n ```\n \n  \n  \n \n\u003ch6 id=\"ResetPINByPhoneAndSecurityAnswer-put-\"\u003e Reset PIN By SecurityAnswer And Phone (PUT)\u003c/h6\u003e\n\n This API is used to reset pin using security question answer and phone.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/reset-pin-by-securityanswer-and-phone/)\n\n ```py\n \nreset_pin_by_security_question_answer_and_phone_model = { \n\"phone\" : \"\u003cphone\u003e\",\n\"pin\" : \"\u003cpin\u003e\",\n\"securityAnswer\" : {\"QuestionID\":\"Answer\"}\n}  #Required\n\nresult = loginradius.pin_authentication.reset_pin_by_phone_and_security_answer(reset_pin_by_security_question_answer_and_phone_model)\n ```\n \n  \n  \n \n\u003ch6 id=\"ChangePINByAccessToken-put-\"\u003e Change PIN By Token (PUT)\u003c/h6\u003e\n\n This API is used to change a user's PIN using access token.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/change-pin-by-access-token/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\nchange_pin_model = { \n\"newPIN\" : \"\u003cnewPIN\u003e\",\n\"oldPIN\" : \"\u003coldPIN\u003e\"\n}  #Required\n\nresult = loginradius.pin_authentication.change_pin_by_access_token(access_token, change_pin_model)\n ```\n \n  \n  \n \n\u003ch6 id=\"ResetPINByPhoneAndOtp-put-\"\u003e Reset PIN by Phone and OTP (PUT)\u003c/h6\u003e\n\n This API is used to reset pin using phoneId and OTP.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/reset-pin-by-phone-and-otp/)\n\n ```py\n \nreset_pin_by_phone_and_otp_model = { \n\"otp\" : \"\u003cotp\u003e\",\n\"phone\" : \"\u003cphone\u003e\",\n\"pin\" : \"\u003cpin\u003e\"\n}  #Required\n\nresult = loginradius.pin_authentication.reset_pin_by_phone_and_otp(reset_pin_by_phone_and_otp_model)\n ```\n \n  \n  \n \n\u003ch6 id=\"ResetPINByEmailAndOtp-put-\"\u003e Reset PIN by Email and OTP (PUT)\u003c/h6\u003e\n\n This API is used to reset pin using email and OTP.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/reset-pin-by-email-and-otp/)\n\n ```py\n \nreset_pin_by_email_and_otp_model = { \n\"email\" : \"\u003cemail\u003e\",\n\"otp\" : \"\u003cotp\u003e\",\n\"pin\" : \"\u003cpin\u003e\"\n}  #Required\n\nresult = loginradius.pin_authentication.reset_pin_by_email_and_otp(reset_pin_by_email_and_otp_model)\n ```\n \n  \n  \n \n\u003ch6 id=\"ResetPINByUsernameAndOtp-put-\"\u003e Reset PIN by Username and OTP (PUT)\u003c/h6\u003e\n\n This API is used to reset pin using username and OTP.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/reset-pin-by-username-and-otp/)\n\n ```py\n \nreset_pin_by_username_and_otp_model = { \n\"otp\" : \"\u003cotp\u003e\",\n\"pin\" : \"\u003cpin\u003e\",\n\"username\" : \"\u003cusername\u003e\"\n}  #Required\n\nresult = loginradius.pin_authentication.reset_pin_by_username_and_otp(reset_pin_by_username_and_otp_model)\n ```\n \n  \n  \n \n\u003ch6 id=\"PINLogin-post-\"\u003e PIN Login (POST)\u003c/h6\u003e\n\n This API is used to login a user by pin and session token.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/login-by-pin/)\n\n ```py\n \nlogin_by_pin_model = { \n\"pin\" : \"\u003cpin\u003e\"\n}  #Required \nsession_token = \"\u003csession_token\u003e\" #Required\n\nresult = loginradius.pin_authentication.pin_login(login_by_pin_model, session_token)\n ```\n \n  \n  \n \n\u003ch6 id=\"SendForgotPINEmailByEmail-post-\"\u003e Forgot PIN By Email (POST)\u003c/h6\u003e\n\n This API sends the reset pin email to specified email address.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/forgot-pin-by-email/)\n\n ```py\n \nforgot_pin_link_by_email_model = { \n\"email\" : \"\u003cemail\u003e\"\n}  #Required \nemail_template = \"\u003cemail_template\u003e\" #Optional \nreset_pin_url = \"\u003creset_pin_url\u003e\" #Optional\n\nresult = loginradius.pin_authentication.send_forgot_pin_email_by_email(forgot_pin_link_by_email_model, email_template, reset_pin_url)\n ```\n \n  \n  \n \n\u003ch6 id=\"SendForgotPINEmailByUsername-post-\"\u003e Forgot PIN By UserName (POST)\u003c/h6\u003e\n\n This API sends the reset pin email using username.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/forgot-pin-by-username/)\n\n ```py\n \nforgot_pin_link_by_user_name_model = { \n\"userName\" : \"\u003cuserName\u003e\"\n}  #Required \nemail_template = \"\u003cemail_template\u003e\" #Optional \nreset_pin_url = \"\u003creset_pin_url\u003e\" #Optional\n\nresult = loginradius.pin_authentication.send_forgot_pin_email_by_username(forgot_pin_link_by_user_name_model, email_template, reset_pin_url)\n ```\n \n  \n  \n \n\u003ch6 id=\"SendForgotPINSMSByPhone-post-\"\u003e Forgot PIN By Phone (POST)\u003c/h6\u003e\n\n This API sends the OTP to specified phone number  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/forgot-pin-by-phone/)\n\n ```py\n \nforgot_pin_otp_by_phone_model = { \n\"phone\" : \"\u003cphone\u003e\"\n}  #Required \nsms_template = \"\u003csms_template\u003e\" #Optional \nis_voice_otp = \"False\" #Optional\n\nresult = loginradius.pin_authentication.send_forgot_pin_sms_by_phone(forgot_pin_otp_by_phone_model, sms_template, is_voice_otp)\n ```\n \n  \n  \n \n\u003ch6 id=\"SetPINByPinAuthToken-post-\"\u003e Set PIN By PinAuthToken (POST)\u003c/h6\u003e\n\n This API is used to change a user's PIN using Pin Auth token.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/set-pin-by-pinauthtoken/)\n\n ```py\n \npin_required_model = { \n\"pin\" : \"\u003cpin\u003e\"\n}  #Required \npin_auth_token = \"\u003cpin_auth_token\u003e\" #Required\n\nresult = loginradius.pin_authentication.set_pin_by_pin_auth_token(pin_required_model, pin_auth_token)\n ```\n \n  \n  \n \n\u003ch6 id=\"InValidatePinSessionToken-get-\"\u003e Invalidate PIN Session Token (GET)\u003c/h6\u003e\n\n This API is used to invalidate pin session token.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/invalidate-pin-session-token/)\n\n ```py\n  \nsession_token = \"\u003csession_token\u003e\" #Required\n\nresult = loginradius.pin_authentication.in_validate_pin_session_token(session_token)\n ```\n \n  \n  \n \n\n\n### ReAuthentication API\n\n\nList of APIs in this Section:\u003cbr\u003e\n\n* PUT : [Validate MFA by OTP](#MFAReAuthenticateByOTP-put-)\u003cbr\u003e\n* PUT : [Validate MFA by Backup Code](#MFAReAuthenticateByBackupCode-put-)\u003cbr\u003e\n* PUT : [Validate MFA by Password](#MFAReAuthenticateByPassword-put-)\u003cbr\u003e\n* PUT : [MFA Re-authentication by PIN](#VerifyPINAuthentication-put-)\u003cbr\u003e\n* PUT : [MFA Re-authentication by Email OTP](#ReAuthValidateEmailOtp-put-)\u003cbr\u003e\n* PUT : [MFA Step-Up Authentication by Authenticator Code](#MFAReAuthenticateByAuthenticatorCode-put-)\u003cbr\u003e\n* POST : [Verify Multifactor OTP Authentication](#VerifyMultiFactorOtpReauthentication-post-)\u003cbr\u003e\n* POST : [Verify Multifactor Password Authentication](#VerifyMultiFactorPasswordReauthentication-post-)\u003cbr\u003e\n* POST : [Verify Multifactor PIN Authentication](#VerifyMultiFactorPINReauthentication-post-)\u003cbr\u003e\n* POST : [MFA Re-authentication by Security Question](#ReAuthBySecurityQuestion-post-)\u003cbr\u003e\n* GET : [Multi Factor Re-Authenticate](#MFAReAuthenticate-get-)\u003cbr\u003e\n* GET : [Send MFA Re-auth Email OTP by Access Token](#ReAuthSendEmailOtp-get-)\u003cbr\u003e\n\n\n\n\n\u003ch6 id=\"MFAReAuthenticateByOTP-put-\"\u003e Validate MFA by OTP (PUT)\u003c/h6\u003e\n\n This API is used to re-authenticate via Multi-factor authentication by passing the One Time Password received via SMS  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/re-authentication/mfa/re-auth-by-otp/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\nreauth_by_otp_model = { \n\"otp\" : \"\u003cotp\u003e\"\n}  #Required\n\nresult = loginradius.re_authentication.mfa_re_authenticate_by_otp(access_token, reauth_by_otp_model)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAReAuthenticateByBackupCode-put-\"\u003e Validate MFA by Backup Code (PUT)\u003c/h6\u003e\n\n 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](https://www.loginradius.com/docs/api/v2/customer-identity-api/re-authentication/mfa/re-auth-by-backup-code/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\nreauth_by_backup_code_model = { \n\"backupCode\" : \"\u003cbackupCode\u003e\"\n}  #Required\n\nresult = loginradius.re_authentication.mfa_re_authenticate_by_backup_code(access_token, reauth_by_backup_code_model)\n ```\n \n  \n  \n \n\u003ch6 id=\"MFAReAuthenticateByPassword-put-\"\u003e Validate MFA by Password (PUT)\u003c/h6\u003e\n\n This API is used to re-authenticate via Multi-factor-authentication by passing the password  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/re-authentication/re-auth-by-password)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\npassword_event_based_auth_model_with_lockout = { \n\"password\" : \"\u003cpassword\u003e\"\n}  #Required \nsms_template2_f_a = \"\u003csms_template2_f_a\u003e\" #Optional\n\nresult = loginradius.re_authentication.mfa_re_authenticate_by_password(access_token, password_event_based_auth_model_with_lockout, sms_template2_f_a)\n ```\n \n  \n  \n \n\u003ch6 id=\"VerifyPINAuthentication-put-\"\u003e MFA Re-authentication by PIN (PUT)\u003c/h6\u003e\n\n This API is used to validate the triggered MFA authentication flow with a password.  [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/re-authentication/pin/re-auth-by-pin/)\n\n ```py\n  \naccess_token = \"\u003caccess_token\u003e\" #Required\npin_auth_event_based_auth_model_with_lockout = { \n\"pin\" : \"\u003cpin\u003e\"\n}  #Required \nsms_templ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floginradius%2Fpython-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Floginradius%2Fpython-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floginradius%2Fpython-sdk/lists"}