haveibeenpwned (Independent Publisher) v1.4

independent-publisher-connectors/haveibeenpwned/apiDefinition.swagger.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Have I Been Pwned",
     "description": "Check if your email address or phone number is in a data breach.",
-    "version": "1.3",
+    "version": "1.4",
     "contact": {
       "name": "Troy Taylor",
       "url": "https://www.hitachisolutions.com",
@@ -623,21 +623,188 @@
           ]
         }
       }
+    },
+    "/api/v3/breacheddomain/{domain}": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "default",
+            "schema": {
+              "type": "object",
+              "properties": {}
+            }
+          }
+        },
+        "summary": "Get all breached email addresses for a domain",
+        "description": "All email addresses on a given domain and the breaches they've appeared in can be returned.",
+        "operationId": "AllBreachesDomain",
+        "parameters": [
+          {
+            "name": "domain",
+            "in": "path",
+            "required": true,
+            "type": "string",
+            "x-ms-summary": "Domain",
+            "x-ms-url-encoding": "single",
+            "description": "The domain."
+          }
+        ]
+      }
+    },
+    "/api/v3/subscribeddomains": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "default",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "DomainName": {
+                    "type": "string",
+                    "description": "The domain name.",
+                    "title": "Domain Name"
+                  },
+                  "PwnCount": {
+                    "type": "integer",
+                    "format": "int32",
+                    "description": "The pwn count.",
+                    "title": "Pwn Count"
+                  },
+                  "PwnCountExcludingSpamLists": {
+                    "type": "integer",
+                    "format": "int32",
+                    "description": "The pwn count excluding spam lists.",
+                    "title": "Pwn Count Excluding Spam"
+                  },
+                  "PwnCountExcludingSpamListsAtLastSubscriptionRenewal": {
+                    "type": "string",
+                    "description": "The pwn count excluding spam lists at last subscription renewal.",
+                    "title": "Pwn Count Excluding Spam At Last Subscription Renewal"
+                  },
+                  "NextSubscriptionRenewal": {
+                    "type": "string",
+                    "description": "The next subscription renewal.",
+                    "title": "Next Renewal"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "summary": "Getting all subscribed domains",
+        "description": "Domains that have been successfully added to the domain search dashboard after verifying control are returned.",
+        "operationId": "AllSubscribedDomains",
+        "parameters": []
+      }
+    },
+    "/api/v3/subscription/status": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "default",
+            "schema": {
+              "type": "object",
+              "properties": {
+                "SubscribedUntil": {
+                  "type": "string",
+                  "description": "When subscribed until.",
+                  "title": "Subscribed Until"
+                },
+                "SubscriptionName": {
+                  "type": "string",
+                  "description": "The subscription name.",
+                  "title": "Subscription Name"
+                },
+                "Description": {
+                  "type": "string",
+                  "description": "The description.",
+                  "title": "Description"
+                },
+                "DomainSearchMaxBreachedAccounts": {
+                  "type": "integer",
+                  "format": "int32",
+                  "description": "The domain search maximum breached accounts.",
+                  "title": "Domain Search Max Accounts"
+                },
+                "Rpm": {
+                  "type": "integer",
+                  "format": "int32",
+                  "description": "The rate per minute.",
+                  "title": "RPM"
+                }
+              }
+            }
+          }
+        },
+        "summary": "Getting the subscription status",
+        "description": "Returns details of the current subscription.",
+        "operationId": "SubscriptionStatus",
+        "parameters": []
+      }
+    },
+    "/range/{hashCharacters}": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "default",
+            "schema": {
+              "type": "string"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "hashCharacters",
+            "x-ms-summary": "Hash Characters",
+            "x-ms-url-encoding": "single",
+            "description": "The first 5 of the hash characters.",
+            "in": "path",
+            "required": true,
+            "type": "string",
+            "minimum": 5,
+            "maximum": 5
+          },
+          {
+            "name": "mode",
+            "x-ms-summary": "Mode",
+            "description": "The mode.",
+            "in": "query",
+            "required": false,
+            "type": "string",
+            "enum": [
+              "ntlm"
+            ]
+          },
+          {
+            "name": "Add-Padding",
+            "x-ms-summary": "Add Padding",
+            "description": "Whether to add padding to ensure all results contain a random number of records between 800 and 1,000.",
+            "in": "header",
+            "required": false,
+            "type": "boolean"
+          }
+        ],
+        "summary": "Search passwords by range",
+        "description": "Retrieves a list of matching hashes and the password count (delimited by :).",
+        "operationId": "PasswordsRange"
+      }
     }
   },
   "definitions": {},
   "parameters": {},
   "responses": {},
   "securityDefinitions": {
-    "API Key": {
+    "api_key": {
       "type": "apiKey",
       "in": "header",
       "name": "hibp-api-key"
     }
   },
   "security": [
     {
-      "API Key": []
+      "api_key": []
     }
   ],
   "tags": [],