Released Version 11.1.0

Author: giriraj12000

CHANGELOG.md

@@ -1,7 +1,23 @@
 # LoginRadius Python SDK Change Log
 
+
+# Version 11.1.0
+
+## Enhancements:
+ - Added X-Origin-IP header support.
+ - Added 429 error code handling for "Too Many Request in a particular time frame".
+ - urllib3 support
+ - Fixed Delete API issue
+
+## Added new multiple APIs for better user experience:
+ - Get Profile By Ping.
+ - Passwordless Login Verification By Email And OTP.
+ - Passwordless Login Verification By User Name And OTP.
+
+
+
 # Version 11.0.0
-Released on **August 11,2020**
+
 ## Enhancements:
  - Added a parameter isWeb in "RefreshAccessToken" API.
  - Added a parameter SocialAppName in "getAccessTokenByFacebookAccessToken,  getAccessTokenByTwitterAccessToken,
@@ -18,84 +34,22 @@ Released on **August 11,2020**
  - linkSocialIdentity API(PUT)
  - getSocialIdentity API(GET)
 
-# Version 10.0.1
-Released on **Oct 24,2019**
-## Enhancements
-  - Fixed the pip installation issue
-
 # Version 10.0.0
-Released on **September 30,2019**
-
-## Enhancements
-This full version release includes major breaking changes with several improvements and optimizations :
-
- - Enhanced the coding standards of SDK to follow industry programming styles and best practices.
- - Enhanced security standards of SDK.
- - Reduced code between the business layer and persistence layer for optimization of SDK performance.
- - Added internal parameter validations in the API function.
- - ApiKey and ApiSecret usage redundancy removed.
- - All LoginRadius related features need to be defined once only and SDK will handle them automatically.
- - Improved the naming conventions of API functions for better readability.
- - Better Exception Handling for LoginRadius API Response in SDK.
- - Revamped complete SDK and restructured it with latest API function names and parameters.
- - Added detailed description to API functions and parameters for better understanding.
- - Updated the demo according to latest SDK changes.
- - Implemented API Region Feature.
- - Added PIN Authentication feature APIs.
- - Added Consent Management feature APIs.
- - Added Local SOTT generation
-
-
-## Added new multiple APIs for better user experience
-
- - Update Phone ID by UID
- - Upsert Email
- - Role Context profile
- - MFA Resend OTP
- - User Registration By Captcha
- - Get Access Token via Linkedin Token
- - Get Access Token By Foursquare Access Token
- - Get Active Session By Account Id
- - Get Active Session By Profile Id
- - Delete User Profiles By Email
- - Verify Multifactor OTP Authentication
- - Verify Multifactor Password Authentication
- - Verify Multifactor PIN Authentication
- - Update UID
- - MFA Re-authentication by PIN
- - PIN Login
- - Forgot PIN By Email
- - Forgot PIN By UserName
- - Reset PIN By ResetToken
- - Reset PIN By SecurityAnswer And Email
- - Reset PIN By SecurityAnswer And Username
- - Reset PIN By SecurityAnswer And Phone
- - Forgot PIN By Phone
- - Change PIN By Token
- - Reset PIN by Phone and OTP
- - Reset PIN by Email and OTP
- - Reset PIN by Username and OTP
- - Set PIN By PinAuthToken
- - Invalidate PIN Session Token
- - Submit Consent By ConsentToken
- - Get Consent Logs
- - Submit Consent By AccessToken
- - Verify Consent By AccessToken
- - Update Consent Profile By AccessToken
- - Get Consent Logs By Uid
- - Album With Cursor
- - Audio With Cursor
- - Check In With Cursor
- - Event With Cursor
- - Following With Cursor
- - Group With Cursor
- - Like With Cursor
-
-
-## Removed APIs:
-
- - GetCompanies API
- - Getstatus API
+## This full version release includes major changes with several improvements and optimizations :
+  - Enhanced the coding standards of SDK to follow industry programming styles and best practices.
+  - Enhanced security standards of SDK.
+  - Reduced code between the business layer and persistence layer for optimization of SDK performance.
+  - Added internal parameter validations in the API function
+  - ApiKey and ApiSecret usage redundancy removed
+  - All LoginRadius related features need to be defined once only and SDK will handle them automatically
+  - Improved the naming conventions of API functions for better readability.
+  - Better Error and Exception Handling for LoginRadius API Response in SDK
+  - Revamped complete SDK and restructured it with latest API function names and parameters
+  - Added detailed description to API functions and parameters for better understanding
+  - Updated the demo according to latest SDK changes
+  - Implemented API Region Feature
+  - Added Consent Management feature
+  - Added PIN Authentication feature 
 
 # Version 10.0.0-beta
 ## This beta version release includes major changes with several improvements and optimizations :
@@ -162,7 +116,7 @@ This full version release includes major breaking changes with several improveme
       - Refresh Token   
       - Delete All Records by Datasource   
 
-### Breaking Changes
+###Breaking Changes
   - Replaced deprecated [pycrypto package](https://pypi.org/project/pycrypto/) with [cryptography package](https://pypi.org/project/cryptography/) for SOTT generation
   - Updated some existing API's:    
       - Get Roles by UID: moved to role class    

Demo/LoginRadius/api/account/account_api.py

@@ -31,7 +31,7 @@ def get_privacy_policy_history_by_uid(self, uid):
         query_parameters["apiSecret"] = self._lr_object.get_api_secret()
 
         resource_path = "identity/v2/manage/account/" + uid + "/privacypolicy/history"
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})
 
     def create_account(self, account_create_model, fields=''):
         """This API is used to create an account in Cloud Storage. This API bypass the normal email verification process and manually creates the user. <br><br>In order to use this API, you need to format a JSON request body with all of the mandatory fields
@@ -79,7 +79,7 @@ def get_account_profile_by_email(self, email, fields=''):
             query_parameters["fields"] = fields
 
         resource_path = "identity/v2/manage/account"
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})
 
     def get_account_profile_by_user_name(self, user_name, fields=''):
         """This API is used to retrieve all of the profile data associated with the specified account by user name in Cloud Storage.
@@ -104,7 +104,7 @@ def get_account_profile_by_user_name(self, user_name, fields=''):
             query_parameters["fields"] = fields
 
         resource_path = "identity/v2/manage/account"
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})
 
     def get_account_profile_by_phone(self, phone, fields=''):
         """This API is used to retrieve all of the profile data, associated with the account by phone number in Cloud Storage.
@@ -129,7 +129,7 @@ def get_account_profile_by_phone(self, phone, fields=''):
             query_parameters["fields"] = fields
 
         resource_path = "identity/v2/manage/account"
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})
 
     def get_account_profile_by_uid(self, uid, fields=''):
         """This API is used to retrieve all of the profile data, associated with the account by uid in Cloud Storage.
@@ -153,7 +153,7 @@ def get_account_profile_by_uid(self, uid, fields=''):
             query_parameters["fields"] = fields
 
         resource_path = "identity/v2/manage/account/" + uid
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})
 
     def update_account_by_uid(self, account_user_profile_update_model, uid, fields='',
         null_support=None):
@@ -236,7 +236,7 @@ def get_account_password_hash_by_uid(self, uid):
         query_parameters["apiSecret"] = self._lr_object.get_api_secret()
 
         resource_path = "identity/v2/manage/account/" + uid + "/password"
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})
 
     def set_account_password_by_uid(self, password, uid):
         """This API is used to set the password of an account in Cloud Storage.
@@ -285,7 +285,7 @@ def delete_account_by_uid(self, uid):
         query_parameters["apiSecret"] = self._lr_object.get_api_secret()
 
         resource_path = "identity/v2/manage/account/" + uid
-        return self._lr_object.execute("DELETE", resource_path, query_parameters, None)
+        return self._lr_object.execute("DELETE", resource_path, query_parameters, {})
 
     def invalidate_account_email_verification(self, uid, email_template='', verification_url=''):
         """This API is used to invalidate the Email Verification status on an account.
@@ -312,7 +312,7 @@ def invalidate_account_email_verification(self, uid, email_template='', verifica
             query_parameters["verificationUrl"] = verification_url
 
         resource_path = "identity/v2/manage/account/" + uid + "/invalidateemail"
-        return self._lr_object.execute("PUT", resource_path, query_parameters, None)
+        return self._lr_object.execute("PUT", resource_path, query_parameters, {})
 
     def get_forgot_password_token(self, email, email_template=None, reset_password_url=None,
         send_email=None):
@@ -392,7 +392,7 @@ def get_access_token_by_uid(self, uid):
         query_parameters["uid"] = uid
 
         resource_path = "identity/v2/manage/account/access_token"
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})
 
     def reset_phone_id_verification_by_uid(self, uid, sms_template=''):
         """This API Allows you to reset the phone no verification of an end user’s account.
@@ -416,7 +416,7 @@ def reset_phone_id_verification_by_uid(self, uid, sms_template=''):
             query_parameters["smsTemplate"] = sms_template
 
         resource_path = "identity/v2/manage/account/" + uid + "/invalidatephone"
-        return self._lr_object.execute("PUT", resource_path, query_parameters, None)
+        return self._lr_object.execute("PUT", resource_path, query_parameters, {})
 
     def upsert_email(self, upsert_email_model, uid, fields=''):
         """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.
@@ -496,7 +496,7 @@ def refresh_access_token_by_refresh_token(self, refresh__token):
         query_parameters["refresh_Token"] = refresh__token
 
         resource_path = "identity/v2/manage/account/access_token/refresh"
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})
 
     def revoke_refresh_token(self, refresh__token):
         """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.
@@ -518,7 +518,7 @@ def revoke_refresh_token(self, refresh__token):
         query_parameters["refresh_Token"] = refresh__token
 
         resource_path = "identity/v2/manage/account/access_token/refresh/revoke"
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})
 
     def get_account_identities_by_email(self, email, fields=''):
         """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.
@@ -543,7 +543,7 @@ def get_account_identities_by_email(self, email, fields=''):
             query_parameters["fields"] = fields
 
         resource_path = "identity/v2/manage/account/identities"
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})
 
     def account_delete_by_email(self, email):
         """This API is used to delete all user profiles associated with an Email.
@@ -565,7 +565,7 @@ def account_delete_by_email(self, email):
         query_parameters["email"] = email
 
         resource_path = "identity/v2/manage/account"
-        return self._lr_object.execute("DELETE", resource_path, query_parameters, None)
+        return self._lr_object.execute("DELETE", resource_path, query_parameters, {})
 
     def account_update_uid(self, update_uid_model, uid):
         """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.

Demo/LoginRadius/api/account/role_api.py

@@ -31,7 +31,7 @@ def get_roles_by_uid(self, uid):
         query_parameters["apiSecret"] = self._lr_object.get_api_secret()
 
         resource_path = "identity/v2/manage/account/" + uid + "/role"
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})
 
     def assign_roles_by_uid(self, account_roles_model, uid):
         """This API is used to assign your desired roles to a given user.
@@ -100,7 +100,7 @@ def get_role_context_by_uid(self, uid):
         query_parameters["apiSecret"] = self._lr_object.get_api_secret()
 
         resource_path = "identity/v2/manage/account/" + uid + "/rolecontext"
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})
 
     def get_role_context_by_context_name(self, context_name):
         """The API is used to retrieve role context by the context name.
@@ -121,7 +121,7 @@ def get_role_context_by_context_name(self, context_name):
         query_parameters["apiSecret"] = self._lr_object.get_api_secret()
 
         resource_path = "identity/v2/manage/account/rolecontext/" + context_name
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})
 
     def update_role_context_by_uid(self, account_role_context_model, uid):
         """This API creates a Context with a set of Roles
@@ -170,7 +170,7 @@ def delete_role_context_by_uid(self, context_name, uid):
         query_parameters["apiSecret"] = self._lr_object.get_api_secret()
 
         resource_path = "identity/v2/manage/account/" + uid + "/rolecontext/" + context_name
-        return self._lr_object.execute("DELETE", resource_path, query_parameters, None)
+        return self._lr_object.execute("DELETE", resource_path, query_parameters, {})
 
     def delete_roles_from_role_context_by_uid(self, context_name, role_context_remove_role_model, uid):
         """This API Deletes the specified Role from a Context.
@@ -241,7 +241,7 @@ def get_roles_list(self):
         query_parameters["apiSecret"] = self._lr_object.get_api_secret()
 
         resource_path = "identity/v2/manage/role"
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})
 
     def create_roles(self, roles_model):
         """This API creates a role with permissions.
@@ -282,7 +282,7 @@ def delete_role(self, role):
         query_parameters["apiSecret"] = self._lr_object.get_api_secret()
 
         resource_path = "identity/v2/manage/role/" + role
-        return self._lr_object.execute("DELETE", resource_path, query_parameters, None)
+        return self._lr_object.execute("DELETE", resource_path, query_parameters, {})
 
     def add_role_permissions(self, permissions_model, role):
         """This API is used to add permissions to a given role.

Demo/LoginRadius/api/account/sott_api.py

@@ -30,4 +30,4 @@ def generate_sott(self, time_difference=None):
             query_parameters["timeDifference"] = time_difference
 
         resource_path = "identity/v2/manage/account/sott"
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})

Demo/LoginRadius/api/advanced/configuration_api.py

@@ -43,4 +43,4 @@ def get_server_info(self, time_difference=None):
             query_parameters["timeDifference"] = time_difference
 
         resource_path = "identity/v2/serverinfo"
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})

Demo/LoginRadius/api/advanced/consentmanagement_api.py

@@ -31,7 +31,7 @@ def get_consent_logs_by_uid(self, uid):
         query_parameters["apiSecret"] = self._lr_object.get_api_secret()
 
         resource_path = "identity/v2/manage/account/" + uid + "/consent/logs"
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})
 
     def submit_consent_by_consent_token(self, consent_token, consent_submit_model):
         """This API is to submit consent form using consent token.
@@ -76,7 +76,7 @@ def get_consent_logs(self, access_token):
         query_parameters["apiKey"] = self._lr_object.get_api_key()
 
         resource_path = "identity/v2/auth/consent/logs"
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})
 
     def submit_consent_by_access_token(self, access_token, consent_submit_model):
         """API to provide a way to end user to submit a consent form for particular event type.
@@ -128,7 +128,7 @@ def verify_consent_by_access_token(self, access_token, event, is_custom):
         query_parameters["isCustom"] = is_custom
 
         resource_path = "identity/v2/auth/consent/verify"
-        return self._lr_object.execute("GET", resource_path, query_parameters, None)
+        return self._lr_object.execute("GET", resource_path, query_parameters, {})
 
     def update_consent_profile_by_access_token(self, access_token, consent_update_model):
         """This API is to update consents using access token.