LAB 2212

specs/SHIELD.json

@@ -363,6 +363,37 @@
                     }
                 ]
             },
+            "Core.HealthReport": {
+                "description": "Health report that indicates if a service is down or not that SHIELD web app relies on.",
+                "properties": {
+                    "authClient": {
+                        "description": "Flag that indicates if the client side authentication validation is working or not.",
+                        "examples": [
+                            false
+                        ],
+                        "type": "boolean"
+                    },
+                    "authServer": {
+                        "description": "Flag that indicates if the server side authentication is working or not.",
+                        "examples": [
+                            true
+                        ],
+                        "type": "boolean"
+                    }
+                },
+                "required": [
+                    "authClient",
+                    "authServer"
+                ],
+                "title": "Core System - Health Report",
+                "type": "object",
+                "examples": [
+                    {
+                        "authClient": false,
+                        "authServer": true
+                    }
+                ]
+            },
             "Core.ProgressBar": {
                 "title": "Core - Progress Bar",
                 "description": "Used to indicate the progress of a long running operation.",
@@ -3990,7 +4021,7 @@
         },
         "description": "Deprive your threats of practical significance. Deploy the Securing Privilege Access architecture. All in a few seconds.",
         "title": "SHI Environment Lockdown and Defense",
-        "version": "3.4.1"
+        "version": "3.5.0"
     },
     "openapi": "3.1.1",
     "paths": {
@@ -4033,6 +4064,42 @@
                 "summary": "Indicates If the System Requirements Are Met or Not."
             }
         },
+        "/Api/Core/Health": {
+            "get": {
+                "description": "Check the health of the various components of the SHIELD app and report back. Useful for automated health probing.",
+                "operationId": "/Api/Core/Health/Get",
+                "responses": {
+                    "201": {
+                        "description": "Service is operational!"
+                    },
+                    "500": {
+                        "description": "Service has a failure described with following report.",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/Core.HealthReport"
+                                },
+                                "examples": {
+                                    "Auth system failure": {
+                                        "summary": "Example Health Report - Auth Failure",
+                                        "description": "An example health report returned indicates the authentication components are not working.",
+                                        "value": {
+                                            "authClient": false,
+                                            "authServer": true
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                },
+                "tags": [
+                    "Core"
+                ],
+                "security": [],
+                "summary": "Health of the Service for Probing"
+            }
+        },
         "/Api/Auth/Id": {
             "get": {
                 "description": "Provides the Tenant ID and the Application ID of the service principal that access tokens need to be issued against. This is also useful for configuring public clients to be able to authenticate to for auth code flows.",

src/shield/TypeScript/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@shi-corp/sdk-shield",
-    "version": "3.4.1",
+    "version": "3.5.0",
     "type": "module",
     "main": "bin/index.js",
     "description": "SDK client used to interface with the SHIELD application.",