Merge pull request #920 from LoginRadius/staging

Staging2main16jan
LoginRadius · Jan 15, 2025 · 09a5c34 · 09a5c34
2 parents 6fc891c + 9384f8d
commit 09a5c34
Show file tree

Hide file tree

Showing 9 changed files with 415 additions and 3 deletions.
diff --git a/database/apidocs/apis/v2/integrations/webhooks/create-webhook-subscription.json b/database/apidocs/apis/v2/integrations/webhooks/create-webhook-subscription.json
@@ -0,0 +1,82 @@
+{
+    "name": "Create Webhook Subscription",
+    "domain": "https://api.loginradius.com",
+    "path": "/v2/manage/webhook",
+    "method": "POST",
+    "getparams": {
+        "apikey*": "@apikey@",
+        "apisecret*": "@secret@"
+    },
+    "postparams": {
+        "Event": "eventName",
+        "TargetUrl": "https://example.com/api/webhook",
+        "Name": "Description of the Event",
+        "Headers": {
+            "Custom-Header": "headerValue"
+        },
+        "QueryParams": {
+            "apikey": "yourApiKey"
+        },
+        "Authentication": {
+            "AuthType": "Basic",
+            "BasicAuth": {
+                "Username": "yourUsername",
+                "Password": "yourPassword"
+            }
+        }
+    },    
+    "headers": {
+        "content-Type": "application/json"
+    },
+    "response": "json",
+    "description": "This API is used to create a new webhook subscription.",
+    "parameters": {
+        "Get Params": [
+            {
+                "name": "apikey",
+                "is_required": true,
+                "description": "LoginRadius API Key"
+            },
+            {
+                "name": "apisecret",
+                "is_required": true,
+                "description": "LoginRadius API Secret"
+            }
+        ],
+        "Post Params": [
+            {
+                "name": "TargetUrl",
+                "is_required": true,
+                "description": "URL where trigger will send data when it invoke"
+            },
+            {
+                "name": "Event",
+                "is_required": true,
+                "description": "Allowed events: Login, Register, UpdateProfile, ResetPassword, ChangePassword, EmailVerification, AddEmail, RemoveEmail, BlockAccount, DeleteAccount, SetUsername, AssignRoles, UnassignRoles, SetPassword, LinkAccount, UnlinkAccount, UpdatePhoneId, VerifyPhoneNumber, InvalidateEmailVerification, RemoveRoleContext, CreateCustomObject, UpdateCustomObject, DeleteCustomObject, InvalidatePhoneVerification, RemovePhoneId, ConsentProfileUpdate, SetPIN, ResetPIN, ChangePIN, UpdateUid"
+            }
+        ]
+    },
+    "outputFormat": {
+        "Id": "62218e79349528401107cdf4",
+        "TargetUrl": "https://example.com/api/webhook",
+        "Event": "login",
+        "CreatedDate": "2022-03-04T03:58:49.294Z",
+        "LastModifiedDate": "2024-11-27T06:47:12.933Z",
+        "SecretName": "",
+        "IsIntegrationWebhook": false,
+        "Name": "login With Key in QueryParam",
+        "Headers": {
+            "x-test-header": "qa"
+        },
+        "QueryParams": {
+            "apikey": "859faf40a7c54c209360b45376bf529f"
+        },
+        "Authentication": {
+            "AuthType": "Basic",
+            "BasicAuth": {
+                "Username": "lrqaadmin",
+                "Password": ""
+            }
+        }
+    }
+}
diff --git a/database/apidocs/apis/v2/integrations/webhooks/delete-webhook-subscription.json b/database/apidocs/apis/v2/integrations/webhooks/delete-webhook-subscription.json
@@ -0,0 +1,42 @@
+{
+    "name": "Delete Webhook Subscription",
+    "domain": "https://api.loginradius.com",
+    "path": "/v2/manage/webhook/{hookid}",
+    "method": "DELETE",
+    "getparams": {
+        "apikey*": "@apikey@",
+        "apisecret*": "@secret@"
+    },
+    "templateparams": {
+        "hookId": "ID of the webhook subscription"
+    },
+    "headers": {
+        "content-Type": "application/json"
+    },
+    "response": "json",
+    "description": "This API is used to delete webhook subscriptions.",
+    "parameters": {
+        "Get Params": [
+            {
+                "name": "apikey",
+                "is_required": true,
+                "description": "LoginRadius API Key"
+            },
+            {
+                "name": "apisecret",
+                "is_required": true,
+                "description": "LoginRadius API Secret"
+            }
+        ],
+        "Template Params": [
+            {
+                "name": "hookid",
+                "is_required": true,
+                "description": "It is a unique ID of a webhook subscription."
+            }
+        ]
+    },
+    "outputFormat": {
+        "isdeleted": true
+    }
+}
diff --git a/database/apidocs/apis/v2/integrations/webhooks/get-webhook-subscription-details.json b/database/apidocs/apis/v2/integrations/webhooks/get-webhook-subscription-details.json
@@ -0,0 +1,56 @@
+{
+    "name": "Get Webhook Subscription Details",
+    "domain": "https://api.loginradius.com",
+    "path": "/v2/manage/webhook/{hookid}",
+    "method": "GET",
+    "getparams": {
+        "apikey*": "@apikey@",
+        "apisecret*": "@secret@"
+    },
+    "templateparams": {
+        "hookId": "ID of the webhook subscription"
+    },
+    "headers": {
+        "content-Type": "application/json"
+    },
+    "response": "json",
+    "description": "This API is used to get details of a webhook subscription by Id",
+    "parameters": {
+        "Get Params": [
+            {
+                "name": "apikey",
+                "is_required": true,
+                "description": "LoginRadius API Key"
+            },
+            {
+                "name": "apisecret",
+                "is_required": true,
+                "description": "LoginRadius API Secret"
+            }
+        ],
+        "Template Params": [
+            {
+                "name": "hookid",
+                "is_required": true,
+                "description": "It is a unique ID of a webhook subscription."
+            }
+        ]
+    },
+    "outputFormat": {
+        "Id": "62218e79349528401107cdf4",
+        "TargetUrl": "https://example.com/api/webhook",
+        "Event": "login",
+        "CreatedDate": "2022-03-04T03:58:49.294Z",
+        "LastModifiedDate": "2024-11-27T06:47:12.933Z",
+        "SecretName": "",
+        "Name": "",
+        "IsIntegrationWebhook": false,
+        "Headers": {
+          "x-testing": "xxxyyyy"
+        },
+        "QueryParams": {
+          "Test": "nnn"
+        },
+        "Authentication": null
+    }
+}
diff --git a/database/apidocs/apis/v2/integrations/webhooks/list-all-events.json b/database/apidocs/apis/v2/integrations/webhooks/list-all-events.json
@@ -0,0 +1,64 @@
+{
+    "name": "List All Events",
+    "domain": "https://api.loginradius.com",
+    "path": "/v2/manage/webhook/events",
+    "method": "GET",
+    "getparams": {
+        "apikey*": "@apikey@",
+        "apisecret*": "@secret@"
+    },
+    "headers": {
+        "content-Type": "application/json"
+    },
+    "response": "json",
+    "description": "This API is used to get all webhook events.",
+    "parameters": {
+        "Get Params": [
+            {
+                "name": "apikey",
+                "is_required": true,
+                "description": "LoginRadius API Key"
+            },
+            {
+                "name": "apisecret",
+                "is_required": true,
+                "description": "LoginRadius API Secret"
+            }
+        ]
+    },
+    "outputFormat": {
+      "Data": [
+          "Login",
+          "Register",
+          "UpdateProfile",
+          "ResetPassword",
+          "ChangePassword",
+          "EmailVerification",
+          "AddEmail",
+          "RemoveEmail",
+          "BlockAccount",
+          "DeleteAccount",
+          "SetUsername",
+          "CreateTraditionalAccount",
+          "AssignRoles",
+          "UnassignRoles",
+          "SetPassword",
+          "LinkAccount",
+          "UnlinkAccount",
+          "UpdatePhoneId",
+          "VerifyPhoneNumber",
+          "InvalidateEmailVerification",
+          "RemoveRoleContext",
+          "CreateCustomObject",
+          "UpdateCustomObject",
+          "DeleteCustomObject",
+          "InvalidatePhoneVerification",
+          "RemovePhoneId",
+          "ConsentProfileUpdate",
+          "SetPIN",
+          "ResetPIN",
+          "ChangePIN",
+          "UpdateUid"
+       ]
+   }
+}
diff --git a/database/apidocs/apis/v2/integrations/webhooks/list-all-webhooks.json b/database/apidocs/apis/v2/integrations/webhooks/list-all-webhooks.json
@@ -0,0 +1,63 @@
+{
+    "name": "List All Webhooks",
+    "domain": "https://api.loginradius.com",
+    "path": "/v2/manage/webhook",
+    "method": "GET",
+    "getparams": {
+        "apikey*": "@apikey@",
+        "apisecret*": "@secret@"
+    },
+    "headers": {
+        "content-Type": "application/json"
+    },
+    "response": "json",
+    "description": "This API is used to list all webhook subscriptions.",
+    "parameters": {
+        "Get Params": [
+            {
+                "name": "apikey",
+                "is_required": true,
+                "description": "LoginRadius API Key"
+            },
+            {
+                "name": "apisecret",
+                "is_required": true,
+                "description": "LoginRadius API Secret"
+            }
+        ]
+    },
+    "outputFormat": {
+        "Data": [
+          {
+            "Id": "62218e79349528401107cdf4",
+            "TargetUrl": "https://domcheck.page2-examplurl.co.uk/page/string",
+            "Event": "login",
+            "CreatedDate": "2022-03-04T03:58:49.294Z",
+            "LastModifiedDate": "2024-11-27T06:47:12.933Z",
+            "SecretName": "",
+            "Name": "",
+            "IsIntegrationWebhook": false,
+            "Headers": {
+              "x-testing": "xxxyyyy"
+            },
+            "QueryParams": {
+              "Test": "nnn"
+            },
+            "Authentication": null
+          },
+          {
+            "Id": "6221d99b098ba46a356fc92e",
+            "TargetUrl": "https://domcheck.page2-examplurl.co.uk/page/string",
+            "Event": "login",
+            "CreatedDate": "2022-03-04T09:19:23.072Z",
+            "LastModifiedDate": "2022-03-04T09:19:23.072Z",
+            "SecretName": "",
+            "Name": "",
+            "IsIntegrationWebhook": false,
+            "Headers": null,
+            "QueryParams": null,
+            "Authentication": null
+          }
+        ]
+    }
+}
diff --git a/database/apidocs/apis/v2/integrations/webhooks/update-webhook-subscription.json b/database/apidocs/apis/v2/integrations/webhooks/update-webhook-subscription.json
@@ -0,0 +1,77 @@
+{
+    "name": "Update Webhook Subscription",
+    "domain": "https://api.loginradius.com",
+    "path": "/v2/manage/webhook/{hookid}",
+    "method": "PUT",
+    "getparams": {
+        "apikey*": "@apikey@",
+        "apisecret*": "@secret@"
+    },
+    "templateparams": {
+        "hookId": "ID of the webhook subscription"
+    },
+    "postparams": {
+        "Headers": {
+            "x-test-header": "qa"
+         },
+         "QueryParams": {
+            "apikey": "859faf40a7c54c209360b45376bf529f"
+         },
+         "Authentication": {
+            "AuthType": "Basic",
+            "BasicAuth": {
+                "Username": "lrqaadmin",
+                "Password": "ZBz6JcnZadxc2gB7sf5vby87zBIu6q"
+            }
+        }
+    },
+    "headers": {
+        "content-Type": "application/json"
+    },
+    "response": "json",
+    "description": "This API is used to update webhook subscriptions.",
+    "parameters": {
+        "Get Params": [
+            {
+                "name": "apikey",
+                "is_required": true,
+                "description": "LoginRadius API Key"
+            },
+            {
+                "name": "apisecret",
+                "is_required": true,
+                "description": "LoginRadius API Secret"
+            }
+        ],
+        "Template Params": [
+            {
+                "name": "hookid",
+                "is_required": true,
+                "description": "It is a unique ID of a webhook subscription."
+            }
+        ]
+    },
+    "outputFormat": {
+        "Id": "62218e79349528401107cdf4",
+        "TargetUrl": "2",
+        "Event": "login",
+        "CreatedDate": "2022-03-04T03:58:49.294Z",
+        "LastModifiedDate": "2024-11-27T06:47:12.933Z",
+        "SecretName": "",
+        "IsIntegrationWebhook": false,
+        "Name": "login With Key in QueryParam",
+        "Headers": {
+            "x-test-header": "qa"
+        },
+        "QueryParams": {
+            "apikey": "859faf40a7c54c209360b45376bf529f"
+        },
+        "Authentication": {
+            "AuthType": "Basic",
+            "BasicAuth": {
+                "Username": "lrqaadmin",
+                "Password": ""
+            }
+        }
+    }
+}
diff --git a/database/apidocs/changelog/core-api-release-36120.json b/database/apidocs/changelog/core-api-release-36120.json
@@ -9,7 +9,7 @@
                 "text": "Added CORS support for LoginRadius APIs with configurable <code>AllowOriginHeaderValidation</code> to enhance API security."
             },
             {
-                "text": "Seven new APIs have been introduced to enhance webhook management capabilities, including setting custom headers, query parameters, and credentials."
+                "text": "Six new APIs have been introduced to enhance webhook management capabilities, including setting custom headers, query parameters, and credentials."
             }
         ], 
         "IMPROVED":