diff --git a/CHANGELOG.md b/CHANGELOG.md index 63db171..926013f 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,40 @@ > **LoginRadius Ruby On Rails SDK Change Log** provides information regarding what has changed, more specifically what changes, improvements and bug fix has been made to the SDK. For more details please refer to the [LoginRadius API Documention](https://docs.loginradius.com/api/v2/sdk-libraries/ruby) +# Version 11.6.0 + +**Release Date:** March 29, 2025 + +## Enhancements + +We've introduced a brand-new set of Webhook APIs, designed with enhanced functionality and flexibility. These new APIs support advanced features including: + +- Custom header configuration +- Query parameter support +- Webhook authentication methods (Bearer Token and Basic Auth) +- Support for a custom `Name` parameter to label each webhook subscription + +As part of this upgrade, the legacy Webhook APIs have been deprecated in favor of the new, more robust versions. + +## Newly Added APIs + +- `get_webhook_subscription_detail` – Retrieve detailed information about a specific webhook subscription +- `create_webhook_subscription` – Create a new webhook subscription with advanced configuration options +- `delete_webhook_subscription` – Remove an existing webhook subscription +- `update_webhook_subscription` – Modify an existing webhook subscription +- `list_all_webhooks` – Retrieve a list of all configured webhook subscriptions +- `get_webhook_events` – Fetch available webhook events supported by the system + +## Deprecated APIs + +The following legacy APIs have been deprecated: + +- `web_hook_subscribe` +- `webhook_test` +- `web_hook_unsubscribe` +- `get_web_hook_subscribed_u_r_ls` + + # Version 11.5.0 Release on January 20, 2023 diff --git a/LICENSE b/LICENSE index c3ac770..23a023a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2022 LoginRadius Inc. +Copyright (c) 2025 LoginRadius Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index bb7055b..cd0f012 100755 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Or ````shell - gem 'login_radius', '~> 11.5.0' + gem 'login_radius', '~> 11.6.0' ```` @@ -166,6 +166,7 @@ List of APIs in this Section:
Auth Update Profile by Token (PUT)
+ This API is used to update the user's profile by passing the access token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-update-profile-by-token/) @@ -192,6 +193,7 @@ response = AuthenticationApi.update_profile_by_access_token(access_token, user_p
Auth Unlock Account by Access Token (PUT)
+ This API is used to allow a customer with a valid access token to unlock their account provided that they successfully pass the prompted Bot Protection challenges. The Block or Suspend block types are not applicable for this API. For additional details see our Auth Security Configuration documentation.You are only required to pass the Post Parameters that correspond to the prompted challenges. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-unlock-account-by-access-token/) @@ -212,6 +214,7 @@ response = AuthenticationApi.unlock_account_by_token(access_token, unlock_profil
Auth Verify Email By OTP (PUT)
+ This API is used to verify the email of user when the OTP Email verification flow is enabled, please note that you must contact LoginRadius to have this feature enabled. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-verify-email-by-otp/) @@ -235,6 +238,7 @@ response = AuthenticationApi.verify_email_by_otp(email_verification_by_otp_model
Auth Reset Password by Security Answer and Email (PUT)
+ This API is used to reset password for the specified account by security question [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-email) @@ -256,6 +260,7 @@ response = AuthenticationApi.reset_password_by_security_answer_and_email(reset_p
Auth Reset Password by Security Answer and Phone (PUT)
+ This API is used to reset password for the specified account by security question [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-phone) @@ -277,6 +282,7 @@ response = AuthenticationApi.reset_password_by_security_answer_and_phone(reset_p
Auth Reset Password by Security Answer and UserName (PUT)
+ This API is used to reset password for the specified account by security question [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-username) @@ -298,6 +304,7 @@ response = AuthenticationApi.reset_password_by_security_answer_and_user_name(res
Auth Reset Password by Reset Token (PUT)
+ This API is used to set a new password for the specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-reset-token) @@ -318,6 +325,7 @@ response = AuthenticationApi.reset_password_by_reset_token(reset_password_by_res
Auth Reset Password by OTP (PUT)
+ This API is used to set a new password for the specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-otp) @@ -339,6 +347,7 @@ response = AuthenticationApi.reset_password_by_email_otp(reset_password_by_email
Auth Reset Password by OTP and UserName (PUT)
+ This API is used to set a new password for the specified account if you are using the username as the unique identifier in your workflow [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-otp-and-username/) @@ -360,6 +369,7 @@ response = AuthenticationApi.reset_password_by_otp_and_user_name(reset_password_
Auth Change Password (PUT)
+ This API is used to change the accounts password based on the previous password [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-change-password) @@ -379,6 +389,7 @@ response = AuthenticationApi.change_password(access_token, new_password, old_pas
Auth Set or Change UserName (PUT)
+ This API is used to set or change UserName by access token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-set-or-change-user-name/) @@ -397,6 +408,7 @@ response = AuthenticationApi.set_or_change_user_name(access_token, username)
Auth Resend Email Verification (PUT)
+ This API resends the verification email to the user. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-resend-email-verification/) @@ -416,6 +428,7 @@ response = AuthenticationApi.auth_resend_email_verification(email, email_templat
Auth Add Email (POST)
+ This API is used to add additional emails to a user's account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-add-email) @@ -437,6 +450,7 @@ response = AuthenticationApi.add_email(access_token, email, type, email_template
Auth Login by Email (POST)
+ This API retrieves a copy of the user data based on the Email [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-login-by-email) @@ -461,6 +475,7 @@ response = AuthenticationApi.login_by_email(email_authentication_model, email_te
Auth Login by Username (POST)
+ This API retrieves a copy of the user data based on the Username [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-login-by-username) @@ -485,6 +500,7 @@ response = AuthenticationApi.login_by_user_name(user_name_authentication_model,
Auth Forgot Password (POST)
+ This API is used to send the reset password url to a specified account. Note: If you have the UserName workflow enabled, you may replace the 'email' parameter with 'username' [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-forgot-password) @@ -504,6 +520,7 @@ response = AuthenticationApi.forgot_password(email, reset_password_url, email_te
Auth Link Social Identities (POST)
+ This API is used to link up a social provider account with an existing LoginRadius account on the basis of access token and the social providers user access token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-link-social-identities) @@ -522,6 +539,7 @@ response = AuthenticationApi.link_social_identities(access_token, candidate_toke
Auth Link Social Identities By Ping (POST)
+ This API is used to link up a social provider account with an existing LoginRadius account on the basis of ping and the social providers user access token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-link-social-identities-by-ping) @@ -540,6 +558,7 @@ response = AuthenticationApi.link_social_identities_by_ping(access_token, client
Auth User Registration by Email (POST)
+ This API creates a user in the database as well as sends a verification email to the user. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-user-registration-by-email) @@ -571,6 +590,7 @@ response = AuthenticationApi.user_registration_by_email(auth_user_registration_m
Auth User Registration By Captcha (POST)
+ This API creates a user in the database as well as sends a verification email to the user. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-user-registration-by-recaptcha) @@ -603,6 +623,7 @@ response = AuthenticationApi.user_registration_by_captcha(auth_user_registration
Get Security Questions By Email (GET)
+ This API is used to retrieve the list of questions that are configured on the respective LoginRadius site. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/security-questions-by-email/) @@ -620,6 +641,7 @@ response = AuthenticationApi.get_security_questions_by_email(email)
Get Security Questions By UserName (GET)
+ This API is used to retrieve the list of questions that are configured on the respective LoginRadius site. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/security-questions-by-user-name/) @@ -637,6 +659,7 @@ response = AuthenticationApi.get_security_questions_by_user_name(user_name)
Get Security Questions By Phone (GET)
+ This API is used to retrieve the list of questions that are configured on the respective LoginRadius site. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/security-questions-by-phone/) @@ -654,6 +677,7 @@ response = AuthenticationApi.get_security_questions_by_phone(phone)
Get Security Questions By Access Token (GET)
+ This API is used to retrieve the list of questions that are configured on the respective LoginRadius site. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/security-questions-by-access-token/) @@ -671,6 +695,7 @@ response = AuthenticationApi.get_security_questions_by_access_token(access_token
Auth Validate Access token (GET)
+ This api validates access token, if valid then returns a response with its expiry otherwise error. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-validate-access-token/) @@ -688,6 +713,7 @@ response = AuthenticationApi.auth_validate_access_token(access_token)
Access Token Invalidate (GET)
+ This api call invalidates the active access token or expires an access token's validity. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-invalidate-access-token/) @@ -706,6 +732,7 @@ response = AuthenticationApi.auth_in_validate_access_token(access_token, prevent
Access Token Info (GET)
+ This api call provide the active access token Information [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-access-token-info/) @@ -723,6 +750,7 @@ response = AuthenticationApi.get_access_token_info(access_token)
Auth Read all Profiles by Token (GET)
+ This API retrieves a copy of the user data based on the access token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-read-profiles-by-token/) @@ -744,6 +772,7 @@ response = AuthenticationApi.get_profile_by_access_token(access_token, fields, e
Auth Send Welcome Email (GET)
+ This API sends a welcome email [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-send-welcome-email/) @@ -762,6 +791,7 @@ response = AuthenticationApi.send_welcome_email(access_token, welcome_email_temp
Auth Delete Account (GET)
+ This API is used to delete an account by passing it a delete token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-delete-account/) @@ -777,6 +807,7 @@ response = AuthenticationApi.delete_account_by_delete_token(deletetoken)
Get Profile By Ping (GET)
+ This API is used to get a user's profile using the clientGuid parameter if no callback feature enabled. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/social-login-by-ping/) @@ -795,6 +826,7 @@ response = AuthenticationApi.get_profile_by_ping(client_guid, email_template, fi
Auth Check Email Availability (GET)
+ This API is used to check the email exists or not on your site. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-email-availability/) @@ -812,6 +844,7 @@ response = AuthenticationApi.check_email_availability(email)
Auth Verify Email (GET)
+ This API is used to verify the email of user. Note: This API will only return the full profile if you have 'Enable auto login after email verification' set in your LoginRadius Admin Console's Email Workflow settings under 'Verification Email'. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-verify-email/) @@ -832,6 +865,7 @@ response = AuthenticationApi.verify_email(verification_token, fields, url, welco
Auth Check UserName Availability (GET)
+ This API is used to check the UserName exists or not on your site. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-username-availability/) @@ -849,6 +883,7 @@ response = AuthenticationApi.check_user_name_availability(username)
Auth Privacy Policy Accept (GET)
+ This API is used to update the privacy policy stored in the user's profile by providing the access token of the user accepting the privacy policy [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-privacy-policy-accept) @@ -867,6 +902,7 @@ response = AuthenticationApi.accept_privacy_policy(access_token, fields)
Auth Privacy Policy History By Access Token (GET)
+ This API will return all the accepted privacy policies for the user by providing the access token of that user. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/privacy-policy-history-by-access-token/) @@ -884,6 +920,7 @@ response = AuthenticationApi.get_privacy_policy_history_by_access_token(access_t
Auth Delete Account with Email Confirmation (DELETE)
+ This API will send a confirmation email for account deletion to the customer's email when passed the customer's access token [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-delete-account-with-email-confirmation/) @@ -903,6 +940,7 @@ response = AuthenticationApi.delete_account_with_email_confirmation(access_token
Auth Remove Email (DELETE)
+ This API is used to remove additional emails from a user's account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-remove-email) @@ -921,6 +959,7 @@ response = AuthenticationApi.remove_email(access_token, email)
Auth Unlink Social Identities (DELETE)
+ This API is used to unlink up a social provider account with the specified account based on the access token and the social providers user access token. The unlinked account will automatically get removed from your database. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-unlink-social-identities) @@ -973,6 +1012,7 @@ List of APIs in this Section:
Account Update (PUT)
+ This API is used to update the information of existing accounts in your Cloud Storage. See our Advanced API Usage section Here for more capabilities. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-update) @@ -996,6 +1036,7 @@ response = AccountApi.update_account_by_uid(account_user_profile_update_model, u
Update Phone ID by UID (PUT)
+ This API is used to update the PhoneId by using the Uid's. Admin can update the PhoneId's for both the verified and unverified profiles. It will directly replace the PhoneId and bypass the OTP verification process. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/update-phoneid-by-uid) @@ -1015,6 +1056,7 @@ response = AccountApi.update_phone_id_by_uid(phone, uid, fields)
Account Set Password (PUT)
+ This API is used to set the password of an account in Cloud Storage. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-set-password) @@ -1033,6 +1075,7 @@ response = AccountApi.set_account_password_by_uid(password, uid)
Account Invalidate Verification Email (PUT)
+ This API is used to invalidate the Email Verification status on an account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-invalidate-verification-email) @@ -1052,6 +1095,7 @@ response = AccountApi.invalidate_account_email_verification(uid, email_template,
Reset phone ID verification (PUT)
+ This API Allows you to reset the phone no verification of an end user’s account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/reset-phone-id-verification) @@ -1070,6 +1114,7 @@ response = AccountApi.reset_phone_id_verification_by_uid(uid, sms_template)
Upsert Email (PUT)
+ This API is used to add/upsert another emails in account profile by different-different email types. If the email type is same then it will simply update the existing email, otherwise it will add a new email in Email array. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/upsert-email) @@ -1094,6 +1139,7 @@ response = AccountApi.upsert_email(upsert_email_model, uid, fields)
Update UID (PUT)
+ This API is used to update a user's Uid. It will update all profiles, custom objects and consent management logs associated with the Uid. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-update/) @@ -1114,6 +1160,7 @@ response = AccountApi.account_update_uid(update_uid_model, uid)
Account Create (POST)
+ This API is used to create an account in Cloud Storage. This API bypass the normal email verification process and manually creates the user.

In order to use this API, you need to format a JSON request body with all of the mandatory fields [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-create) @@ -1140,6 +1187,7 @@ response = AccountApi.create_account(account_create_model, fields)
Forgot Password token (POST)
+ This API Returns a Forgot Password Token it can also be used to send a Forgot Password email to the customer. Note: If you have the UserName workflow enabled, you may replace the 'email' parameter with 'username' in the body. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/get-forgot-password-token) @@ -1160,6 +1208,7 @@ response = AccountApi.get_forgot_password_token(email, email_template, reset_pas
Email Verification token (POST)
+ This API Returns an Email Verification token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/get-email-verification-token) @@ -1177,6 +1226,7 @@ response = AccountApi.get_email_verification_token(email)
Get Privacy Policy History By Uid (GET)
+ This API is used to retrieve all of the accepted Policies by the user, associated with their UID. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/privacy-policy-history-by-uid/) @@ -1194,6 +1244,7 @@ response = AccountApi.get_privacy_policy_history_by_uid(uid)
Account Profiles by Email (GET)
+ This API is used to retrieve all of the profile data, associated with the specified account by email in Cloud Storage. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-profiles-by-email) @@ -1212,6 +1263,7 @@ response = AccountApi.get_account_profile_by_email(email, fields)
Account Profiles by Username (GET)
+ This API is used to retrieve all of the profile data associated with the specified account by user name in Cloud Storage. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-profiles-by-user-name) @@ -1230,6 +1282,7 @@ response = AccountApi.get_account_profile_by_user_name(user_name, fields)
Account Profile by Phone ID (GET)
+ This API is used to retrieve all of the profile data, associated with the account by phone number in Cloud Storage. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-profiles-by-phone-id/) @@ -1248,6 +1301,7 @@ response = AccountApi.get_account_profile_by_phone(phone, fields)
Account Profiles by UID (GET)
+ This API is used to retrieve all of the profile data, associated with the account by uid in Cloud Storage. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-profiles-by-uid) @@ -1266,6 +1320,7 @@ response = AccountApi.get_account_profile_by_uid(uid, fields)
Account Password (GET)
+ This API use to retrive the hashed password of a specified account in Cloud Storage. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-password) @@ -1283,6 +1338,7 @@ response = AccountApi.get_account_password_hash_by_uid(uid)
Access Token based on UID or User impersonation API (GET)
+ The API is used to get LoginRadius access token based on UID. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-impersonation-api) @@ -1300,6 +1356,7 @@ response = AccountApi.get_access_token_by_uid(uid)
Refresh Access Token by Refresh Token (GET)
+ This API is used to refresh an access token via it's associated refresh token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/refresh-token/refresh-access-token-by-refresh-token) @@ -1317,6 +1374,7 @@ response = AccountApi.refresh_access_token_by_refresh_token(refresh_token)
Revoke Refresh Token (GET)
+ The Revoke Refresh Access Token API is used to revoke a refresh token or the Provider Access Token, revoking an existing refresh token will invalidate the refresh token but the associated access token will work until the expiry. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/refresh-token/revoke-refresh-token) @@ -1334,6 +1392,7 @@ response = AccountApi.revoke_refresh_token(refresh_token)
Account Identities by Email (GET)
+ Note: This is intended for specific workflows where an email may be associated to multiple UIDs. This API is used to retrieve all of the identities (UID and Profiles), associated with a specified email in Cloud Storage. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-identities-by-email) @@ -1352,6 +1411,7 @@ response = AccountApi.get_account_identities_by_email(email, fields)
Account Delete (DELETE)
+ This API deletes the Users account and allows them to re-register for a new account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-delete) @@ -1369,6 +1429,7 @@ response = AccountApi.delete_account_by_uid(uid)
Account Remove Email (DELETE)
+ Use this API to Remove emails from a user Account [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-email-delete) @@ -1388,6 +1449,7 @@ response = AccountApi.remove_email(email, uid, fields)
Delete User Profiles By Email (DELETE)
+ This API is used to delete all user profiles associated with an Email. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-email-delete/) @@ -1423,6 +1485,7 @@ List of APIs in this Section:
Access Token (GET)
+ This API Is used to translate the Request Token returned during authentication into an Access Token that can be used with other API calls. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/access-token) @@ -1440,6 +1503,7 @@ response = SocialApi.exchange_access_token(token)
Refresh Token (GET)
+ The Refresh Access Token API is used to refresh the provider access token after authentication. It will be valid for up to 60 days on LoginRadius depending on the provider. In order to use the access token in other APIs, always refresh the token using this API.

Supported Providers : Facebook,Yahoo,Google,Twitter, Linkedin.

Contact LoginRadius support team to enable this API. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/refresh-token/refresh-token) @@ -1459,6 +1523,7 @@ response = SocialApi.refresh_access_token(access_token, expires_in, is_web)
Token Validate (GET)
+ This API validates access token, if valid then returns a response with its expiry otherwise error. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/validate-access-token) @@ -1476,6 +1541,7 @@ response = SocialApi.validate_access_token(access_token)
Access Token Invalidate (GET)
+ This api invalidates the active access token or expires an access token validity. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/invalidate-access-token) @@ -1493,6 +1559,7 @@ response = SocialApi.in_validate_access_token(access_token)
Get Active Session Details (GET)
+ This api is use to get all active session by Access Token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/get-active-session-details) @@ -1510,6 +1577,7 @@ response = SocialApi.get_active_session(token)
Get Active Session By Account Id (GET)
+ This api is used to get all active sessions by AccountID(UID). [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/active-session-by-account-id/) @@ -1527,6 +1595,7 @@ response = SocialApi.get_active_session_by_account_id(account_id)
Get Active Session By Profile Id (GET)
+ This api is used to get all active sessions by ProfileId. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/active-session-by-profile-id/) @@ -1564,6 +1633,7 @@ List of APIs in this Section:
Custom Object Update by Access Token (PUT)
+ This API is used to update the specified custom object data of the specified account. If the value of updatetype is 'replace' then it will fully replace custom object with the new custom object and if the value of updatetype is 'partialreplace' then it will perform an upsert type operation [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-update-by-objectrecordid-and-token) @@ -1586,6 +1656,7 @@ response = CustomObjectApi.update_custom_object_by_token(access_token, object_na
Custom Object Update by UID (PUT)
+ This API is used to update the specified custom object data of a specified account. If the value of updatetype is 'replace' then it will fully replace custom object with new custom object and if the value of updatetype is partialreplace then it will perform an upsert type operation. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-update-by-objectrecordid-and-uid) @@ -1608,6 +1679,7 @@ response = CustomObjectApi.update_custom_object_by_uid(object_name, object_recor
Create Custom Object by Token (POST)
+ This API is used to write information in JSON format to the custom object for the specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/create-custom-object-by-token) @@ -1628,6 +1700,7 @@ response = CustomObjectApi.create_custom_object_by_token(access_token, object_na
Create Custom Object by UID (POST)
+ This API is used to write information in JSON format to the custom object for the specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/create-custom-object-by-uid) @@ -1648,6 +1721,7 @@ response = CustomObjectApi.create_custom_object_by_uid(object_name, object, uid)
Custom Object by Token (GET)
+ This API is used to retrieve the specified Custom Object data for the specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-by-token) @@ -1666,6 +1740,7 @@ response = CustomObjectApi.get_custom_object_by_token(access_token, object_name)
Custom Object by ObjectRecordId and Token (GET)
+ This API is used to retrieve the Custom Object data for the specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-by-objectrecordid-and-token) @@ -1685,6 +1760,7 @@ response = CustomObjectApi.get_custom_object_by_record_id_and_token(access_token
Custom Object By UID (GET)
+ This API is used to retrieve all the custom objects by UID from cloud storage. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-by-uid) @@ -1703,6 +1779,7 @@ response = CustomObjectApi.get_custom_object_by_uid(object_name, uid)
Custom Object by ObjectRecordId and UID (GET)
+ This API is used to retrieve the Custom Object data for the specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-by-objectrecordid-and-uid) @@ -1722,6 +1799,7 @@ response = CustomObjectApi.get_custom_object_by_record_id(object_name, object_re
Custom Object Delete by Record Id And Token (DELETE)
+ This API is used to remove the specified Custom Object data using ObjectRecordId of a specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-delete-by-objectrecordid-and-token) @@ -1741,6 +1819,7 @@ response = CustomObjectApi.delete_custom_object_by_token(access_token, object_na
Account Delete Custom Object by ObjectRecordId (DELETE)
+ This API is used to remove the specified Custom Object data using ObjectRecordId of specified account. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-delete-by-objectrecordid-and-uid) @@ -1781,6 +1860,7 @@ List of APIs in this Section:
Phone Reset Password by OTP (PUT)
+ This API is used to reset the password [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-reset-password-by-otp) @@ -1802,6 +1882,7 @@ response = PhoneAuthenticationApi.reset_password_by_phone_otp(reset_password_by_
Phone Verification OTP (PUT)
+ This API is used to validate the verification code sent to verify a user's phone number [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-verify-otp) @@ -1822,6 +1903,7 @@ response = PhoneAuthenticationApi.phone_verification_by_otp(otp, phone, fields,
Phone Verification OTP by Token (PUT)
+ This API is used to consume the verification code sent to verify a user's phone number. Use this call for front-end purposes in cases where the user is already logged in by passing the user's access token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-verify-otp-by-token) @@ -1841,6 +1923,7 @@ response = PhoneAuthenticationApi.phone_verification_otp_by_access_token(access_
Phone Number Update (PUT)
+ This API is used to update the login Phone Number of users [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-number-update) @@ -1860,6 +1943,7 @@ response = PhoneAuthenticationApi.update_phone_number(access_token, phone, sms_t
Phone Login (POST)
+ This API retrieves a copy of the user data based on the Phone [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-login) @@ -1883,6 +1967,7 @@ response = PhoneAuthenticationApi.login_by_phone(phone_authentication_model, fie
Phone Forgot Password by OTP (POST)
+ This API is used to send the OTP to reset the account password. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-forgot-password-by-otp) @@ -1901,6 +1986,7 @@ response = PhoneAuthenticationApi.forgot_password_by_phone_otp(phone, sms_templa
Phone Resend Verification OTP (POST)
+ This API is used to resend a verification OTP to verify a user's Phone Number. The user will receive a verification code that they will need to input [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-resend-otp) @@ -1919,6 +2005,7 @@ response = PhoneAuthenticationApi.phone_resend_verification_otp(phone, sms_templ
Phone Resend Verification OTP By Token (POST)
+ This API is used to resend a verification OTP to verify a user's Phone Number in cases in which an active token already exists [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-resend-otp-by-token) @@ -1938,6 +2025,7 @@ response = PhoneAuthenticationApi.phone_resend_verification_otp_by_token(access_
Phone User Registration by SMS (POST)
+ This API registers the new users into your Cloud Storage and triggers the phone verification process. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-user-registration-by-sms) @@ -1974,6 +2062,7 @@ response = PhoneAuthenticationApi.user_registration_by_phone(auth_user_registrat
Phone Number Availability (GET)
+ This API is used to check the Phone Number exists or not on your site. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-number-availability) @@ -1991,6 +2080,7 @@ response = PhoneAuthenticationApi.check_phone_number_availability(phone)
Remove Phone ID by Access Token (DELETE)
+ This API is used to delete the Phone ID on a user's account via the access token [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/remove-phone-id-by-access-token) @@ -2049,6 +2139,7 @@ List of APIs in this Section:
Update MFA Setting (PUT)
+ This API is used to trigger the Multi-factor authentication settings after login for secure actions [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/update-mfa-setting/) @@ -2070,6 +2161,7 @@ response = MultiFactorAuthenticationApi.mfa_update_setting(access_token, multi_f
Update MFA by Access Token (PUT)
+ This API is used to Enable Multi-factor authentication by access token on user login [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/google-authenticator/update-mfa-by-access-token/) @@ -2092,6 +2184,7 @@ response = MultiFactorAuthenticationApi.mfa_update_by_access_token(access_token,
MFA Update Phone Number by Token (PUT)
+ This API is used to update the Multi-factor authentication phone number by sending the verification OTP to the provided phone number [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/mfa-update-phone-number-by-token/) @@ -2111,6 +2204,7 @@ response = MultiFactorAuthenticationApi.mfa_update_phone_number_by_token(access_
Verify MFA Email OTP by Access Token (PUT)
+ This API is used to set up MFA Email OTP authenticator on profile after login. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/verify-mfa-otp-by-access-token/) @@ -2133,6 +2227,7 @@ response = MultiFactorAuthenticationApi.mfa_validate_email_otp_by_access_token(a
Update MFA Security Question by Access Token (PUT)
+ This API is used to set up MFA Security Question authenticator on profile after login. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/update-mfa-security-question-by-access-token) @@ -2160,6 +2255,7 @@ response = MultiFactorAuthenticationApi.mfa_security_question_answer_by_access_t
MFA Validate OTP (PUT)
+ This API is used to login via Multi-factor authentication by passing the One Time Password received via SMS [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/mfa-validate-otp/) @@ -2186,6 +2282,7 @@ response = MultiFactorAuthenticationApi.mfa_validate_otp_by_phone(multi_factor_a
MFA Validate Google Auth Code (PUT)
+ This API is used to login via Multi-factor-authentication by passing the google authenticator code. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/google-authenticator/mfa-validate-google-auth-code/) @@ -2209,6 +2306,7 @@ response = MultiFactorAuthenticationApi.mfa_validate_google_auth_code(google_aut
MFA Validate Backup code (PUT)
+ This API is used to validate the backup code provided by the user and if valid, we return an access token allowing the user to login incases where Multi-factor authentication (MFA) is enabled and the secondary factor is unavailable. When a user initially downloads the Backup codes, We generate 10 codes, each code can only be consumed once. if any user attempts to go over the number of invalid login attempts configured in the Dashboard then the account gets blocked automatically [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/mfa-validate-backup-code/) @@ -2234,6 +2332,7 @@ response = MultiFactorAuthenticationApi.mfa_validate_backup_code(multi_factor_au
MFA Update Phone Number (PUT)
+ This API is used to update (if configured) the phone number used for Multi-factor authentication by sending the verification OTP to the provided phone number [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/mfa-update-phone-number/) @@ -2253,6 +2352,7 @@ response = MultiFactorAuthenticationApi.mfa_update_phone_number(phone_no_2fa, se
Verify MFA Email OTP by MFA Token (PUT)
+ 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/) @@ -2279,6 +2379,7 @@ response = MultiFactorAuthenticationApi.mfa_validate_email_otp(multi_factor_auth
Update MFA Security Question by MFA Token (PUT)
+ This API is used to set the security questions on the profile with the MFA token when MFA flow is required. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/update-mfa-security-question-by-mfa-token/) @@ -2305,6 +2406,7 @@ response = MultiFactorAuthenticationApi.mfa_security_question_answer(security_qu
MFA Email Login (POST)
+ 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) @@ -2330,6 +2432,7 @@ response = MultiFactorAuthenticationApi.mfa_login_by_email(email, password, emai
MFA UserName Login (POST)
+ 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) @@ -2355,6 +2458,7 @@ response = MultiFactorAuthenticationApi.mfa_login_by_user_name(password, usernam
MFA Phone Login (POST)
+ 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) @@ -2380,6 +2484,7 @@ response = MultiFactorAuthenticationApi.mfa_login_by_phone(password, phone, emai
Send MFA Email OTP by MFA Token (POST)
+ 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/) @@ -2402,6 +2507,7 @@ response = MultiFactorAuthenticationApi.mfa_email_otp(email_id_model, second_fac
Verify MFA Security Question by MFA Token (POST)
+ 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/) @@ -2432,6 +2538,7 @@ response = MultiFactorAuthenticationApi.mfa_security_question_answer_verificatio
MFA Validate Access Token (GET)
+ This API is used to configure the Multi-factor authentication after login by using the access token when MFA is set as optional on the LoginRadius site. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/mfa-validate-access-token/) @@ -2450,6 +2557,7 @@ response = MultiFactorAuthenticationApi.mfa_configure_by_access_token(access_tok
MFA Backup Code by Access Token (GET)
+ This API is used to get a set of backup codes via access token to allow the user login on a site that has Multi-factor Authentication enabled in the event that the user does not have a secondary factor available. We generate 10 codes, each code can only be consumed once. If any user attempts to go over the number of invalid login attempts configured in the Dashboard then the account gets blocked automatically [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/mfa-backup-code-by-access-token/) @@ -2467,6 +2575,7 @@ response = MultiFactorAuthenticationApi.mfa_backup_code_by_access_token(access_t
Reset Backup Code by Access Token (GET)
+ API is used to reset the backup codes on a given account via the access token. This API call will generate 10 new codes, each code can only be consumed once [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/mfa-reset-backup-code-by-access-token/) @@ -2484,6 +2593,7 @@ response = MultiFactorAuthenticationApi.mfa_reset_backup_code_by_access_token(ac
Send MFA Email OTP by Access Token (GET)
+ This API is created to send the OTP to the email if email OTP authenticator is enabled in app's MFA configuration. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/send-mfa-email-otp-by-access-token/) @@ -2503,6 +2613,7 @@ response = MultiFactorAuthenticationApi.mfa_email_otp_by_access_token(access_tok
MFA Resend Otp (GET)
+ 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/) @@ -2521,6 +2632,7 @@ response = MultiFactorAuthenticationApi.mfa_resend_otp(second_factor_authenticat
MFA Backup Code by UID (GET)
+ This API is used to reset the backup codes on a given account via the UID. This API call will generate 10 new codes, each code can only be consumed once. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/mfa-backup-code-by-uid/) @@ -2538,6 +2650,7 @@ response = MultiFactorAuthenticationApi.mfa_backup_code_by_uid(uid)
MFA Reset Backup Code by UID (GET)
+ This API is used to reset the backup codes on a given account via the UID. This API call will generate 10 new codes, each code can only be consumed once. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/mfa-reset-backup-code-by-uid/) @@ -2555,6 +2668,7 @@ response = MultiFactorAuthenticationApi.mfa_reset_backup_code_by_uid(uid)
MFA Reset Google Authenticator by Token (DELETE)
+ This API Resets the Google Authenticator configurations on a given account via the access token [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/google-authenticator/mfa-reset-google-authenticator-by-token/) @@ -2573,6 +2687,7 @@ response = MultiFactorAuthenticationApi.mfa_reset_google_auth_by_token(access_to
MFA Reset SMS Authenticator by Token (DELETE)
+ 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/) @@ -2591,6 +2706,7 @@ response = MultiFactorAuthenticationApi.mfa_reset_sms_auth_by_token(access_token
Reset MFA Email OTP Authenticator By Access Token (DELETE)
+ This API is used to reset the Email OTP Authenticator settings for an MFA-enabled user [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/reset-mfa-email-otp-authenticator-access-token/) @@ -2608,6 +2724,7 @@ response = MultiFactorAuthenticationApi.mfa_reset_email_otp_authenticator_by_acc
MFA Reset Security Question Authenticator By Access Token (DELETE)
+ 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/) @@ -2625,6 +2742,7 @@ response = MultiFactorAuthenticationApi.mfa_reset_security_question_authenticato
MFA Reset SMS Authenticator By UID (DELETE)
+ 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/) @@ -2643,6 +2761,7 @@ response = MultiFactorAuthenticationApi.mfa_reset_sms_authenticator_by_uid(otpau
MFA Reset Google Authenticator By UID (DELETE)
+ This 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/google-authenticator/mfa-reset-google-authenticator-by-uid/) @@ -2661,6 +2780,7 @@ response = MultiFactorAuthenticationApi.mfa_reset_google_authenticator_by_uid(go
Reset MFA Email OTP Authenticator Settings by Uid (DELETE)
+ This API is used to reset the Email OTP Authenticator settings for an MFA-enabled user. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/reset-mfa-email-otp-authenticator-settings-by-uid/) @@ -2678,6 +2798,7 @@ response = MultiFactorAuthenticationApi.mfa_reset_email_otp_authenticator_by_uid
Reset MFA Security Question Authenticator Settings by Uid (DELETE)
+ This API is used to reset the Security Question Authenticator settings for an MFA-enabled user. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/reset-mfa-security-question-authenticator-settings-by-uid/) @@ -2719,6 +2840,7 @@ List of APIs in this Section:
Reset PIN By ResetToken (PUT)
+ 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/) @@ -2739,6 +2861,7 @@ response = PINAuthenticationApi.reset_pin_by_reset_token(reset_pin_by_reset_toke
Reset PIN By SecurityAnswer And Email (PUT)
+ 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/) @@ -2760,6 +2883,7 @@ response = PINAuthenticationApi.reset_pin_by_email_and_security_answer(reset_pin
Reset PIN By SecurityAnswer And Username (PUT)
+ 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/) @@ -2781,6 +2905,7 @@ response = PINAuthenticationApi.reset_pin_by_username_and_security_answer(reset_
Reset PIN By SecurityAnswer And Phone (PUT)
+ 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/) @@ -2802,6 +2927,7 @@ response = PINAuthenticationApi.reset_pin_by_phone_and_security_answer(reset_pin
Change PIN By Token (PUT)
+ 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/) @@ -2823,6 +2949,7 @@ response = PINAuthenticationApi.change_pin_by_access_token(access_token, change_
Reset PIN by Phone and OTP (PUT)
+ 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/) @@ -2844,6 +2971,7 @@ response = PINAuthenticationApi.reset_pin_by_phone_and_otp(reset_pin_by_phone_an
Reset PIN by Email and OTP (PUT)
+ 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/) @@ -2865,6 +2993,7 @@ response = PINAuthenticationApi.reset_pin_by_email_and_otp(reset_pin_by_email_an
Reset PIN by Username and OTP (PUT)
+ 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/) @@ -2886,6 +3015,7 @@ response = PINAuthenticationApi.reset_pin_by_username_and_otp(reset_pin_by_usern
PIN Login (POST)
+ 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/) @@ -2906,6 +3036,7 @@ response = PINAuthenticationApi.pin_login(login_by_pin_model, session_token)
Forgot PIN By Email (POST)
+ This API sends the reset pin email to specified email address. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/forgot-pin-by-email/) @@ -2927,6 +3058,7 @@ response = PINAuthenticationApi.send_forgot_pin_email_by_email(forgot_pin_link_b
Forgot PIN By UserName (POST)
+ 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/) @@ -2948,6 +3080,7 @@ response = PINAuthenticationApi.send_forgot_pin_email_by_username(forgot_pin_lin
Forgot PIN By Phone (POST)
+ 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/) @@ -2968,6 +3101,7 @@ response = PINAuthenticationApi.send_forgot_pin_sms_by_phone(forgot_pin_otp_by_p
Set PIN By PinAuthToken (POST)
+ 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/) @@ -2988,6 +3122,7 @@ response = PINAuthenticationApi.set_pin_by_pin_auth_token(pin_required_model, pi
Invalidate PIN Session Token (GET)
+ 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/) @@ -3027,6 +3162,7 @@ List of APIs in this Section:
Validate MFA by OTP (PUT)
+ This API is used to re-authenticate via Multi-factor authentication by passing the One Time Password received via SMS [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/re-authentication/mfa/re-auth-by-otp/) @@ -3047,6 +3183,7 @@ response = ReAuthenticationApi.mfa_re_authenticate_by_otp(access_token, reauth_b
Validate MFA by Backup Code (PUT)
+ This API is used to re-authenticate by set of backup codes via access token on the site that has Multi-factor authentication enabled in re-authentication for the user that does not have the device [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/re-authentication/mfa/re-auth-by-backup-code/) @@ -3067,6 +3204,7 @@ response = ReAuthenticationApi.mfa_re_authenticate_by_backup_code(access_token,
Validate MFA by Google Authenticator Code (PUT)
+ This API is used to re-authenticate via Multi-factor-authentication by passing the google authenticator code [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/re-authentication/re-auth-by-google-authenticator-code) @@ -3087,6 +3225,7 @@ response = ReAuthenticationApi.mfa_re_authenticate_by_google_auth(access_token,
Validate MFA by Password (PUT)
+ 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) @@ -3108,6 +3247,7 @@ response = ReAuthenticationApi.mfa_re_authenticate_by_password(access_token, pas
MFA Re-authentication by PIN (PUT)
+ 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/) @@ -3129,6 +3269,7 @@ response = ReAuthenticationApi.verify_pin_authentication(access_token, pin_auth_
MFA Re-authentication by Email OTP (PUT)
+ This API is used to validate the triggered MFA authentication flow with an Email OTP. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/re-authentication/mfa-re-auth-by-email-otp/) @@ -3151,6 +3292,7 @@ response = ReAuthenticationApi.re_auth_validate_email_otp(access_token, reauth_b
Verify Multifactor OTP Authentication (POST)
+ This API is used on the server-side to validate and verify the re-authentication token created by the MFA re-authentication API. This API checks re-authentications created by OTP. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/re-authentication/mfa/re-auth-validate-mfa/) @@ -3171,6 +3313,7 @@ response = ReAuthenticationApi.verify_multi_factor_otp_reauthentication(event_ba
Verify Multifactor Password Authentication (POST)
+ This API is used on the server-side to validate and verify the re-authentication token created by the MFA re-authentication API. This API checks re-authentications created by password. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/re-authentication/re-auth-validate-password/) @@ -3191,6 +3334,7 @@ response = ReAuthenticationApi.verify_multi_factor_password_reauthentication(eve
Verify Multifactor PIN Authentication (POST)
+ This API is used on the server-side to validate and verify the re-authentication token created by the MFA re-authentication API. This API checks re-authentications created by PIN. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/re-authentication/pin/re-auth-validate-pin/) @@ -3211,6 +3355,7 @@ response = ReAuthenticationApi.verify_multi_factor_pin_reauthentication(event_ba
MFA Re-authentication by Security Question (POST)
+ This API is used to validate the triggered MFA re-authentication flow with security questions answers. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/re-authentication/mfa-re-authentication-by-security-question/) @@ -3237,6 +3382,7 @@ response = ReAuthenticationApi.re_auth_by_security_question(access_token, securi
Multi Factor Re-Authenticate (GET)
+ This API is used to trigger the Multi-Factor Autentication workflow for the provided access token [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/re-authentication/re-auth-trigger/) @@ -3255,6 +3401,7 @@ response = ReAuthenticationApi.mfa_re_authenticate(access_token, sms_template_2f
Send MFA Re-auth Email OTP by Access Token (GET)
+ This API is used to send the MFA Email OTP to the email for Re-authentication [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/re-authentication/send-mfa-re-auth-email-otp-by-access-token/) @@ -3287,6 +3434,7 @@ List of APIs in this Section:
Update Consent By Access Token (PUT)
+ This API is to update consents using access token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/consent-management/update-consent-by-access-token/) @@ -3310,6 +3458,7 @@ response = ConsentManagementApi.update_consent_profile_by_access_token(access_to
Consent By ConsentToken (POST)
+ This API is to submit consent form using consent token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/consent-management/consent-by-consent-token/) @@ -3337,6 +3486,7 @@ response = ConsentManagementApi.submit_consent_by_consent_token(consent_token, c
Post Consent By Access Token (POST)
+ API to provide a way to end user to submit a consent form for particular event type. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/consent-management/consent-by-access-token/) @@ -3364,6 +3514,7 @@ response = ConsentManagementApi.submit_consent_by_access_token(access_token, con
Get Consent Logs By Uid (GET)
+ This API is used to get the Consent logs of the user. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/consent-management/consent-log-by-uid/) @@ -3381,6 +3532,7 @@ response = ConsentManagementApi.get_consent_logs_by_uid(uid)
Get Consent Log by Access Token (GET)
+ This API is used to fetch consent logs. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/consent-management/consent-log-by-access-token/) @@ -3398,6 +3550,7 @@ response = ConsentManagementApi.get_consent_logs(access_token)
Get Verify Consent By Access Token (GET)
+ This API is used to check if consent is submitted for a particular event or not. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/consent-management/verify-consent-by-access-token/) @@ -3431,6 +3584,7 @@ List of APIs in this Section:
Smart Login Verify Token (GET)
+ This API verifies the provided token for Smart Login [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/smart-login/smart-login-verify-token/) @@ -3449,6 +3603,7 @@ response = SmartLoginApi.smart_login_token_verification(verification_token, welc
Smart Login By Email (GET)
+ This API sends a Smart Login link to the user's Email Id. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/smart-login/smart-login-by-email) @@ -3470,6 +3625,7 @@ response = SmartLoginApi.smart_login_by_email(client_guid, email, redirect_url,
Smart Login By Username (GET)
+ This API sends a Smart Login link to the user's Email Id. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/smart-login/smart-login-by-username) @@ -3491,6 +3647,7 @@ response = SmartLoginApi.smart_login_by_user_name(client_guid, username, redirec
Smart Login Ping (GET)
+ This API is used to check if the Smart Login link has been clicked or not [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/smart-login/smart-login-ping) @@ -3524,6 +3681,7 @@ List of APIs in this Section:
One Touch OTP Verification (PUT)
+ This API is used to verify the otp for One Touch Login. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/one-touch-login/one-touch-otp-verification/) @@ -3544,6 +3702,7 @@ response = OneTouchLoginApi.one_touch_login_otp_verification(otp, phone, fields,
One Touch Login by Email (POST)
+ This API is used to send a link to a specified email for a frictionless login/registration [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/one-touch-login/one-touch-login-by-email-captcha/) @@ -3565,6 +3724,7 @@ response = OneTouchLoginApi.one_touch_login_by_email(one_touch_login_by_email_mo ```
One Touch Login by Phone (POST)
+ This API is used to send one time password to a given phone number for a frictionless login/registration. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/one-touch-login/one-touch-login-by-phone-captcha/) @@ -3585,6 +3745,7 @@ response = OneTouchLoginApi.one_touch_login_by_phone(one_touch_login_by_phone_mo
One Touch Email Verification (GET)
+ This API verifies the provided token for One Touch Login [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/one-touch-login/one-touch-email-verification) @@ -3603,6 +3764,7 @@ response = OneTouchLoginApi.one_touch_email_verification(verification_token, wel
One Touch Login Ping (GET)
+ This API is used to check if the One Touch Login link has been clicked or not. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/one-touch-login/one-touch-login-ping/) @@ -3638,6 +3800,7 @@ List of APIs in this Section:
Passwordless Login Phone Verification (PUT)
+ This API verifies an account by OTP and allows the customer to login. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/passwordless-login/passwordless-login-phone-verification) @@ -3657,6 +3820,7 @@ response = PasswordLessLoginApi.passwordless_login_phone_verification(password_l ```
Passwordless Login Verification By Email And OTP (POST)
+ This API is used to verify the otp sent to the email when doing a passwordless login. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/unknown/PasswordLessLogin--PasswordlessLoginVerificationByEmailAndOTP) @@ -3680,6 +3844,7 @@ response = PasswordLessLoginApi.passwordless_login_verification_by_email_and_otp
Passwordless Login Verification By User Name And OTP (POST)
+ This API is used to verify the otp sent to the email when doing a passwordless login. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/unknown/PasswordLessLogin--PasswordlessLoginVerificationByUserNameAndOTP) @@ -3701,6 +3866,7 @@ response = PasswordLessLoginApi.passwordless_login_verification_by_user_name_and
Passwordless Login by Phone (GET)
+ API can be used to send a One-time Passcode (OTP) provided that the account has a verified PhoneID [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/passwordless-login/passwordless-login-by-phone) @@ -3719,6 +3885,7 @@ response = PasswordLessLoginApi.passwordless_login_by_phone(phone, sms_template)
Passwordless Login By Email (GET)
+ This API is used to send a Passwordless Login verification link to the provided Email ID [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/passwordless-login/passwordless-login-by-email) @@ -3738,6 +3905,7 @@ response = PasswordLessLoginApi.passwordless_login_by_email(email, password_less
Passwordless Login By UserName (GET)
+ This API is used to send a Passwordless Login Verification Link to a customer by providing their UserName [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/passwordless-login/passwordless-login-by-username) @@ -3757,6 +3925,7 @@ response = PasswordLessLoginApi.passwordless_login_by_user_name(username, passwo
Passwordless Login Verification (GET)
+ This API is used to verify the Passwordless Login verification link. Note: If you are using Passwordless Login by Phone you will need to use the Passwordless Login Phone Verification API [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/passwordless-login/passwordless-login-verification) @@ -3787,6 +3956,7 @@ List of APIs in this Section:
Get Server Time (GET)
+ This API allows you to query your LoginRadius account for basic server information and server time information which is useful when generating an SOTT token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/configuration/get-server-time/) @@ -3800,6 +3970,7 @@ response = ConfigurationApi.get_server_info(time_difference) ```
Get Configuration (GET)
+ This API is used to get the configurations which are set in the LoginRadius Admin Console for a particular LoginRadius site/environment. [More info](https://www.loginradius.com/docs/api/v2/customer-identity-api/configuration/get-configurations) ```ruby @@ -3831,6 +4002,7 @@ List of APIs in this Section:
Assign Roles by UID (PUT)
+ This API is used to assign your desired roles to a given user. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/roles-management/assign-roles-by-uid/) @@ -3851,6 +4023,7 @@ response = RoleApi.assign_roles_by_uid(account_roles_model, uid)
Upsert Context (PUT)
+ This API creates a Context with a set of Roles [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/roles-management/upsert-context) @@ -3876,6 +4049,7 @@ response = RoleApi.update_role_context_by_uid(account_role_context_model, uid)
Add Permissions to Role (PUT)
+ This API is used to add permissions to a given role. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/roles-management/add-permissions-to-role) @@ -3896,6 +4070,7 @@ response = RoleApi.add_role_permissions(permissions_model, role)
Roles Create (POST)
+ This API creates a role with permissions. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/roles-management/roles-create) @@ -3918,6 +4093,7 @@ response = RoleApi.create_roles(roles_model)
Roles by UID (GET)
+ API is used to retrieve all the assigned roles of a particular User. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/roles-management/get-roles-by-uid) @@ -3935,6 +4111,7 @@ response = RoleApi.get_roles_by_uid(uid)
Get Context with Roles and Permissions (GET)
+ This API Gets the contexts that have been configured and the associated roles and permissions. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/roles-management/get-context) @@ -3952,6 +4129,7 @@ response = RoleApi.get_role_context_by_uid(uid)
Role Context profile (GET)
+ The API is used to retrieve role context by the context name. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/roles-management/role-context-profile/) @@ -3969,6 +4147,7 @@ response = RoleApi.get_role_context_by_context_name(context_name)
Roles List (GET)
+ This API retrieves the complete list of created roles with permissions of your app. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/roles-management/roles-list) @@ -3985,6 +4164,7 @@ response = RoleApi.get_roles_list()
Unassign Roles by UID (DELETE)
+ This API is used to unassign roles from a user. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/roles-management/unassign-roles-by-uid) @@ -4005,6 +4185,7 @@ response = RoleApi.unassign_roles_by_uid(account_roles_model, uid)
Delete Role Context (DELETE)
+ This API Deletes the specified Role Context [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/roles-management/delete-context) @@ -4023,6 +4204,7 @@ response = RoleApi.delete_role_context_by_uid(context_name, uid)
Delete Role from Context (DELETE)
+ This API Deletes the specified Role from a Context. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/roles-management/delete-role-from-context/) @@ -4044,6 +4226,7 @@ response = RoleApi.delete_roles_from_role_context_by_uid(context_name, role_cont
Delete Additional Permission from Context (DELETE)
+ This API Deletes Additional Permissions from Context. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/roles-management/delete-permissions-from-context) @@ -4065,6 +4248,7 @@ response = RoleApi.delete_additional_permission_from_role_context_by_uid(context
Account Delete Role (DELETE)
+ This API is used to delete the role. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/roles-management/delete-role) @@ -4082,6 +4266,7 @@ response = RoleApi.delete_role(role)
Remove Permissions (DELETE)
+ API is used to remove permissions from a role. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/roles-management/remove-permissions) @@ -4112,6 +4297,7 @@ List of APIs in this Section:
Risk Based Authentication Login by Email (POST)
+ This API retrieves a copy of the user data based on the Email [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-login-by-email) @@ -4149,6 +4335,7 @@ response = RiskBasedAuthenticationApi.rba_login_by_email(email_authentication_mo
Risk Based Authentication Login by Username (POST)
+ This API retrieves a copy of the user data based on the Username [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-login-by-username) @@ -4186,6 +4373,7 @@ response = RiskBasedAuthenticationApi.rba_login_by_user_name(user_name_authentic
Risk Based Authentication Phone Login (POST)
+ This API retrieves a copy of the user data based on the Phone [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-login) @@ -4234,6 +4422,7 @@ List of APIs in this Section:
Generate SOTT (GET)
+ This API allows you to generate SOTT with a given expiration time. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/session/generate-sott-token) @@ -4270,6 +4459,7 @@ List of APIs in this Section:
Access Token via Facebook Token (GET)
+ The API is used to get LoginRadius access token by sending Facebook's access token. It will be valid for the specific duration of time specified in the response. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/native-social-login-api/access-token-via-facebook-token/) @@ -4288,6 +4478,7 @@ response = NativeSocialApi.get_access_token_by_facebook_access_token(fb_access_t
Access Token via Twitter Token (GET)
+ The API is used to get LoginRadius access token by sending Twitter's access token. It will be valid for the specific duration of time specified in the response. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/native-social-login-api/access-token-via-twitter-token) @@ -4307,6 +4498,7 @@ response = NativeSocialApi.get_access_token_by_twitter_access_token(tw_access_to
Access Token via Google Token (GET)
+ The API is used to get LoginRadius access token by sending Google's access token. It will be valid for the specific duration of time specified in the response. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/native-social-login-api/access-token-via-google-token) @@ -4327,6 +4519,7 @@ response = NativeSocialApi.get_access_token_by_google_access_token(google_access
Access Token using google JWT token for Native Mobile Login (GET)
+ This API is used to Get LoginRadius Access Token using google jwt id token for google native mobile login/registration. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/native-social-login-api/access-token-via-googlejwt) @@ -4344,6 +4537,7 @@ response = NativeSocialApi.get_access_token_by_google_j_w_t_access_token(id_toke
Access Token via Linkedin Token (GET)
+ The API is used to get LoginRadius access token by sending Linkedin's access token. It will be valid for the specific duration of time specified in the response. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/native-social-login-api/access-token-via-linkedin-token/) @@ -4362,6 +4556,7 @@ response = NativeSocialApi.get_access_token_by_linkedin_access_token(ln_access_t
Get Access Token By Foursquare Access Token (GET)
+ The API is used to get LoginRadius access token by sending Foursquare's access token. It will be valid for the specific duration of time specified in the response. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/native-social-login-api/access-token-via-foursquare-token/) @@ -4379,6 +4574,7 @@ response = NativeSocialApi.get_access_token_by_foursquare_access_token(fs_access
Access Token via Apple Id Code (GET)
+ The API is used to get LoginRadius access token by sending a valid Apple ID OAuth Code. It will be valid for the specific duration of time specified in the response. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/native-social-login-api/access-token-via-apple-id-code) @@ -4397,6 +4593,7 @@ response = NativeSocialApi.get_access_token_by_apple_id_code(code, social_app_na
Access Token via WeChat Code (GET)
+ This API is used to retrieve a LoginRadius access token by passing in a valid WeChat OAuth Code. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/native-social-login-api/access-token-via-wechat-code) @@ -4414,6 +4611,7 @@ response = NativeSocialApi.get_access_token_by_we_chat_code(code)
Access Token via Google AuthCode (GET)
+ The API is used to get LoginRadius access token by sending Google's AuthCode. It will be valid for the specific duration of time specified in the response. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/native-social-login-api/access-token-via-google-auth-code) @@ -4438,15 +4636,54 @@ response = NativeSocialApi.get_access_token_by_google_auth_code(google_authcode, List of APIs in this Section:
-* POST : [Webhook Subscribe](#WebHookSubscribe-post-)
-* GET : [Webhook Subscribed URLs](#GetWebHookSubscribedURLs-get-)
-* GET : [Webhook Test](#WebhookTest-get-)
-* DELETE : [WebHook Unsubscribe](#WebHookUnsubscribe-delete-)
+* PUT : [Update Webhook Subscription](#UpdateWebhookSubscription-put-)
+* POST : [Create Webhook Subscription](#CreateWebhookSubscription-post-)
+* GET : [Get Webhook Subscription Detail](#GetWebhookSubscriptionDetail-get-)
+* GET : [List All Webhooks](#ListAllWebhooks-get-)
+* GET : [Get Webhook Events](#GetWebhookEvents-get-)
+* DELETE : [Delete Webhook Subscription](#DeleteWebhookSubscription-delete-)
-
Webhook Subscribe (POST)
- API can be used to configure a WebHook on your LoginRadius site. Webhooks also work on subscribe and notification model, subscribe your hook and get a notification. Equivalent to RESThook but these provide security on basis of signature and RESThook work on unique URL. Following are the events that are allowed by LoginRadius to trigger a WebHook service call. [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/webhook-subscribe) +
Update Webhook Subscription (PUT)
+ + + This API is used to update a webhook subscription [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/update-webhook-subscription/) + + + + + ```ruby + + hook_id = "" #Required + + web_hook_subscription_update_model ={ +"Headers"=> { + "x-test-header"=> "qa" + }, + "QueryParams": { + "apikey"=> "859faf40a7c54c209360b45376bf529f" + }, + "Authentication"=> { + "AuthType"=> "Basic", + "BasicAuth"=> { + "Username"=> "lrqaadmin", + "Password"=> "ZBz6JcnZadxc2gB7sf5vby87zBIu6q" + } + } +} #Required + +response = WebHookApi.update_webhook_subscription(hook_id, web_hook_subscription_update_model) + + ``` + + + + +
Create Webhook Subscription (POST)
+ + + This API is used to create a new webhook subscription on your LoginRadius site. [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/create-webhook-subscription/) @@ -4456,34 +4693,55 @@ List of APIs in this Section:
web_hook_subscribe_model ={ "event" => "", -"targetUrl" => ""} #Required +"name" => "", +"targetUrl" => "", + "Headers"=> { + "Custom-Header"=> "headerValue" + }, + "QueryParams"=> { + "apikey"=> "yourApiKey" + }, + "Authentication": { + "AuthType"=> "Basic", + "BasicAuth"=> { + "Username"=> "yourUsername", + "Password"=> "yourPassword" + } + } -response = WebHookApi.web_hook_subscribe(web_hook_subscribe_model) + +} #Required + +response = WebHookApi.create_webhook_subscription(web_hook_subscribe_model) ``` -
Webhook Subscribed URLs (GET)
- This API is used to fatch all the subscribed URLs, for particular event [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/webhook-subscribed-urls) +
Get Webhook Subscription Detail (GET)
+ + + This API is used to get details of a webhook subscription by Id [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/get-webhook-subscription-details/) ```ruby - event = "" #Required + hook_id = "" #Required -response = WebHookApi.get_web_hook_subscribed_u_r_ls(event) +response = WebHookApi.get_webhook_subscription_detail(hook_id) ``` -
Webhook Test (GET)
- API can be used to test a subscribed WebHook. [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/webhook-test) +
List All Webhooks (GET)
+ + + This API is used to get the list of all the webhooks [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/list-all-webhooks/) @@ -4491,15 +4749,17 @@ response = WebHookApi.get_web_hook_subscribed_u_r_ls(event) ```ruby -response = WebHookApi.webhook_test() +response = WebHookApi.list_all_webhooks() ``` -
WebHook Unsubscribe (DELETE)
- API can be used to unsubscribe a WebHook configured on your LoginRadius site. [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/webhook-unsubscribe) +
Get Webhook Events (GET)
+ + + This API is used to retrieve all the webhook events. [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/get-webhook-events/) @@ -4507,11 +4767,26 @@ response = WebHookApi.webhook_test() ```ruby - web_hook_subscribe_model ={ -"event" => "", -"targetUrl" => ""} #Required +response = WebHookApi.get_webhook_events() + + ``` + + + + +
Delete Webhook Subscription (DELETE)
+ + + This API is used to delete webhook subscription [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/delete-webhook-subscription/) + + + + + ```ruby + + hook_id = "" #Required -response = WebHookApi.web_hook_unsubscribe(web_hook_subscribe_model) +response = WebHookApi.delete_webhook_subscription(hook_id) ``` diff --git a/demo/vendor/gems/login_radius/LICENSE b/demo/vendor/gems/login_radius/LICENSE index c3ac770..23a023a 100644 --- a/demo/vendor/gems/login_radius/LICENSE +++ b/demo/vendor/gems/login_radius/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2022 LoginRadius Inc. +Copyright (c) 2025 LoginRadius Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/demo/vendor/gems/login_radius/README.md b/demo/vendor/gems/login_radius/README.md index 8919a5f..12d5e41 100644 --- a/demo/vendor/gems/login_radius/README.md +++ b/demo/vendor/gems/login_radius/README.md @@ -3,7 +3,7 @@ Install the SDK by adding LoginRadius to your application's `Gemfile`. ```shell -gem 'login_radius', '~> 11.5.0' +gem 'login_radius', '~> 11.6.0' ``` Then, run `$ bundle`. A copy of the SDK can also be found on our [Github](https://github.com/LoginRadius/ruby-on-rails-gem/tree/master). diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/account/account_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/account/account_api.rb index e3205a0..6eac497 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/account/account_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/account/account_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/account/role_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/account/role_api.rb index 86c5d22..b1dbd2e 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/account/role_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/account/role_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/account/sott_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/account/sott_api.rb index 2d74eb5..2b7465c 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/account/sott_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/account/sott_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/configuration_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/configuration_api.rb index 2c66113..3fcda30 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/configuration_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/configuration_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/consent_management_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/consent_management_api.rb index ddeebbb..cf40bd9 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/consent_management_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/consent_management_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/custom_object_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/custom_object_api.rb index 9796dc4..c6ea44b 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/custom_object_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/custom_object_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/multi_factor_authentication_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/multi_factor_authentication_api.rb index a424af3..bc3a7a6 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/multi_factor_authentication_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/multi_factor_authentication_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/re_authentication_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/re_authentication_api.rb index e405310..b9b0009 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/re_authentication_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/re_authentication_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/web_hook_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/web_hook_api.rb index c159af0..8fd117a 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/web_hook_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/advanced/web_hook_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius @@ -25,33 +25,32 @@ def initialize unless @api_secret != '' && @api_secret != nil end - # This API is used to fatch all the subscribed URLs, for particular event + # This API is used to get details of a webhook subscription by Id # - # @param event - Allowed events: Login, Register, UpdateProfile, ResetPassword, ChangePassword, emailVerification, AddEmail, RemoveEmail, BlockAccount, DeleteAccount, SetUsername, AssignRoles, UnassignRoles, SetPassword, LinkAccount, UnlinkAccount, UpdatePhoneId, VerifyPhoneNumber, CreateCustomObject, UpdateCustomobject, DeleteCustomObject + # @param hook_id - Unique ID of the webhook # - # @return Response Containing List of Webhhook Data + # @return Response containing Definition for Complete WebHook data # 40.1 - def get_web_hook_subscribed_u_r_ls(event) - if isNullOrWhiteSpace(event) - raise LoginRadius::Error.new, getValidationMessage('event') + def get_webhook_subscription_detail(hook_id) + if isNullOrWhiteSpace(hook_id) + raise LoginRadius::Error.new, getValidationMessage('hook_id') end query_parameters = {} query_parameters['apikey'] = @api_key query_parameters['apisecret'] = @api_secret - query_parameters['event'] = event - resource_path = 'api/v2/webhook' + resource_path = 'v2/manage/webhooks/' + hook_id get_request(resource_path, query_parameters, {}) end - # API can be used to configure a WebHook on your LoginRadius site. Webhooks also work on subscribe and notification model, subscribe your hook and get a notification. Equivalent to RESThook but these provide security on basis of signature and RESThook work on unique URL. Following are the events that are allowed by LoginRadius to trigger a WebHook service call. + # This API is used to create a new webhook subscription on your LoginRadius site. # # @param web_hook_subscribe_model - Model Class containing Definition of payload for Webhook Subscribe API # - # @return Response containing Definition of Complete Validation data + # @return Response containing Definition for Complete WebHook data # 40.2 - def web_hook_subscribe(web_hook_subscribe_model) + def create_webhook_subscription(web_hook_subscribe_model) if web_hook_subscribe_model.blank? raise LoginRadius::Error.new, getValidationMessage('web_hook_subscribe_model') end @@ -60,42 +59,80 @@ def web_hook_subscribe(web_hook_subscribe_model) query_parameters['apikey'] = @api_key query_parameters['apisecret'] = @api_secret - resource_path = 'api/v2/webhook' + resource_path = 'v2/manage/webhooks' post_request(resource_path, query_parameters, web_hook_subscribe_model) end - # API can be used to test a subscribed WebHook. + # This API is used to delete webhook subscription # + # @param hook_id - Unique ID of the webhook # - # @return Response containing Definition of Complete Validation data + # @return Response containing Definition of Delete Request # 40.3 - def webhook_test() + def delete_webhook_subscription(hook_id) + if isNullOrWhiteSpace(hook_id) + raise LoginRadius::Error.new, getValidationMessage('hook_id') + end query_parameters = {} query_parameters['apikey'] = @api_key query_parameters['apisecret'] = @api_secret - resource_path = 'api/v2/webhook/test' - get_request(resource_path, query_parameters, {}) + resource_path = 'v2/manage/webhooks/' + hook_id + delete_request(resource_path, query_parameters, {}) end - # API can be used to unsubscribe a WebHook configured on your LoginRadius site. + # This API is used to update a webhook subscription # - # @param web_hook_subscribe_model - Model Class containing Definition of payload for Webhook Subscribe API + # @param hook_id - Unique ID of the webhook + # @param web_hook_subscription_update_model - Model Class containing Definition for WebHookSubscriptionUpdateModel Property # - # @return Response containing Definition of Delete Request + # @return Response containing Definition for Complete WebHook data # 40.4 - def web_hook_unsubscribe(web_hook_subscribe_model) - if web_hook_subscribe_model.blank? - raise LoginRadius::Error.new, getValidationMessage('web_hook_subscribe_model') + def update_webhook_subscription(hook_id, web_hook_subscription_update_model) + if isNullOrWhiteSpace(hook_id) + raise LoginRadius::Error.new, getValidationMessage('hook_id') end + if web_hook_subscription_update_model.blank? + raise LoginRadius::Error.new, getValidationMessage('web_hook_subscription_update_model') + end + + query_parameters = {} + query_parameters['apikey'] = @api_key + query_parameters['apisecret'] = @api_secret + + resource_path = 'v2/manage/webhooks/' + hook_id + put_request(resource_path, query_parameters, web_hook_subscription_update_model) + end + + # This API is used to get the list of all the webhooks + # + # + # @return Response Containing List of Webhhook Data + # 40.5 + def list_all_webhooks() query_parameters = {} query_parameters['apikey'] = @api_key query_parameters['apisecret'] = @api_secret - resource_path = 'api/v2/webhook' - delete_request(resource_path, query_parameters, web_hook_subscribe_model) + resource_path = 'v2/manage/webhooks' + get_request(resource_path, query_parameters, {}) + end + + # This API is used to retrieve all the webhook events. + # + # + # @return Model Class containing Definition for WebHookEventModel Property + # 40.6 + def get_webhook_events() + + query_parameters = {} + query_parameters['apikey'] = @api_key + query_parameters['apisecret'] = @api_secret + + resource_path = 'v2/manage/webhooks/events' + get_request(resource_path, query_parameters, {}) end end end diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/authentication_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/authentication_api.rb index a77fd08..9079197 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/authentication_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/authentication_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/one_touch_login_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/one_touch_login_api.rb index 5ca8f30..b3c4f8e 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/one_touch_login_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/one_touch_login_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/password_less_login_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/password_less_login_api.rb index 16880e4..7149dbc 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/password_less_login_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/password_less_login_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/phone_authentication_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/phone_authentication_api.rb index cfff76d..920d730 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/phone_authentication_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/phone_authentication_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/pin_authentication_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/pin_authentication_api.rb index 6c238ab..f5d24f2 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/pin_authentication_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/pin_authentication_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/risk_based_authentication_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/risk_based_authentication_api.rb index 532d91d..3aa71e1 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/risk_based_authentication_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/risk_based_authentication_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/smart_login_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/smart_login_api.rb index c8bfae9..9dee5c0 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/smart_login_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/authentication/smart_login_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/social/native_social_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/social/native_social_api.rb index 6c2a1e9..eea5204 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/social/native_social_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/social/native_social_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/demo/vendor/gems/login_radius/lib/login_radius/api/social/social_api.rb b/demo/vendor/gems/login_radius/lib/login_radius/api/social/social_api.rb index cdbf0ce..745462f 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/api/social/social_api.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/api/social/social_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/demo/vendor/gems/login_radius/lib/login_radius/version.rb b/demo/vendor/gems/login_radius/lib/login_radius/version.rb index 592bbfe..c5fe9c4 100644 --- a/demo/vendor/gems/login_radius/lib/login_radius/version.rb +++ b/demo/vendor/gems/login_radius/lib/login_radius/version.rb @@ -1,3 +1,3 @@ module LoginRadius - VERSION = "11.5.0" + VERSION = "11.6.0" end \ No newline at end of file diff --git a/sdk/src/login_radius/LICENSE b/sdk/src/login_radius/LICENSE index c3ac770..23a023a 100644 --- a/sdk/src/login_radius/LICENSE +++ b/sdk/src/login_radius/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2022 LoginRadius Inc. +Copyright (c) 2025 LoginRadius Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/sdk/src/login_radius/README.md b/sdk/src/login_radius/README.md index 8919a5f..12d5e41 100644 --- a/sdk/src/login_radius/README.md +++ b/sdk/src/login_radius/README.md @@ -3,7 +3,7 @@ Install the SDK by adding LoginRadius to your application's `Gemfile`. ```shell -gem 'login_radius', '~> 11.5.0' +gem 'login_radius', '~> 11.6.0' ``` Then, run `$ bundle`. A copy of the SDK can also be found on our [Github](https://github.com/LoginRadius/ruby-on-rails-gem/tree/master). diff --git a/sdk/src/login_radius/lib/login_radius/api/account/account_api.rb b/sdk/src/login_radius/lib/login_radius/api/account/account_api.rb index e3205a0..6eac497 100644 --- a/sdk/src/login_radius/lib/login_radius/api/account/account_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/account/account_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/sdk/src/login_radius/lib/login_radius/api/account/role_api.rb b/sdk/src/login_radius/lib/login_radius/api/account/role_api.rb index 86c5d22..b1dbd2e 100644 --- a/sdk/src/login_radius/lib/login_radius/api/account/role_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/account/role_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/sdk/src/login_radius/lib/login_radius/api/account/sott_api.rb b/sdk/src/login_radius/lib/login_radius/api/account/sott_api.rb index 2d74eb5..2b7465c 100644 --- a/sdk/src/login_radius/lib/login_radius/api/account/sott_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/account/sott_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/sdk/src/login_radius/lib/login_radius/api/advanced/configuration_api.rb b/sdk/src/login_radius/lib/login_radius/api/advanced/configuration_api.rb index 2c66113..3fcda30 100644 --- a/sdk/src/login_radius/lib/login_radius/api/advanced/configuration_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/advanced/configuration_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/sdk/src/login_radius/lib/login_radius/api/advanced/consent_management_api.rb b/sdk/src/login_radius/lib/login_radius/api/advanced/consent_management_api.rb index ddeebbb..cf40bd9 100644 --- a/sdk/src/login_radius/lib/login_radius/api/advanced/consent_management_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/advanced/consent_management_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/sdk/src/login_radius/lib/login_radius/api/advanced/custom_object_api.rb b/sdk/src/login_radius/lib/login_radius/api/advanced/custom_object_api.rb index 9796dc4..c6ea44b 100644 --- a/sdk/src/login_radius/lib/login_radius/api/advanced/custom_object_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/advanced/custom_object_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/sdk/src/login_radius/lib/login_radius/api/advanced/multi_factor_authentication_api.rb b/sdk/src/login_radius/lib/login_radius/api/advanced/multi_factor_authentication_api.rb index a424af3..bc3a7a6 100644 --- a/sdk/src/login_radius/lib/login_radius/api/advanced/multi_factor_authentication_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/advanced/multi_factor_authentication_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/sdk/src/login_radius/lib/login_radius/api/advanced/re_authentication_api.rb b/sdk/src/login_radius/lib/login_radius/api/advanced/re_authentication_api.rb index e405310..b9b0009 100644 --- a/sdk/src/login_radius/lib/login_radius/api/advanced/re_authentication_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/advanced/re_authentication_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/sdk/src/login_radius/lib/login_radius/api/advanced/web_hook_api.rb b/sdk/src/login_radius/lib/login_radius/api/advanced/web_hook_api.rb index c159af0..8fd117a 100644 --- a/sdk/src/login_radius/lib/login_radius/api/advanced/web_hook_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/advanced/web_hook_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius @@ -25,33 +25,32 @@ def initialize unless @api_secret != '' && @api_secret != nil end - # This API is used to fatch all the subscribed URLs, for particular event + # This API is used to get details of a webhook subscription by Id # - # @param event - Allowed events: Login, Register, UpdateProfile, ResetPassword, ChangePassword, emailVerification, AddEmail, RemoveEmail, BlockAccount, DeleteAccount, SetUsername, AssignRoles, UnassignRoles, SetPassword, LinkAccount, UnlinkAccount, UpdatePhoneId, VerifyPhoneNumber, CreateCustomObject, UpdateCustomobject, DeleteCustomObject + # @param hook_id - Unique ID of the webhook # - # @return Response Containing List of Webhhook Data + # @return Response containing Definition for Complete WebHook data # 40.1 - def get_web_hook_subscribed_u_r_ls(event) - if isNullOrWhiteSpace(event) - raise LoginRadius::Error.new, getValidationMessage('event') + def get_webhook_subscription_detail(hook_id) + if isNullOrWhiteSpace(hook_id) + raise LoginRadius::Error.new, getValidationMessage('hook_id') end query_parameters = {} query_parameters['apikey'] = @api_key query_parameters['apisecret'] = @api_secret - query_parameters['event'] = event - resource_path = 'api/v2/webhook' + resource_path = 'v2/manage/webhooks/' + hook_id get_request(resource_path, query_parameters, {}) end - # API can be used to configure a WebHook on your LoginRadius site. Webhooks also work on subscribe and notification model, subscribe your hook and get a notification. Equivalent to RESThook but these provide security on basis of signature and RESThook work on unique URL. Following are the events that are allowed by LoginRadius to trigger a WebHook service call. + # This API is used to create a new webhook subscription on your LoginRadius site. # # @param web_hook_subscribe_model - Model Class containing Definition of payload for Webhook Subscribe API # - # @return Response containing Definition of Complete Validation data + # @return Response containing Definition for Complete WebHook data # 40.2 - def web_hook_subscribe(web_hook_subscribe_model) + def create_webhook_subscription(web_hook_subscribe_model) if web_hook_subscribe_model.blank? raise LoginRadius::Error.new, getValidationMessage('web_hook_subscribe_model') end @@ -60,42 +59,80 @@ def web_hook_subscribe(web_hook_subscribe_model) query_parameters['apikey'] = @api_key query_parameters['apisecret'] = @api_secret - resource_path = 'api/v2/webhook' + resource_path = 'v2/manage/webhooks' post_request(resource_path, query_parameters, web_hook_subscribe_model) end - # API can be used to test a subscribed WebHook. + # This API is used to delete webhook subscription # + # @param hook_id - Unique ID of the webhook # - # @return Response containing Definition of Complete Validation data + # @return Response containing Definition of Delete Request # 40.3 - def webhook_test() + def delete_webhook_subscription(hook_id) + if isNullOrWhiteSpace(hook_id) + raise LoginRadius::Error.new, getValidationMessage('hook_id') + end query_parameters = {} query_parameters['apikey'] = @api_key query_parameters['apisecret'] = @api_secret - resource_path = 'api/v2/webhook/test' - get_request(resource_path, query_parameters, {}) + resource_path = 'v2/manage/webhooks/' + hook_id + delete_request(resource_path, query_parameters, {}) end - # API can be used to unsubscribe a WebHook configured on your LoginRadius site. + # This API is used to update a webhook subscription # - # @param web_hook_subscribe_model - Model Class containing Definition of payload for Webhook Subscribe API + # @param hook_id - Unique ID of the webhook + # @param web_hook_subscription_update_model - Model Class containing Definition for WebHookSubscriptionUpdateModel Property # - # @return Response containing Definition of Delete Request + # @return Response containing Definition for Complete WebHook data # 40.4 - def web_hook_unsubscribe(web_hook_subscribe_model) - if web_hook_subscribe_model.blank? - raise LoginRadius::Error.new, getValidationMessage('web_hook_subscribe_model') + def update_webhook_subscription(hook_id, web_hook_subscription_update_model) + if isNullOrWhiteSpace(hook_id) + raise LoginRadius::Error.new, getValidationMessage('hook_id') end + if web_hook_subscription_update_model.blank? + raise LoginRadius::Error.new, getValidationMessage('web_hook_subscription_update_model') + end + + query_parameters = {} + query_parameters['apikey'] = @api_key + query_parameters['apisecret'] = @api_secret + + resource_path = 'v2/manage/webhooks/' + hook_id + put_request(resource_path, query_parameters, web_hook_subscription_update_model) + end + + # This API is used to get the list of all the webhooks + # + # + # @return Response Containing List of Webhhook Data + # 40.5 + def list_all_webhooks() query_parameters = {} query_parameters['apikey'] = @api_key query_parameters['apisecret'] = @api_secret - resource_path = 'api/v2/webhook' - delete_request(resource_path, query_parameters, web_hook_subscribe_model) + resource_path = 'v2/manage/webhooks' + get_request(resource_path, query_parameters, {}) + end + + # This API is used to retrieve all the webhook events. + # + # + # @return Model Class containing Definition for WebHookEventModel Property + # 40.6 + def get_webhook_events() + + query_parameters = {} + query_parameters['apikey'] = @api_key + query_parameters['apisecret'] = @api_secret + + resource_path = 'v2/manage/webhooks/events' + get_request(resource_path, query_parameters, {}) end end end diff --git a/sdk/src/login_radius/lib/login_radius/api/authentication/authentication_api.rb b/sdk/src/login_radius/lib/login_radius/api/authentication/authentication_api.rb index a77fd08..9079197 100644 --- a/sdk/src/login_radius/lib/login_radius/api/authentication/authentication_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/authentication/authentication_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/sdk/src/login_radius/lib/login_radius/api/authentication/one_touch_login_api.rb b/sdk/src/login_radius/lib/login_radius/api/authentication/one_touch_login_api.rb index 5ca8f30..b3c4f8e 100644 --- a/sdk/src/login_radius/lib/login_radius/api/authentication/one_touch_login_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/authentication/one_touch_login_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/sdk/src/login_radius/lib/login_radius/api/authentication/password_less_login_api.rb b/sdk/src/login_radius/lib/login_radius/api/authentication/password_less_login_api.rb index 16880e4..7149dbc 100644 --- a/sdk/src/login_radius/lib/login_radius/api/authentication/password_less_login_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/authentication/password_less_login_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/sdk/src/login_radius/lib/login_radius/api/authentication/phone_authentication_api.rb b/sdk/src/login_radius/lib/login_radius/api/authentication/phone_authentication_api.rb index cfff76d..920d730 100644 --- a/sdk/src/login_radius/lib/login_radius/api/authentication/phone_authentication_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/authentication/phone_authentication_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/sdk/src/login_radius/lib/login_radius/api/authentication/pin_authentication_api.rb b/sdk/src/login_radius/lib/login_radius/api/authentication/pin_authentication_api.rb index 6c238ab..f5d24f2 100644 --- a/sdk/src/login_radius/lib/login_radius/api/authentication/pin_authentication_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/authentication/pin_authentication_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/sdk/src/login_radius/lib/login_radius/api/authentication/risk_based_authentication_api.rb b/sdk/src/login_radius/lib/login_radius/api/authentication/risk_based_authentication_api.rb index 532d91d..3aa71e1 100644 --- a/sdk/src/login_radius/lib/login_radius/api/authentication/risk_based_authentication_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/authentication/risk_based_authentication_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/sdk/src/login_radius/lib/login_radius/api/authentication/smart_login_api.rb b/sdk/src/login_radius/lib/login_radius/api/authentication/smart_login_api.rb index c8bfae9..9dee5c0 100644 --- a/sdk/src/login_radius/lib/login_radius/api/authentication/smart_login_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/authentication/smart_login_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/sdk/src/login_radius/lib/login_radius/api/social/native_social_api.rb b/sdk/src/login_radius/lib/login_radius/api/social/native_social_api.rb index 6c2a1e9..eea5204 100644 --- a/sdk/src/login_radius/lib/login_radius/api/social/native_social_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/social/native_social_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/sdk/src/login_radius/lib/login_radius/api/social/social_api.rb b/sdk/src/login_radius/lib/login_radius/api/social/social_api.rb index cdbf0ce..745462f 100644 --- a/sdk/src/login_radius/lib/login_radius/api/social/social_api.rb +++ b/sdk/src/login_radius/lib/login_radius/api/social/social_api.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true # Created by LoginRadius Development Team -# Copyright 2019 LoginRadius Inc. All rights reserved. +# Copyright 2025 LoginRadius Inc. All rights reserved. require_relative '../../request_client' module LoginRadius diff --git a/sdk/src/login_radius/lib/login_radius/version.rb b/sdk/src/login_radius/lib/login_radius/version.rb index 592bbfe..c5fe9c4 100644 --- a/sdk/src/login_radius/lib/login_radius/version.rb +++ b/sdk/src/login_radius/lib/login_radius/version.rb @@ -1,3 +1,3 @@ module LoginRadius - VERSION = "11.5.0" + VERSION = "11.6.0" end \ No newline at end of file