SHIELD.json

{
    "components": {
        "parameters": {
            "correlationId": {
                "description": "The object ID of the correlation identifier for the specified record.",
                "in": "path",
                "name": "correlationId",
                "required": true,
                "schema": {
                    "examples": [
                        "1d71e0fe-6e4a-464d-a690-80addf3bda55"
                    ],
                    "format": "uuid",
                    "maxLength": 36,
                    "minLength": 36,
                    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                    "type": "string"
                },
                "examples": {
                    "valid correlation ID": {
                        "value": "1d71e0fe-6e4a-464d-a690-80addf3bda55",
                        "summary": "Example Valid Correlation ID",
                        "description": "An example of a valid correlation ID in type UUID."
                    }
                }
            },
            "deviceId": {
                "description": "The SHIELD ID (Entra ID Device ID) of the managed device to target.",
                "in": "path",
                "name": "deviceId",
                "required": true,
                "schema": {
                    "examples": [
                        "75da7fa4-4a04-44c8-8f2c-c1b2fa29aa51"
                    ],
                    "format": "uuid",
                    "maxLength": 36,
                    "minLength": 36,
                    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                    "type": "string"
                },
                "examples": {
                    "valid device ID": {
                        "value": "75da7fa4-4a04-44c8-8f2c-c1b2fa29aa51",
                        "summary": "Example Valid Device ID",
                        "description": "An example of a valid managed Entra ID device ID in type UUID."
                    }
                }
            },
            "intermediaryId": {
                "description": "The Object ID of the parent group for the intermediary that you wish to target.",
                "in": "path",
                "name": "intermediaryId",
                "required": true,
                "schema": {
                    "examples": [
                        "25d4d9da-28ea-42f8-b3df-23c3969abffa"
                    ],
                    "format": "uuid",
                    "maxLength": 36,
                    "minLength": 36,
                    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                    "type": "string"
                },
                "examples": {
                    "valid intermediary ID": {
                        "value": "25d4d9da-28ea-42f8-b3df-23c3969abffa",
                        "summary": "Example Intermediary ID",
                        "description": "An example of a valid parent group ID in type UUID."
                    }
                }
            },
            "nextLink": {
                "description": "Information to be provided to the API call in order to retrieve next set of data as part of pagination. It could be a simple number or full URL representing MS Graph API navigation. This information should not be generated by hand or changed. In case of MS Graph API, please only use tokens the server gives you and do not bring them from outside.",
                "in": "query",
                "name": "nextLink",
                "schema": {
                    "examples": [
                        "3"
                    ],
                    "minLength": 1,
                    "type": "string"
                },
                "examples": {
                    "Number": {
                        "value": "3",
                        "summary": "Number for the Next Page in the Navigation Flow",
                        "description": "The number representation with minimal length for the next page in the navigation flow."
                    },
                    "Uri": {
                        "value": "https://graph.microsoft.com/beta/devices?$top=20&$skiptoken=RFNwdCtEZXZpY2VfMThkNGY4OTAtMDA2YS00ZWM1LWI2OWYtY2VmNDY4ZjczNzQ4K0RldmljZV8xOGQ0Zjg5MC0wMDZhLTRlYzUtYjY5Zi1jZWY0NjhmNzM3NDg",
                        "summary": "Complete URL With Details of the Request and a Skip Token for MS Graph to Parse and Respond.",
                        "description": "The uri representation for the next page in the navigation flow. This example shows the complete URL with details of the request and a skip token for MS Graph to parse and respond."
                    }
                }
            },
            "offeringId": {
                "description": "Unique identifier of the marketplace offering",
                "in": "path",
                "name": "offeringId",
                "required": true,
                "schema": {
                    "description": "Unique identifier of the marketplace offering.",
                    "examples": [
                        "271ab834-7469-4f2d-a705-549972c4f325"
                    ],
                    "format": "uuid",
                    "maxLength": 36,
                    "minLength": 36,
                    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                    "type": "string"
                },
                "examples": {
                    "valid offering ID": {
                        "value": "271ab834-7469-4f2d-a705-549972c4f325",
                        "summary": "Example of an Offering ID",
                        "description": "An example of an valid marketplace offering ID in type UUID."
                    }
                }
            },
            "operation": {
                "description": "Flag to indicate which progress data in the Deploy Engine to retrieve. If invalid value is provided, it would be ignored and result defaulted to deploy operation.",
                "in": "query",
                "name": "operation",
                "schema": {
                    "examples": [
                        "remediate"
                    ],
                    "type": "string",
                    "enum": [
                        "deploy",
                        "remediate",
                        "analysis"
                    ]
                },
                "examples": {
                    "valid request": {
                        "value": "remediate",
                        "summary": "Example of the Request That Provides Expected Value",
                        "description": "An example of a valid value that indicates the progress bar data to retrieve is for remediation action."
                    },
                    "invalid request": {
                        "value": "somethingelse",
                        "summary": "Example of the Request That Includes Unexpected Value",
                        "description": "An example of an incorrect value that would be ignored and defaulted to data for deploy action."
                    }
                }
            },
            "search": {
                "description": "Used in object filtering.",
                "in": "query",
                "name": "search",
                "schema": {
                    "examples": [
                        "finance"
                    ],
                    "type": "string"
                },
                "examples": {
                    "valid search term": {
                        "value": "finance",
                        "summary": "Example Search Term",
                        "description": "An example valid search term used in object filtering in a query."
                    }
                }
            },
            "securityClass": {
                "description": "The security class of managed object to retrieve. Unknown values, will be ignored. Please see https://learn.microsoft.com/en-us/security/compass/privileged-access-security-levels for a description of security levels.",
                "in": "path",
                "name": "securityClass",
                "required": true,
                "schema": {
                    "$ref": "#/components/schemas/SecurityClassList"
                },
                "examples": {
                    "Privileged": {
                        "value": "Privileged",
                        "summary": "Example Security Class",
                        "description": "An example enum string that indicates the security class of an managed object is privileged."
                    }
                }
            },
            "templateId": {
                "description": "Reference to the specific configuration item that is deployed in the tenant.",
                "in": "path",
                "name": "templateId",
                "required": true,
                "schema": {
                    "type": "string",
                    "format": "uuid",
                    "maxLength": 36,
                    "minLength": 36,
                    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                    "examples": [
                        "42ff150d-2ff0-4b38-849e-fe6aa5eedb49"
                    ]
                },
                "examples": {
                    "valid template ID": {
                        "value": "7e2a1c3b-4d5f-4a8b-9e6a-2c1b7f3d8e4a",
                        "summary": "Example of a Valid Template ID",
                        "description": "An example of a correct template ID value in UUID format used in restoration and skip operations."
                    }
                }
            },
            "updateChannelName": {
                "description": "Name of the update channel that should be used when querying or downloading updates.",
                "in": "path",
                "name": "Update Channel Name",
                "required": true,
                "schema": {
                    "examples": [
                        "stable"
                    ],
                    "type": "string",
                    "enum": [
                        "alpha",
                        "beta",
                        "stable"
                    ]
                },
                "examples": {
                    "valid channel name": {
                        "value": "stable",
                        "summary": "Example of an Update Channel Name",
                        "description": "An example of an valid update channel name that should be used when querying or downloading updates."
                    }
                }
            },
            "userId": {
                "description": "The SHIELD ID (Entra ID User's Object ID) of the managed user to target.",
                "in": "path",
                "name": "userId",
                "required": true,
                "schema": {
                    "examples": [
                        "264a8bed-0714-48fd-8b9d-0e4c4715cee5"
                    ],
                    "format": "uuid",
                    "maxLength": 36,
                    "minLength": 36,
                    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                    "type": "string"
                },
                "examples": {
                    "valid user ID": {
                        "value": "264a8bed-0714-48fd-8b9d-0e4c4715cee5",
                        "summary": "Example of a User ID",
                        "description": "An example of valid EntraID managed user ID in type UUID."
                    }
                }
            }
        },
        "responses": {
            "201": {
                "description": "The authorization was recorded successfully."
            },
            "202": {
                "description": "The process to create a report has started."
            },
            "400": {
                "description": "Invalid input!"
            },
            "401": {
                "description": "Principal is not authorized to access this endpoint. Check to make sure the Bearer token is valid and present!"
            },
            "403": {
                "description": "Principal does not contain the correct scopes (permissions) for the API call that was made, or was made from the wrong tenant. If the permissions were granted, ensure that the access token was requested with the correct scopes."
            },
            "404": {
                "description": "The requested object was not found."
            },
            "409": {
                "description": "A job is already in progress."
            },
            "525": {
                "description": "Infrastructure not deployed. Please deploy the infrastructure before using this endpoint."
            }
        },
        "schemas": {
            "Core.SystemRequirements": {
                "title": "Core - System Requirements",
                "description": "Collection of indicators that notify the caller if the system requirements have been met for various sub components to operate.",
                "properties": {
                    "authenticatorPermissions": {
                        "description": "Flag that indicates if the core permissions for the SHIELD - Authenticator App have been configured properly or not.",
                        "type": "boolean",
                        "examples": [
                            true
                        ]
                    },
                    "azurePermissions": {
                        "description": "Flag that indicates if the required core Azure RBAC assignment(s) are present or not.",
                        "type": "boolean",
                        "examples": [
                            false
                        ]
                    },
                    "defendEntitlement": {
                        "description": "Flag that indicates if the required defend licenses are present or not.",
                        "type": "boolean",
                        "examples": [
                            true
                        ]
                    },
                    "deployEntitlement": {
                        "description": "Flag that indicates if the required deploy licenses are present or not.",
                        "type": "boolean",
                        "examples": [
                            true
                        ]
                    },
                    "discoverEntitlement": {
                        "description": "Flag that indicates if the required discover licenses are present or not.",
                        "type": "boolean",
                        "examples": [
                            true
                        ]
                    },
                    "msGraphPermissions": {
                        "description": "Flag that indicates if the core permissions for the Microsoft Graph API have been configured properly or not.",
                        "type": "boolean",
                        "examples": [
                            false
                        ]
                    },
                    "dataGatewayPermissions": {
                        "description": "Flag that indicates if the core permissions for the SHI - Data Gateway have been configured properly or not.",
                        "type": "boolean",
                        "examples": [
                            false
                        ]
                    },
                    "entraDirectoryRole": {
                        "description": "Flag that indicates if the core permissions for Entra Directory Role assignment have been configured properly or not.",
                        "type": "boolean",
                        "examples": [
                            false
                        ]
                    }
                },
                "type": "object",
                "required": [
                    "authenticatorPermissions",
                    "azurePermissions",
                    "defendEntitlement",
                    "deployEntitlement",
                    "discoverEntitlement",
                    "msGraphPermissions",
                    "dataGatewayPermissions",
                    "entraDirectoryRole"
                ],
                "examples": [
                    {
                        "authenticatorPermissions": true,
                        "azurePermissions": false,
                        "defendEntitlement": true,
                        "deployEntitlement": false,
                        "discoverEntitlement": true,
                        "msGraphPermissions": false,
                        "dataGatewayPermissions": false,
                        "entraDirectoryRole": false
                    }
                ]
            },
            "Core.ProgressBar": {
                "title": "Core - Progress Bar",
                "description": "Used to indicate the progress of a long running operation.",
                "properties": {
                    "childBar": {
                        "description": "Sub progress bar that should appear below the current progress bar for a dependent execution branch.",
                        "type": "array",
                        "minItems": 0,
                        "items": {
                            "$ref": "#/components/schemas/Core.ProgressBar"
                        },
                        "examples": [
                            [
                                {
                                    "description": "Collecting data from the Microsoft Entra ID system.",
                                    "displayName": "Running Entra ID Plugin",
                                    "id": "b759230f-48cb-496e-ad57-5f079083226b",
                                    "currentStep": 5,
                                    "totalStepCount": 7
                                }
                            ]
                        ]
                    },
                    "description": {
                        "type": "string",
                        "description": "Long form text describing the current step.",
                        "examples": [
                            "Collecting data from the Microsoft Entra ID system."
                        ]
                    },
                    "displayName": {
                        "type": "string",
                        "description": "Text/label to render with the progress bar.",
                        "examples": [
                            "Running Entra ID Plugin"
                        ]
                    },
                    "id": {
                        "description": "Unique identifier to be able to select this specific instance via search.",
                        "type": "string",
                        "format": "uuid",
                        "maxLength": 36,
                        "minLength": 36,
                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                        "examples": [
                            "b759230f-48cb-496e-ad57-5f079083226b"
                        ]
                    },
                    "currentStep": {
                        "description": "Current step/value for the progress bar. This is in relation to the `totalStepCount` property. If undefined, an indeterminate/pulsing progress bar is used instead.",
                        "examples": [
                            5
                        ],
                        "type": "number"
                    },
                    "totalStepCount": {
                        "description": "Number of steps before the progress bar is completely filed.",
                        "examples": [
                            7
                        ],
                        "type": "number",
                        "minimum": 1
                    }
                },
                "type": "object",
                "required": [
                    "childBar",
                    "displayName",
                    "id",
                    "totalStepCount"
                ],
                "examples": [
                    {
                        "childBar": [],
                        "description": "Collecting data from the Microsoft Entra ID system.",
                        "displayName": "Running Entra ID Plugin",
                        "id": "b759230f-48cb-496e-ad57-5f079083226b",
                        "currentStep": 5,
                        "totalStepCount": 7
                    }
                ]
            },
            "Authenticator.RequestStatus": {
                "title": "Authentication - Status",
                "description": "List of credentials that are being waited for by SHIELD's internal authentication engine.",
                "properties": {
                    "accessToken": {
                        "oneOf": [
                            {
                                "description": "Flag that represents if the server is not waiting for a specific access token.",
                                "type": "boolean",
                                "examples": [
                                    false
                                ]
                            },
                            {
                                "$ref": "#/components/schemas/Authenticator.Status.TokenAudience"
                            }
                        ],
                        "examples": [
                            false,
                            {
                                "audience": "00000002-0000-0000-b000-000000000000"
                            }
                        ]
                    },
                    "sccAuth": {
                        "description": "Flag that represents if the server is waiting for SCC Auth credentials.",
                        "type": "boolean",
                        "examples": [
                            true
                        ]
                    }
                },
                "type": "object",
                "required": [
                    "accessToken",
                    "sccAuth"
                ],
                "examples": [
                    {
                        "accessToken": {
                            "audience": "00000002-0000-0000-b000-000000000000"
                        },
                        "sccAuth": true
                    }
                ]
            },
            "Authenticator.Status.TokenAudience": {
                "title": "SHIELD - Authenticator - Status - Token Audience",
                "description": "If a access token is being requested, this is the audience that the access token should have when being submitted.",
                "properties": {
                    "audience": {
                        "description": "Audience ID of the access token that is being requested.",
                        "type": "string",
                        "format": "uuid",
                        "maxLength": 36,
                        "minLength": 36,
                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                        "examples": [
                            "00000002-0000-0000-b000-000000000000"
                        ]
                    }
                },
                "type": "object",
                "required": [
                    "audience"
                ],
                "examples": [
                    {
                        "audience": "00000002-0000-0000-b000-000000000000"
                    }
                ]
            },
            "Authenticator.Container.SccAuthCredentials": {
                "title": "SHIELD - Authenticator - SCC Auth",
                "description": "SHIELD - Defender, and Purview portal Container Credentials",
                "type": "object",
                "properties": {
                    "authenticatedUpn": {
                        "description": "User principal name of the user that authenticated to the portals.",
                        "examples": [
                            "user@example.com"
                        ],
                        "type": "string",
                        "format": "email"
                    },
                    "expiration": {
                        "description": "Point in time at which the whole authentication structure has an expired state and is un-useable.",
                        "examples": [
                            "2024-09-26T18:16:29.340Z"
                        ],
                        "type": "string",
                        "format": "date-time"
                    },
                    "defender": {
                        "$ref": "#/components/schemas/Authenticator.Container.SccAuthCredentials.CredentialContainer"
                    },
                    "security": {
                        "$ref": "#/components/schemas/Authenticator.Container.SccAuthCredentials.CredentialContainer"
                    },
                    "purview": {
                        "$ref": "#/components/schemas/Authenticator.Container.SccAuthCredentials.CredentialContainer"
                    }
                },
                "required": [
                    "authenticatedUpn",
                    "security",
                    "purview"
                ],
                "examples": [
                    {
                        "authenticatedUpn": "user@example.com",
                        "security": {
                            "sccAuth": "54BKPtTL-eSMFp5cqYTMMSblm2U80cUJqQgmbe4f_sRn4ammMmU1NKNurn9HqpsUtS4FrMJRTKa3Or_pFbedM_57R0fVBfNJ-m2Pvey9OweWIDradzT0dB1WnufPTJiT2y7zSQy91Y9wJIn1_aY5q-MNh75qwjM84Dng-mYzbd9KqUfyPUolOo-j-... (Truncated)",
                            "xsrf": "PEDwTvWdm2qSTe-n8h-1praK4OcQK1ELTJ08DWYqBRzQiyA2MIuEKEMNLu4ExjDNpAOUnAxmsqOeuGzb82MJYkegOE6hW8BzpSM6k9nbTbJ4yjNGzMSQvWUnyqrBvGa8JfSRiSeaKdXGBnxGd90Spw2:... (truncated)"
                        },
                        "purview": {
                            "sccAuth": "54BKPtTL-eSMFp5cqYTMMSblm2U80cUJqQgmbe4f_sRn4ammMmU1NKNurn9HqpsUtS4FrMJRTKa3Or_pFbedM_57R0fVBfNJ-m2Pvey9OweWIDradzT0dB1WnufPTJiT2y7zSQy91Y9wJIn1_aY5q-MNh75qwjM84Dng-mYzbd9KqUfyPUolOo-j-... (Truncated)",
                            "xsrf": "PEDwTvWdm2qSTe-n8h-1praK4OcQK1ELTJ08DWYqBRzQiyA2MIuEKEMNLu4ExjDNpAOUnAxmsqOeuGzb82MJYkegOE6hW8BzpSM6k9nbTbJ4yjNGzMSQvWUnyqrBvGa8JfSRiSeaKdXGBnxGd90Spw2:... (truncated)"
                        },
                        "expiration": "2024-09-26T18:16:29.340Z",
                        "defender": {
                            "sccAuth": "54BKPtTL-eSMFp5cqYTMMSblm2U80cUJqQgmbe4f_sRn4ammMmU1NKNurn9HqpsUtS4FrMJRTKa3Or_pFbedM_57R0fVBfNJ-m2Pvey9OweWIDradzT0dB1WnufPTJiT2y7zSQy91Y9wJIn1_aY5q-MNh75qwjM84Dng-mYzbd9KqUfyPUolOo-j-... (Truncated)",
                            "xsrf": "PEDwTvWdm2qSTe-n8h-1praK4OcQK1ELTJ08DWYqBRzQiyA2MIuEKEMNLu4ExjDNpAOUnAxmsqOeuGzb82MJYkegOE6hW8BzpSM6k9nbTbJ4yjNGzMSQvWUnyqrBvGa8JfSRiSeaKdXGBnxGd90Spw2:... (truncated)"
                        }
                    }
                ]
            },
            "Authenticator.Container.SccAuthCredentials.CredentialContainer": {
                "title": "SHIELD - Authenticator - SCC Auth - Credential Container",
                "description": "Container for the credentials for a single SccAuth authenticated site.",
                "properties": {
                    "sccAuth": {
                        "description": "Authentication token.",
                        "examples": [
                            "54BKPtTL-eSMFp5cqYTMMSblm2U80cUJqQgmbe4f_sRn4ammMmU1NKNurn9HqpsUtS4FrMJRTKa3Or_pFbedM_57R0fVBfNJ-m2Pvey9OweWIDradzT0dB1WnufPTJiT2y7zSQy91Y9wJIn1_aY5q-MNh75qwjM84Dng-mYzbd9KqUfyPUolOo-j-... (Truncated)"
                        ],
                        "type": "string"
                    },
                    "xsrf": {
                        "description": "Cross Site Request Forgery Prevention Token.",
                        "examples": [
                            "PEDwTvWdm2qSTe-n8h-1praK4OcQK1ELTJ08DWYqBRzQiyA2MIuEKEMNLu4ExjDNpAOUnAxmsqOeuGzb82MJYkegOE6hW8BzpSM6k9nbTbJ4yjNGzMSQvWUnyqrBvGa8JfSRiSeaKdXGBnxGd90Spw2:... (truncated)"
                        ],
                        "type": "string"
                    }
                },
                "required": [
                    "sccAuth",
                    "xsrf"
                ],
                "type": "object",
                "examples": [
                    {
                        "sccAuth": "54BKPtTL-eSMFp5cqYTMMSblm2U80cUJqQgmbe4f_sRn4ammMmU1NKNurn9HqpsUtS4FrMJRTKa3Or_pFbedM_57R0fVBfNJ-m2Pvey9OweWIDradzT0dB1WnufPTJiT2y7zSQy91Y9wJIn1_aY5q-MNh75qwjM84Dng-mYzbd9KqUfyPUolOo-j-... (Truncated)",
                        "xsrf": "PEDwTvWdm2qSTe-n8h-1praK4OcQK1ELTJ08DWYqBRzQiyA2MIuEKEMNLu4ExjDNpAOUnAxmsqOeuGzb82MJYkegOE6hW8BzpSM6k9nbTbJ4yjNGzMSQvWUnyqrBvGa8JfSRiSeaKdXGBnxGd90Spw2:... (truncated)"
                    }
                ]
            },
            "Deploy.ConfigurationTag": {
                "title": "Deploy - Configuration Tag",
                "description": "Definition of an object representing configuration tag used within architecture collections.",
                "type": "object",
                "properties": {
                    "advanced": {
                        "type": "boolean",
                        "description": "Flag indicating if additional challenges should be required before user can use this configuration item.",
                        "examples": [
                            false
                        ]
                    },
                    "description": {
                        "type": "string",
                        "description": "Long form explanation what the tag is and/or does.",
                        "examples": [
                            "This tag indicates specific collection and very important."
                        ]
                    },
                    "displayName": {
                        "type": "string",
                        "description": "Human friendly name of the config tag.",
                        "examples": [
                            "Important Collection"
                        ]
                    },
                    "dependentTag": {
                        "type": "array",
                        "description": "List of configuration tags that are required to be selected if this one were to be selected. This property is primarily used for illustration to the end user or system.",
                        "minItems": 0,
                        "items": {
                            "$ref": "#/components/schemas/Deploy.ConfigurationTag"
                        },
                        "examples": [
                            [
                                {
                                    "advanced": false,
                                    "description": "This tag indicates specific collection and very important.",
                                    "displayName": "Important Collection",
                                    "dependentTag": [],
                                    "id": "2c7e1a3b-5d4f-4a8b-9e6a-1c2b7f3d8e4a"
                                }
                            ]
                        ]
                    },
                    "id": {
                        "type": "string",
                        "description": "Object ID of the config tag entity.",
                        "format": "uuid",
                        "maxLength": 36,
                        "minLength": 36,
                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                        "examples": [
                            "8b3e2a1c-7d4f-4a8b-9e6a-2c1b7f3d8e4a"
                        ]
                    }
                },
                "required": [
                    "advanced",
                    "description",
                    "displayName",
                    "dependentTag",
                    "id"
                ],
                "examples": [
                    {
                        "advanced": true,
                        "description": "This tag indicates optional collection and can be skipped.",
                        "displayName": "Optional Collection",
                        "dependentTag": [],
                        "id": "4d1c7e2b-3a5f-4a8b-9e6a-7f2b3d1c9e45"
                    }
                ]
            },
            "Deploy.ArchitectureData": {
                "title": "Deploy - Architecture Data Record",
                "description": "Collection of objects describing existing architectures available for selection.",
                "type": "array",
                "items": {
                    "description": "List of architecture tag objects with metadata to help UI present the information to the user.",
                    "type": "object",
                    "properties": {
                        "advanced": {
                            "type": "boolean",
                            "description": "Flag indicating if additional challenges should be required before user can select this architecture item.",
                            "examples": [
                                false
                            ]
                        },
                        "configTagList": {
                            "type": "array",
                            "description": "List of configuration tags that are a part of this architecture.",
                            "minItems": 0,
                            "items": {
                                "$ref": "#/components/schemas/Deploy.ConfigurationTag"
                            },
                            "examples": [
                                [
                                    {
                                        "advanced": false,
                                        "description": "Default configuration that is applicable in most cases",
                                        "displayName": "General Configuration",
                                        "dependentTag": [],
                                        "id": "7e4a2c9f-1b3d-4f6a-8e9c-2d5f3a7b6c1e"
                                    }
                                ]
                            ]
                        },
                        "description": {
                            "type": "string",
                            "description": "Long form explanation what the architecture is and/or does.",
                            "examples": [
                                "Default architecture that is applicable in most cases"
                            ]
                        },
                        "displayName": {
                            "type": "string",
                            "description": "Human friendly name of the architecture tag.",
                            "examples": [
                                "General Architecture"
                            ]
                        },
                        "id": {
                            "type": "string",
                            "description": "Object ID of the architecture tag entity.",
                            "format": "uuid",
                            "maxLength": 36,
                            "minLength": 36,
                            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                            "examples": [
                                "2f6a1c9e-7b3d-4e8f-9a2c-5d1e3b7f4c6a"
                            ]
                        }
                    },
                    "required": [
                        "advanced",
                        "configTagList",
                        "description",
                        "displayName",
                        "id"
                    ],
                    "examples": [
                        {
                            "advanced": false,
                            "configTagList": [
                                {
                                    "advanced": false,
                                    "description": "Default configuration that is applicable in most cases",
                                    "displayName": "General Configuration",
                                    "dependentTag": [],
                                    "id": "7e4a2c9f-1b3d-4f6a-8e9c-2d5f3a7b6c1e"
                                }
                            ],
                            "description": "Default architecture that is applicable in most cases",
                            "displayName": "General Architecture",
                            "id": "2f6a1c9e-7b3d-4e8f-9a2c-5d1e3b7f4c6a"
                        }
                    ]
                },
                "examples": [
                    [
                        {
                            "advanced": false,
                            "configTagList": [
                                {
                                    "advanced": false,
                                    "description": "Default configuration that is applicable in most cases",
                                    "displayName": "General Configuration",
                                    "dependentTag": [],
                                    "id": "7e4a2c9f-1b3d-4f6a-8e9c-2d5f3a7b6c1e"
                                }
                            ],
                            "description": "Default architecture that is applicable in most cases",
                            "displayName": "General Architecture",
                            "id": "2f6a1c9e-7b3d-4e8f-9a2c-5d1e3b7f4c6a"
                        },
                        {
                            "advanced": true,
                            "configTagList": [
                                {
                                    "advanced": false,
                                    "description": "Custom configuration to provision group container",
                                    "displayName": "Custom Group",
                                    "dependentTag": [],
                                    "id": "3a9f2e1c-6b4d-4c7a-9f8e-1d2b5e3a7c6f"
                                },
                                {
                                    "advanced": true,
                                    "description": "Custom configuration to create access policy",
                                    "displayName": "Custom Policy",
                                    "dependentTag": [
                                        {
                                            "advanced": true,
                                            "description": "Custom configuration to enable location control",
                                            "displayName": "Location Control",
                                            "dependentTag": [],
                                            "id": "1b7e3c9a-4f2d-4a6e-9f8c-2d5a1b3f6c7e"
                                        }
                                    ],
                                    "id": "6c3e1a9f-2b7d-4f8a-9e5c-1d4a3b7e6f2c"
                                }
                            ],
                            "description": "Custom architecture for discover process only",
                            "displayName": "Discover-only Architecture",
                            "id": "8c1f3a7e-2d4b-4f6a-9e5c-3b7d2a1f6c9e"
                        }
                    ]
                ]
            },
            "Deploy.CompareResponse": {
                "title": "Deploy - Compare Response Record",
                "description": "Object with the details of the evaluation of the deployed infrastructure resources.",
                "type": "object",
                "properties": {
                    "invalid": {
                        "type": "array",
                        "description": "Collection of the configuration items where request for resource data responded with an error.",
                        "items": {
                            "type": "object",
                            "properties": {
                                "templateId": {
                                    "type": "string",
                                    "description": "Internal reference identifier of the resource.",
                                    "format": "uuid",
                                    "maxLength": 36,
                                    "minLength": 36,
                                    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                    "examples": [
                                        "a14402b8-98c5-41e3-ba99-e5e1a536f68d"
                                    ]
                                },
                                "message": {
                                    "type": "string",
                                    "description": "Text with the details of the error response.",
                                    "examples": [
                                        "Setting ID '58246273-d366-40d5-ac3d-daacb8bc2655' - Item not found."
                                    ]
                                }
                            },
                            "required": [
                                "templateId",
                                "message"
                            ],
                            "examples": [
                                {
                                    "templateId": "a14402b8-98c5-41e3-ba99-e5e1a536f68d",
                                    "message": "Setting ID '58246273-d366-40d5-ac3d-daacb8bc2655' - Item not found."
                                }
                            ]
                        },
                        "examples": [
                            [
                                {
                                    "templateId": "a14402b8-98c5-41e3-ba99-e5e1a536f68d",
                                    "message": "Setting ID '58246273-d366-40d5-ac3d-daacb8bc2655' - Item not found."
                                },
                                {
                                    "templateId": "9af9209d-d191-4b42-9f65-dfd8b7882bba",
                                    "message": "Setting ID 'f6f5d07b-230c-4818-93de-e407b8ca9537' - Insufficient access to view this data."
                                }
                            ]
                        ]
                    },
                    "lastRunTimestamp": {
                        "description": "Point in time expressed in ISO 8601 format when the evaluation results were generated. ",
                        "examples": [
                            "2025-03-25T14:28:54Z"
                        ],
                        "type": [
                            "string",
                            "null"
                        ],
                        "format": "date-time"
                    },
                    "missing": {
                        "type": "array",
                        "description": "Collection of the configuration items that are expected to be deployed but do not have resource reference id.",
                        "items": {
                            "type": "object",
                            "properties": {
                                "templateId": {
                                    "type": "string",
                                    "description": "Internal reference identifier of the resource.",
                                    "format": "uuid",
                                    "maxLength": 36,
                                    "minLength": 36,
                                    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                    "examples": [
                                        "78afd77c-c2a6-4328-9c61-b9fd44114823"
                                    ]
                                },
                                "message": {
                                    "type": "string",
                                    "description": "Text containing details of the original configuration item definition.",
                                    "examples": [
                                        "{\"displayName\":\"Privileged Objects\",\"description\":\"Privileged objects managed by application.\",\"membershipType\":\"Assigned\"}"
                                    ]
                                }
                            },
                            "required": [
                                "templateId",
                                "message"
                            ],
                            "examples": [
                                {
                                    "templateId": "78afd77c-c2a6-4328-9c61-b9fd44114823",
                                    "message": "{\"displayName\":\"Privileged Objects\",\"description\":\"Privileged objects managed by application.\",\"membershipType\":\"Assigned\"}"
                                }
                            ]
                        },
                        "examples": [
                            [
                                {
                                    "templateId": "78afd77c-c2a6-4328-9c61-b9fd44114823",
                                    "message": "{\"displayName\":\"Privileged Objects\",\"description\":\"Privileged objects managed by application.\",\"membershipType\":\"Assigned\"}"
                                }
                            ]
                        ]
                    },
                    "results": {
                        "type": "array",
                        "description": "Collection of the configuration items where discrepancies were found.",
                        "items": {
                            "type": "object",
                            "properties": {
                                "templateId": {
                                    "type": "string",
                                    "description": "Internal reference identifier of the resource.",
                                    "format": "uuid",
                                    "maxLength": 36,
                                    "minLength": 36,
                                    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                    "examples": [
                                        "c47c20bd-46fa-4dfe-b971-3e5b1ce34a86"
                                    ]
                                },
                                "variants": {
                                    "type": "array",
                                    "description": "List of individual parts of the resource where discrepancies were determined.",
                                    "items": {
                                        "type": "object",
                                        "properties": {
                                            "actions": {
                                                "items": {
                                                    "type": "number",
                                                    "examples": [
                                                        2
                                                    ]
                                                },
                                                "description": "List of operations available to be performed on the entity.",
                                                "type": "array",
                                                "minItems": 1,
                                                "examples": [
                                                    [
                                                        2,
                                                        3
                                                    ]
                                                ]
                                            },
                                            "errorCode": {
                                                "description": "Detailed information about the discrepancy for the entity.",
                                                "type": "number",
                                                "examples": [
                                                    5
                                                ]
                                            },
                                            "path": {
                                                "description": "Location in the object where evaluated property encountered an error.",
                                                "type": "string",
                                                "examples": [
                                                    "/displayName"
                                                ]
                                            }
                                        },
                                        "required": [
                                            "actions",
                                            "errorCode",
                                            "path"
                                        ],
                                        "examples": [
                                            {
                                                "actions": [
                                                    2,
                                                    3
                                                ],
                                                "errorCode": 5,
                                                "path": "/displayName"
                                            }
                                        ]
                                    },
                                    "examples": [
                                        [
                                            {
                                                "actions": [
                                                    2,
                                                    3
                                                ],
                                                "errorCode": 5,
                                                "path": "/displayName"
                                            }
                                        ]
                                    ]
                                }
                            },
                            "required": [
                                "templateId",
                                "variants"
                            ],
                            "examples": [
                                {
                                    "templateId": "c47c20bd-46fa-4dfe-b971-3e5b1ce34a86",
                                    "variants": [
                                        {
                                            "actions": [
                                                2,
                                                3
                                            ],
                                            "errorCode": 5,
                                            "path": "/displayName"
                                        }
                                    ]
                                },
                                {
                                    "templateId": "4b26b6f6-9cb3-4384-bd1e-6d298455c2c4",
                                    "variants": [
                                        {
                                            "actions": [
                                                3
                                            ],
                                            "errorCode": 3,
                                            "path": "/roleScopeTagIds/1"
                                        }
                                    ]
                                }
                            ]
                        },
                        "examples": [
                            [
                                {
                                    "templateId": "c47c20bd-46fa-4dfe-b971-3e5b1ce34a86",
                                    "variants": [
                                        {
                                            "actions": [
                                                2,
                                                3
                                            ],
                                            "errorCode": 5,
                                            "path": "/displayName"
                                        },
                                        {
                                            "actions": [
                                                2
                                            ],
                                            "errorCode": 1,
                                            "path": "/groupPolicyUploadedLanguageFiles"
                                        }
                                    ]
                                },
                                {
                                    "templateId": "4b26b6f6-9cb3-4384-bd1e-6d298455c2c4",
                                    "variants": [
                                        {
                                            "actions": [
                                                3
                                            ],
                                            "errorCode": 3,
                                            "path": "/roleScopeTagIds/1"
                                        }
                                    ]
                                }
                            ]
                        ]
                    }
                },
                "required": [
                    "invalid",
                    "lastRunTimestamp",
                    "missing",
                    "results"
                ],
                "examples": [
                    {
                        "invalid": [
                            {
                                "templateId": "a14402b8-98c5-41e3-ba99-e5e1a536f68d",
                                "message": "Setting ID '58246273-d366-40d5-ac3d-daacb8bc2655' - Item not found."
                            },
                            {
                                "templateId": "9af9209d-d191-4b42-9f65-dfd8b7882bba",
                                "message": "Setting ID 'f6f5d07b-230c-4818-93de-e407b8ca9537' - Insufficient access to view this data."
                            }
                        ],
                        "lastRunTimestamp": "2025-03-25T14:28:54Z",
                        "missing": [
                            {
                                "templateId": "78afd77c-c2a6-4328-9c61-b9fd44114823",
                                "message": "{\"displayName\":\"Privileged Objects\",\"description\":\"Privileged objects managed by application.\",\"membershipType\":\"Assigned\"}"
                            }
                        ],
                        "results": [
                            {
                                "templateId": "c47c20bd-46fa-4dfe-b971-3e5b1ce34a86",
                                "variants": [
                                    {
                                        "actions": [
                                            2,
                                            3
                                        ],
                                        "errorCode": 5,
                                        "path": "/displayName"
                                    },
                                    {
                                        "actions": [
                                            2
                                        ],
                                        "errorCode": 1,
                                        "path": "/groupPolicyUploadedLanguageFiles"
                                    }
                                ]
                            },
                            {
                                "templateId": "4b26b6f6-9cb3-4384-bd1e-6d298455c2c4",
                                "variants": [
                                    {
                                        "actions": [
                                            3
                                        ],
                                        "errorCode": 3,
                                        "path": "/roleScopeTagIds/1"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            },
            "Deploy.RemediationResponse": {
                "title": "Deploy - Remediation Response Record",
                "description": "Object with the details of the performed remediation action.",
                "type": "object",
                "properties": {
                    "errors": {
                        "type": "array",
                        "description": "Collection of the configuration items that failed to provision and available details on the error.",
                        "items": {
                            "type": "object",
                            "properties": {
                                "templateId": {
                                    "type": "string",
                                    "description": "Internal reference identifier of the resource.",
                                    "format": "uuid",
                                    "maxLength": 36,
                                    "minLength": 36,
                                    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                    "examples": [
                                        "7e2b1c3d-4f5a-4a8b-9e6a-1c2b7f3d8e4a"
                                    ]
                                },
                                "message": {
                                    "type": "string",
                                    "description": "Text with the details of the error response.",
                                    "examples": [
                                        "Failed to create dedicated group for the resource: Unexpected error."
                                    ]
                                }
                            },
                            "required": [
                                "templateId",
                                "message"
                            ],
                            "examples": [
                                {
                                    "templateId": "7e2b1c3d-4f5a-4a8b-9e6a-1c2b7f3d8e4a",
                                    "message": "Failed to create dedicated group for the resource: Unexpected error."
                                }
                            ]
                        },
                        "examples": [
                            [
                                {
                                    "templateId": "7e2b1c3d-4f5a-4a8b-9e6a-1c2b7f3d8e4a",
                                    "message": "Failed to create dedicated group for the resource: Unexpected error."
                                },
                                {
                                    "templateId": "2a1c7e3b-5d4f-4a8b-9e6a-7f3d2b1c8e4a",
                                    "message": "Failed to create the resource: invalid value for 'id' reference."
                                }
                            ]
                        ]
                    },
                    "results": {
                        "type": "object",
                        "description": "Records in the form of key/value where key is templateId of the configuration item and value is the name of the provisioned resource.",
                        "additionalProperties": {
                            "type": "string",
                            "examples": [
                                "CSPM - MDCA"
                            ]
                        },
                        "examples": [
                            {
                                "4a8b7e1a-2b3c-4d5f-9e6a-1c2b7f3d8e4a": "CSPM - MDCA",
                                "b3e2c1d4-7f5a-4a8b-9e6a-2c1b7f3d8e4a": "CSPM - Authentication Methods"
                            }
                        ]
                    }
                },
                "required": [
                    "errors",
                    "results"
                ],
                "examples": [
                    {
                        "errors": [
                            {
                                "templateId": "7e2b1c3d-4f5a-4a8b-9e6a-1c2b7f3d8e4a",
                                "message": "Failed to create dedicated group for the resource: Unexpected error."
                            },
                            {
                                "templateId": "2a1c7e3b-5d4f-4a8b-9e6a-7f3d2b1c8e4a",
                                "message": "Failed to create the resource: invalid value for 'id' reference."
                            }
                        ],
                        "results": {
                            "4a8b7e1a-2b3c-4d5f-9e6a-1c2b7f3d8e4a": "CSPM - MDCA",
                            "b3e2c1d4-7f5a-4a8b-9e6a-2c1b7f3d8e4a": "CSPM - Authentication Methods"
                        }
                    }
                ]
            },
            "Deploy.ConfigurationItem": {
                "title": "Deploy - Configuration Item List",
                "description": "Collection of objects representing the configuration items with curated properties and values in user-friendly format.",
                "type": "array",
                "items": {
                    "description": "Single configuration item with curated properties and values in a user-friendly format.",
                    "type": "object",
                    "properties": {
                        "childDependencies": {
                            "type": "array",
                            "description": "List of Object IDs in UUID format that reference configuration items identified as entities dependent on the presence of the current item.",
                            "minItems": 0,
                            "items": {
                                "type": "string",
                                "format": "uuid",
                                "maxLength": 36,
                                "minLength": 36,
                                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                "examples": [
                                    "7e1a2b3c-4d5f-4a8b-9e6a-1c2b7f3d8e4a"
                                ]
                            },
                            "examples": [
                                [
                                    "7e1a2b3c-4d5f-4a8b-9e6a-1c2b7f3d8e4a",
                                    "9c2e7a1b-5d3f-4a8b-2c6e-7f1a3d9e8b5c"
                                ]
                            ]
                        },
                        "deployState": {
                            "type": "string",
                            "description": "Indicator of the infrastructure configuration item's current state. Mutated means that the item has been modified by the end user outside of SHIELD.",
                            "enum": [
                                "notDeployed",
                                "deployed",
                                "Mutated",
                                "error"
                            ],
                            "examples": [
                                "deployed"
                            ]
                        },
                        "groupTagList": {
                            "type": "array",
                            "description": "List of metadata tags that indicate which deployment sets the configuration item is compatible with.",
                            "minItems": 1,
                            "items": {
                                "type": "object",
                                "properties": {
                                    "description": {
                                        "type": "string",
                                        "description": "Long form explanation what the tag is and/or does.",
                                        "examples": [
                                            "Collection of policies covering critical conditional access settings."
                                        ]
                                    },
                                    "displayName": {
                                        "type": "string",
                                        "description": "Human friendly name of the tag.",
                                        "examples": [
                                            "Conditional Policy"
                                        ]
                                    },
                                    "tagId": {
                                        "type": "string",
                                        "description": "Object ID in the UUID format of the tag entity.",
                                        "format": "uuid",
                                        "maxLength": 36,
                                        "minLength": 36,
                                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                        "examples": [
                                            "3b7e2a1c-4d5f-4a8b-9e6a-2c1b7f3d8e4a"
                                        ]
                                    }
                                },
                                "required": [
                                    "description",
                                    "displayName",
                                    "tagId"
                                ],
                                "examples": [
                                    {
                                        "description": "Collection of policies covering critical conditional access settings.",
                                        "displayName": "Conditional Policy",
                                        "tagId": "3b7e2a1c-4d5f-4a8b-9e6a-2c1b7f3d8e4a"
                                    }
                                ]
                            },
                            "examples": [
                                [
                                    {
                                        "description": "Collection of policies covering critical conditional access settings.",
                                        "displayName": "Conditional Policy",
                                        "tagId": "3b7e2a1c-4d5f-4a8b-9e6a-2c1b7f3d8e4a"
                                    }
                                ]
                            ]
                        },
                        "msCloudTypes": {
                            "type": "array",
                            "description": "List of Microsoft Sovereign Clouds the configuration items is compatible with.",
                            "minItems": 1,
                            "items": {
                                "type": "string",
                                "examples": [
                                    "USGov"
                                ]
                            },
                            "examples": [
                                [
                                    "Public"
                                ]
                            ]
                        },
                        "parentDependencies": {
                            "type": "array",
                            "description": "List of Object IDs in UUID format that reference configuration items identified as entities which deploy and existence is required for the current item.",
                            "minItems": 0,
                            "items": {
                                "type": "string",
                                "format": "uuid",
                                "maxLength": 36,
                                "minLength": 36,
                                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                "examples": [
                                    "8e6a1c2b-7f3d-4a8b-9c2e-5d3f7a1b2e4a"
                                ]
                            },
                            "examples": [
                                [
                                    "8e6a1c2b-7f3d-4a8b-9c2e-5d3f7a1b2e4a"
                                ]
                            ]
                        },
                        "templateId": {
                            "type": "string",
                            "description": "Internal Object ID in UUID format to uniquely identify this configuration item definition.",
                            "format": "uuid",
                            "maxLength": 36,
                            "minLength": 36,
                            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                            "examples": [
                                "2a1c7e3b-5d4f-4a8b-9e6a-7f3d2b1c8e4a"
                            ]
                        },
                        "urlPath": {
                            "type": "string",
                            "description": "Relative Graph Api path identifying where the resource to be located and managed.",
                            "examples": [
                                "/identity/conditionalAccess/policies"
                            ]
                        }
                    },
                    "required": [
                        "childDependencies",
                        "deployState",
                        "groupTagList",
                        "msCloudTypes",
                        "parentDependencies",
                        "templateId",
                        "urlPath"
                    ],
                    "examples": [
                        {
                            "childDependencies": [
                                "7e1a2b3c-4d5f-4a8b-9e6a-1c2b7f3d8e4a",
                                "9c2e7a1b-5d3f-4a8b-2c6e-7f1a3d9e8b5c"
                            ],
                            "deployState": "deployed",
                            "groupTagList": [
                                {
                                    "description": "Collection of policies covering critical conditional access settings.",
                                    "displayName": "Conditional Policy",
                                    "tagId": "3b7e2a1c-4d5f-4a8b-9e6a-2c1b7f3d8e4a"
                                }
                            ],
                            "msCloudTypes": [
                                "Public"
                            ],
                            "parentDependencies": [
                                "8e6a1c2b-7f3d-4a8b-9c2e-5d3f7a1b2e4a"
                            ],
                            "templateId": "2a1c7e3b-5d4f-4a8b-9e6a-7f3d2b1c8e4a",
                            "urlPath": "/identity/conditionalAccess/policies"
                        }
                    ]
                },
                "examples": [
                    [
                        {
                            "childDependencies": [
                                "7e1a2b3c-4d5f-4a8b-9e6a-1c2b7f3d8e4a",
                                "9c2e7a1b-5d3f-4a8b-2c6e-7f1a3d9e8b5c"
                            ],
                            "deployState": "deployed",
                            "groupTagList": [
                                {
                                    "description": "Collection of policies covering critical conditional access settings.",
                                    "displayName": "Conditional Policy",
                                    "tagId": "3b7e2a1c-4d5f-4a8b-9e6a-2c1b7f3d8e4a"
                                }
                            ],
                            "msCloudTypes": [
                                "Public"
                            ],
                            "parentDependencies": [
                                "8e6a1c2b-7f3d-4a8b-9c2e-5d3f7a1b2e4a"
                            ],
                            "templateId": "2a1c7e3b-5d4f-4a8b-9e6a-7f3d2b1c8e4a",
                            "urlPath": "/identity/conditionalAccess/policies"
                        },
                        {
                            "childDependencies": [
                                "1c2b5d3f-7a1b-4a8b-9e6a-2e4a3b7e8c5d"
                            ],
                            "deployState": "notDeployed",
                            "groupTagList": [
                                {
                                    "description": "Principal containers that are used to provide assignments.",
                                    "displayName": "Administrative Unit",
                                    "tagId": "5d3f9c2e-7a1b-4a8b-2c6e-1a3d7e8b5c4a"
                                }
                            ],
                            "msCloudTypes": [
                                "Public"
                            ],
                            "parentDependencies": [],
                            "templateId": "4a8b7e1a-2b3c-4d5f-9e6a-1c2b7f3d8e4a",
                            "urlPath": "/directory/administrativeUnits"
                        }
                    ]
                ]
            },
            "Deploy.ConfigurationItemMetaData": {
                "title": "Deploy - Configuration Item Meta Data",
                "description": "Object representing populated information expanding details of the Configuration Item with user friendly information.",
                "type": "object",
                "properties": {
                    "title": {
                        "type": "string",
                        "description": "Human readable short title.",
                        "examples": [
                            "Multi-Factor Authentication (MFA)"
                        ]
                    },
                    "description": {
                        "type": "string",
                        "description": "Lengthier definition for the resource that provides more insight into what is covered or intended.",
                        "examples": [
                            "This policy enforces multi-factor authentication (MFA) for enterprise identities during sign-in to reduce the risk of identity compromise."
                        ]
                    },
                    "licenseRequirement": {
                        "type": "string",
                        "description": "Definition of license requirements to use this resource.",
                        "examples": [
                            "Microsoft Entra ID P1"
                        ]
                    },
                    "priority": {
                        "type": "integer",
                        "description": "Indicator of the priority of the resource implementation. Lower number indicates higher priority.",
                        "enum": [
                            1,
                            50,
                            100
                        ],
                        "examples": [
                            1
                        ]
                    },
                    "operationalRisk": {
                        "type": "integer",
                        "description": "Indicator of the level of possible disruptions if this resource is not implemented. Lower number indicates higher risk.",
                        "enum": [
                            1,
                            50,
                            100
                        ],
                        "examples": [
                            50
                        ]
                    },
                    "importanceReasonList": {
                        "type": "array",
                        "description": "Reasons explaining importance of the implementation of this resource.",
                        "items": {
                            "type": "string",
                            "examples": [
                                "MFA adds a layer of protection to the sign-in process."
                            ]
                        },
                        "examples": [
                            [
                                "MFA adds a layer of protection to the sign-in process.",
                                "When accessing accounts or apps, users provide additional identity verification, such as scanning a fingerprint or entering a code."
                            ]
                        ]
                    },
                    "deploymentBenefitList": {
                        "type": "array",
                        "description": "Benefits gained by implementing the resource.",
                        "items": {
                            "type": "string",
                            "examples": [
                                "Reduces the risk of compromised user credentials."
                            ]
                        },
                        "examples": [
                            [
                                "Reduces the risk of compromised user credentials.",
                                "Prevents brute-force attack."
                            ]
                        ]
                    },
                    "nonDeploymentRiskList": {
                        "type": "array",
                        "description": "Possible risks that could lead to issues if this resource is not implemented.",
                        "items": {
                            "type": "string",
                            "examples": [
                                "Dramatically increased risk of account compromise."
                            ]
                        },
                        "examples": [
                            [
                                "Dramatically increased risk of account compromise.",
                                "Higher chance of account compromise through phishing attacks."
                            ]
                        ]
                    },
                    "guideStepList": {
                        "type": "array",
                        "description": "Collection of steps customer should consider or follow for successful implementation of the resource.",
                        "items": {
                            "type": "string",
                            "examples": [
                                "Communicate the restriction to EntraID-joined devices and provide transition guidance."
                            ]
                        },
                        "examples": [
                            [
                                "Communicate the restriction to EntraID-joined devices and provide transition guidance.",
                                "Stage the rollout with a pilot group and exclude critical accounts."
                            ]
                        ]
                    },
                    "compliancePositionList": {
                        "type": "array",
                        "description": "Statements describing what this resource might help with in the realm of compliance and security.",
                        "items": {
                            "type": "string",
                            "examples": [
                                "Deploying MFA helps meet compliance requirements for various industry regulations and standards."
                            ]
                        },
                        "examples": [
                            [
                                "Deploying MFA helps meet compliance requirements for various industry regulations and standards."
                            ]
                        ]
                    },
                    "compliancePositionStandardList": {
                        "type": "array",
                        "description": "Collection of frameworks that this resource addresses when implemented.",
                        "items": {
                            "type": "string",
                            "examples": [
                                "ISO 27001"
                            ]
                        },
                        "examples": [
                            [
                                "ISO 27001",
                                "NIST"
                            ]
                        ]
                    },
                    "disclaimerList": {
                        "type": "array",
                        "description": "Collection of disclaimer statements.",
                        "items": {
                            "type": "string",
                            "examples": [
                                "Please be aware that deploying this policy will enforce MFA for all users on their next sign-in."
                            ]
                        },
                        "examples": [
                            [
                                "Please be aware that deploying this policy will enforce MFA for all users on their next sign-in."
                            ]
                        ]
                    },
                    "baseLink": {
                        "type": "string",
                        "description": "Web URL to the Microsoft or Azure service where resource can be found.",
                        "format": "uri",
                        "examples": [
                            "https://entra.microsoft.com"
                        ]
                    },
                    "learnLinkList": {
                        "type": "array",
                        "description": "Collection of educational URLs for user to explore.",
                        "items": {
                            "type": "string",
                            "format": "uri",
                            "examples": [
                                "https://learn.microsoft.com/en-us/azure/active-directory/authentication/concept-mfa-howitworks"
                            ]
                        },
                        "examples": [
                            [
                                "https://learn.microsoft.com/en-us/azure/active-directory/authentication/concept-mfa-howitworks",
                                "https://learn.microsoft.com/en-us/azure/active-directory/authentication/tutorial-enable-azure-mfa"
                            ]
                        ]
                    },
                    "manualCreateGuideList": {
                        "type": "array",
                        "description": "Collection of strings that make up a manual implementation guide for the associated configuration item.",
                        "minItems": 0,
                        "items": {
                            "type": "string",
                            "examples": [
                                "• First level",
                                "  • Second level",
                                "    • Third level",
                                "[Go to this link](https://google.com/)"
                            ]
                        },
                        "examples": [
                            [
                                "• Name: \"PSM - Token Binding\"",
                                "• Users",
                                "  • What does this policy apply to: Users and groups",
                                "  • Include",
                                "  • Select: Select users and groups",
                                "  • Select: Users and groups",
                                "  • Select: Users and groups to include",
                                "• Exclude",
                                "  • Select: Select users and groups",
                                "  • Select: Users and groups",
                                "    • Select: Windows",
                                "[Go to this link](https://google.com/)"
                            ]
                        ]
                    }
                },
                "required": [
                    "title",
                    "description",
                    "priority",
                    "operationalRisk",
                    "importanceReasonList",
                    "deploymentBenefitList",
                    "nonDeploymentRiskList",
                    "guideStepList",
                    "compliancePositionList",
                    "compliancePositionStandardList",
                    "disclaimerList",
                    "baseLink",
                    "manualCreateGuideList"
                ],
                "examples": [
                    {
                        "title": "Multi-Factor Authentication (MFA)",
                        "description": "This policy enforces multi-factor authentication (MFA) for enterprise identities during sign-in to reduce the risk of identity compromise.",
                        "licenseRequirement": "Microsoft Entra ID P1",
                        "priority": 1,
                        "operationalRisk": 50,
                        "importanceReasonList": [
                            "MFA adds a layer of protection to the sign-in process."
                        ],
                        "deploymentBenefitList": [
                            "Reduces the risk of compromised user credentials.",
                            "Prevents brute-force attack."
                        ],
                        "nonDeploymentRiskList": [
                            "Dramatically increased risk of account compromise.",
                            "Higher chance of account compromise through phishing attacks."
                        ],
                        "guideStepList": [
                            "Communicate the restriction to EntraID-joined devices and provide transition guidance.",
                            "Stage the rollout with a pilot group and exclude critical accounts."
                        ],
                        "compliancePositionList": [
                            "Deploying MFA helps meet compliance requirements for various industry regulations and standards."
                        ],
                        "compliancePositionStandardList": [
                            "ISO 27001",
                            "NIST"
                        ],
                        "disclaimerList": [
                            "Please be aware that deploying this policy will enforce MFA for all users on their next sign-in."
                        ],
                        "baseLink": "https://entra.microsoft.com",
                        "learnLinkList": [
                            "https://learn.microsoft.com/en-us/azure/active-directory/authentication/concept-mfa-howitworks",
                            "https://learn.microsoft.com/en-us/azure/active-directory/authentication/tutorial-enable-azure-mfa"
                        ],
                        "manualCreateGuideList": [
                            "• Name: \"PSM - Token Binding\"",
                            "• Users",
                            "  • What does this policy apply to: Users and groups",
                            "  • Include",
                            "  • Select: Select users and groups",
                            "  • Select: Users and groups",
                            "  • Select: Users and groups to include",
                            "• Exclude",
                            "  • Select: Select users and groups",
                            "  • Select: Users and groups",
                            "    • Select: Windows",
                            "[Go to this link](https://google.com/)"
                        ]
                    }
                ]
            },
            "Deploy.PathIndicator": {
                "title": "Deploy - Path Payload",
                "description": "Payload with path data used in several endpoints",
                "type": "object",
                "properties": {
                    "path": {
                        "description": "Location of the target in the object structure of the configuration item flattened for predictable navigation.",
                        "type": "string",
                        "examples": [
                            "/roleScopeTagIds"
                        ]
                    }
                },
                "required": [
                    "path"
                ],
                "examples": [
                    {
                        "path": "/roleScopeTagIds"
                    }
                ]
            },
            "Discover.ExecutionStatus": {
                "title": "Discover - Status",
                "description": "Detailed status that indicates the current state of the Discover engine and its progress.",
                "type": "object",
                "properties": {
                    "running": {
                        "description": "Flag that indicates if another run is already in progress or not.",
                        "type": "boolean",
                        "examples": [
                            true
                        ]
                    }
                },
                "required": [
                    "running"
                ],
                "examples": [
                    {
                        "running": true
                    }
                ]
            },
            "Discover.ArchitectureReport.CspmPolicyAssessment": {
                "title": "Discover - Architecture Report - Cspm Policy Assessment Result",
                "description": "Policy Assessment Result containing coverage calculations for the architecture report",
                "type": "object",
                "properties": {
                    "policyList": {
                        "type": "object",
                        "additionalProperties": {
                            "$ref": "#/components/schemas/Discover.ArchitectureReport.CspmPolicyAssessment.PolicyRecord"
                        },
                        "description": "The mapping between ConfigurationItem templateIds and their corresponding policy record"
                    },
                    "reportCreatedDate": {
                        "type": "string",
                        "format": "date-time",
                        "description": "The date the architecture report was created.",
                        "examples": [
                            "2025-11-25T11:00:00Z"
                        ]
                    },
                    "reportUpdatedDate": {
                        "type": "string",
                        "format": "date-time",
                        "description": "The date the architecture report was last updated.",
                        "examples": [
                            "2025-11-25T11:00:00Z"
                        ]
                    }
                },
                "required": [
                    "policyList"
                ],
                "examples": [
                    {
                        "policyList": {
                            "e7b8c2a2-2e4a-4b6a-9c3d-8f1e2a7b6c4d": {
                                "categoryList": [
                                    "Access Control",
                                    "Compliance"
                                ],
                                "coverageMetricsNormalized": {
                                    "covered": 80,
                                    "noCover": 0,
                                    "partial": 20
                                },
                                "coverageMetricsRaw": {
                                    "covered": 8,
                                    "noCover": 0,
                                    "partial": 2
                                },
                                "coverageStatus": "full",
                                "name": "Sample Policy 1"
                            },
                            "2a1e3c4d-5b6f-4e7a-8c9d-0f1b2a3c4d5e": {
                                "categoryList": [
                                    "Data Protection"
                                ],
                                "coverageMetricsNormalized": {
                                    "covered": 50,
                                    "noCover": 20,
                                    "partial": 30
                                },
                                "coverageMetricsRaw": {
                                    "covered": 5,
                                    "noCover": 2,
                                    "partial": 3
                                },
                                "coverageStatus": "partial",
                                "name": "Sample Policy 2"
                            },
                            "9f8e7d6c-5b4a-3c2e-1d0f-8a7b6c5d4e3f": {
                                "categoryList": [
                                    "Network Security"
                                ],
                                "coverageMetricsNormalized": {
                                    "covered": 0,
                                    "noCover": 100,
                                    "partial": 0
                                },
                                "coverageMetricsRaw": {
                                    "covered": 0,
                                    "noCover": 10,
                                    "partial": 0
                                },
                                "coverageStatus": "none",
                                "name": "Sample Policy 3"
                            },
                            "1f0e9d8c-7b6a-5c4d-3e2f-1a0b9c8d7e6f": {
                                "categoryList": [
                                    "Identity Management"
                                ],
                                "coverageMetricsNormalized": {
                                    "covered": 70,
                                    "noCover": 20,
                                    "partial": 10
                                },
                                "coverageMetricsRaw": {
                                    "covered": 7,
                                    "noCover": 2,
                                    "partial": 1
                                },
                                "coverageStatus": "partial",
                                "name": "Sample Policy 4"
                            }
                        },
                        "reportCreatedDate": "2025-11-25T11:00:00Z",
                        "reportUpdatedDate": "2025-11-26T11:00:00Z"
                    }
                ]
            },
            "Discover.ArchitectureReport.CspmPolicyAssessment.PolicyRecord": {
                "title": "Discover - Architecture Report - Cspm Policy Assessment Policy Record",
                "description": "Represents a policy record containing policy details along with user coverage metrics and status",
                "type": "object",
                "properties": {
                    "categoryList": {
                        "description": "Categories that the policy belongs to",
                        "type": "array",
                        "items": {
                            "type": "string",
                            "description": "category of the policy",
                            "examples": [
                                "Identity Management"
                            ]
                        },
                        "examples": [
                            [
                                "Identity Management"
                            ]
                        ]
                    },
                    "name": {
                        "description": "Name of the policy",
                        "type": "string",
                        "examples": [
                            "Sample Policy Name"
                        ]
                    },
                    "coverageMetricsRaw": {
                        "description": "Represents the raw coverage status of the users",
                        "type": "object",
                        "properties": {
                            "covered": {
                                "description": "The amount of users fully covered",
                                "type": "number",
                                "examples": [
                                    5
                                ]
                            },
                            "partial": {
                                "description": "The amount of users partially covered",
                                "type": "number",
                                "examples": [
                                    0,
                                    5,
                                    10
                                ]
                            },
                            "noCover": {
                                "description": "The amount of users not covered",
                                "type": "number",
                                "examples": [
                                    0,
                                    5,
                                    10
                                ]
                            }
                        },
                        "examples": [
                            {
                                "covered": 7,
                                "noCover": 2,
                                "partial": 1
                            }
                        ],
                        "required": [
                            "covered",
                            "partial",
                            "noCover"
                        ]
                    },
                    "coverageMetricsNormalized": {
                        "description": "Represents the normalized coverage status of the users",
                        "type": "object",
                        "properties": {
                            "covered": {
                                "description": "The amount of users fully covered",
                                "type": "number",
                                "examples": [
                                    70
                                ]
                            },
                            "partial": {
                                "description": "The amount of users partially covered",
                                "type": "number",
                                "examples": [
                                    20
                                ]
                            },
                            "noCover": {
                                "description": "The amount of users not covered",
                                "type": "number",
                                "examples": [
                                    10
                                ]
                            }
                        },
                        "examples": [
                            {
                                "covered": 70,
                                "noCover": 20,
                                "partial": 10
                            }
                        ],
                        "required": [
                            "covered",
                            "partial",
                            "noCover"
                        ]
                    },
                    "coverageStatus": {
                        "description": "The summary status for the coverage metrics",
                        "type": "string",
                        "enum": [
                            "full",
                            "partial",
                            "none"
                        ],
                        "examples": [
                            "partial"
                        ]
                    }
                },
                "required": [
                    "categoryList",
                    "name",
                    "coverageMetricsRaw",
                    "coverageMetricsNormalized",
                    "coverageStatus"
                ],
                "examples": [
                    {
                        "categoryList": [
                            "Identity Management"
                        ],
                        "coverageMetricsNormalized": {
                            "covered": 70,
                            "noCover": 20,
                            "partial": 10
                        },
                        "coverageMetricsRaw": {
                            "covered": 7,
                            "noCover": 2,
                            "partial": 1
                        },
                        "coverageStatus": "partial",
                        "name": "Sample Policy"
                    }
                ]
            },
            "ManagedObject.Intermediary": {
                "description": "Base template for all intermediary objects to inherit from.",
                "properties": {
                    "id": {
                        "description": "Read-only.",
                        "examples": [
                            "e097a3f5-9599-44a2-8923-fd3276c83ae1"
                        ],
                        "format": "uuid",
                        "maxLength": 36,
                        "minLength": 36,
                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                        "readOnly": true,
                        "type": "string"
                    },
                    "kind": {
                        "description": "Type of Intermediary that the properties are describing.",
                        "examples": [
                            "AVD"
                        ],
                        "type": "string"
                    },
                    "name": {
                        "description": "Human friendly name of the AVD cluster. This will be displayed to end users in the remote desktop app and web portals.",
                        "examples": [
                            "Legacy Reach Back"
                        ],
                        "maxLength": 42,
                        "minLength": 1,
                        "type": "string"
                    },
                    "securityClass": {
                        "$ref": "#/components/schemas/SecurityClassList"
                    }
                },
                "required": [
                    "name"
                ],
                "title": "Intermediary - Base Type",
                "type": "object",
                "examples": [
                    {
                        "id": "e097a3f5-9599-44a2-8923-fd3276c83ae1",
                        "kind": "AVD",
                        "name": "Legacy Reach Back",
                        "securityClass": "Privileged"
                    }
                ]
            },
            "ManagedObject.AvdIntermediary": {
                "properties": {
                    "addressRangeCIDR": {
                        "description": "Optional Virtual Network IP Address range, defaults to 10.0.0.0/16.",
                        "examples": [
                            "172.16.1.0/24"
                        ],
                        "type": "string"
                    },
                    "assignmentGroup": {
                        "description": "Read-only value that the server generates that is the Object ID of the user assignment security group for the current instance of the AVD intermediary.",
                        "examples": [
                            "68873e26-3c35-465c-9422-0884a00beb36"
                        ],
                        "format": "uuid",
                        "maxLength": 36,
                        "minLength": 36,
                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                        "readOnly": true,
                        "type": "string"
                    },
                    "index": {
                        "description": "Used to uniquely name multiple session hosts in a single host pool.",
                        "minimum": 0,
                        "type": "number",
                        "examples": [
                            0
                        ]
                    },
                    "location": {
                        "description": "Azure Regions that are available for the configured subscription. Resources will be deployed to the region specified here.",
                        "examples": [
                            "East US 2"
                        ],
                        "type": "string"
                    },
                    "resourceId": {
                        "description": "ID of the Host Pool. This is generated by the server and can't be set, hence the read only flag.",
                        "examples": [
                            "/subscriptions/742f0d26-daa0-4f84-8d4f-fb052f89f639/resourceGroups/SHIELD_-_PSM-Legacy_Reach_Back/providers/Microsoft.DesktopVirtualization/hostpools/SHIELD_-_PSM-Cluster-Legacy_Reach_Back"
                        ],
                        "minLength": 122,
                        "readOnly": true,
                        "type": "string"
                    },
                    "sessionHostGroup": {
                        "description": "Read-only value that the server generates that is the Object ID of the session host security group for the current instance of the AVD intermediary.",
                        "examples": [
                            "f99f0918-da9b-4c58-9a8d-9346abc5d9ec"
                        ],
                        "format": "uuid",
                        "maxLength": 36,
                        "minLength": 36,
                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                        "readOnly": true,
                        "type": "string"
                    },
                    "sessionHostPrefix": {
                        "description": "Short name to append to the beginning of the session host VMs. The max computer name length is 15, 4 chars are reserved for indexing and 4 for prefixing.",
                        "examples": [
                            "Reach"
                        ],
                        "maxLength": 7,
                        "minLength": 1,
                        "type": "string"
                    },
                    "vmSku": {
                        "description": "SKU ID in Azure of the VM session host set that is to be deployed.",
                        "examples": [
                            "Standard_D2s_v5"
                        ],
                        "type": "string"
                    }
                },
                "required": [
                    "index",
                    "location",
                    "sessionHostPrefix",
                    "vmSku"
                ],
                "title": "Intermediary - Azure Virtual Desktop",
                "type": "object",
                "examples": [
                    {
                        "addressRangeCIDR": "172.16.1.0/24",
                        "assignmentGroup": "68873e26-3c35-465c-9422-0884a00beb36",
                        "index": 0,
                        "location": "East US 2",
                        "resourceId": "/subscriptions/742f0d26-daa0-4f84-8d4f-fb052f89f639/resourceGroups/SHIELD_-_PSM-Legacy_Reach_Back/providers/Microsoft.DesktopVirtualization/hostpools/SHIELD_-_PSM-Cluster-Legacy_Reach_Back",
                        "sessionHostGroup": "f99f0918-da9b-4c58-9a8d-9346abc5d9ec",
                        "sessionHostPrefix": "Reach",
                        "vmSku": "Standard_D2s_v5"
                    }
                ]
            },
            "LicenseReport.CorrelationRecord": {
                "description": "Metadata that describes the execution session (run) that is used to tie/relate all of the license report together.",
                "examples": [
                    {
                        "auditTenantAccount": "priv-user@example.com",
                        "correlationId": "9d838115-0868-45d4-b8a5-98adc1af7e42",
                        "reportTenantAccount": "ent-user@example.com",
                        "tenantId": "7e536189-b2dd-4c8b-98b1-9b174777883f",
                        "createdAt": "2024-08-01T21:13:12.821Z",
                        "updatedAt": "2024-08-01T21:13:12.821Z"
                    }
                ],
                "properties": {
                    "auditTenantAccount": {
                        "description": "The user account used to retrieve the license information in the tenant being audited.",
                        "examples": [
                            "admin-user@example.com"
                        ],
                        "format": "email",
                        "type": "string"
                    },
                    "correlationId": {
                        "description": "The ID of the execution session (run) that is used to tie/relate all of the data together.",
                        "examples": [
                            "88da2253-758f-4135-9d37-64448c8b65c1"
                        ],
                        "format": "uuid",
                        "maxLength": 36,
                        "minLength": 36,
                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                        "type": "string"
                    },
                    "reportTenantAccount": {
                        "description": "User account used to store/report the license report to the SHI Lab cloud service.",
                        "examples": [
                            "generic-user@example.com"
                        ],
                        "format": "email",
                        "type": "string"
                    },
                    "tenantId": {
                        "description": "Unique ID of customer's Microsoft tenant that the license report is for.",
                        "examples": [
                            "0e1fe83f-a33f-4250-8546-225b8d45ae01"
                        ],
                        "format": "uuid",
                        "maxLength": 36,
                        "minLength": 36,
                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                        "type": "string"
                    },
                    "createdAt": {
                        "description": "Timestamp of when the report was created.",
                        "examples": [
                            "2024-08-01T21:12:22.148Z"
                        ],
                        "format": "date-time",
                        "type": "string"
                    },
                    "updatedAt": {
                        "description": "Timestamp of when the report was last updated.",
                        "examples": [
                            "2024-08-01T21:12:22.148Z"
                        ],
                        "format": "date-time",
                        "type": "string"
                    }
                },
                "required": [
                    "auditTenantAccount"
                ],
                "title": "License Report - Correlation Record",
                "type": "object"
            },
            "LicenseReport.FeatureBreakdown": {
                "additionalProperties": {
                    "type": "boolean",
                    "examples": [
                        true
                    ]
                },
                "description": "List of features that are configured for the specific service plan's service configuration for the related principal.\nThe key is the name of the feature that is being described.\nThe value is the state of the feature configuration, `true` is in scope and `false` meaning not in scope.",
                "examples": [
                    {
                        "Conditional Access": true,
                        "Access Reviews": true,
                        "Dynamic Groups": false,
                        "On-Prem Password Rest": true,
                        "On-Prem Password Protection": false
                    }
                ],
                "title": "License Report - Feature Breakdown",
                "type": "object"
            },
            "LicenseReport": {
                "description": "Completely calculated license report structure that is the result of a complete run.",
                "examples": [
                    {
                        "availableLicense": [
                            {
                                "id": "7e2b1c8e-4f3a-4b2e-9c1d-8a7f6e5d4c3b",
                                "count": 1500,
                                "servicePlanList": [
                                    "2a1f4b7c-8e3d-4c2a-9b5e-7d6f1a2b3c4d",
                                    "9c8b7a6d-5e4f-3a2b-1c0d-8e7f6a5b4c3d"
                                ]
                            }
                        ],
                        "correlation": {
                            "auditTenantAccount": "priv-user@example.com",
                            "correlationId": "9d838115-0868-45d4-b8a5-98adc1af7e42",
                            "reportTenantAccount": "ent-user@example.com",
                            "tenantId": "7e536189-b2dd-4c8b-98b1-9b174777883f",
                            "createdAt": "2024-08-01T21:13:12.821Z",
                            "updatedAt": "2024-08-01T21:13:12.821Z"
                        },
                        "principalData": {
                            "device": {
                                "2d7e3c4a-1b8f-4e2d-9c1a-5f6a7b8e3c2d": {
                                    "assignedService": {
                                        "9c1e4b7a-5d2f-4e3b-8a1c-6f2b7e3c1d4a": {
                                            "Conditional Access": false,
                                            "Access Review": true,
                                            "Entitlement Management": false,
                                            "Identity Protection": true
                                        },
                                        "2a7e3c4d-1b8f-4e2a-9c1d-5f6a7b8e2c3d": 10
                                    },
                                    "assignedLicense": [
                                        {
                                            "id": "1f4e2b7a-3c8d-4e1a-9b2c-7d6e5f3a2b1c",
                                            "servicePlanList": [
                                                "5a7c3e2d-1b9f-4d2a-8c1e-6f3b7e2a4d5c",
                                                "8e1c2a3d-4b7f-4e2c-9a1d-5f6b7c8e2d3a"
                                            ]
                                        }
                                    ],
                                    "consumedService": {
                                        "7e2e1c7b-2b6e-4e7a-8c1a-2e7b8e1c2a3f": {
                                            "Conditional Access": true,
                                            "Access Review": false,
                                            "Entitlement Management": false,
                                            "Identity Protection": true
                                        },
                                        "3f8b2e1d-4c7a-4e2b-9d1a-7e2b3c4d5f6a": null
                                    },
                                    "principalMetadata": {
                                        "sharedComputer": false
                                    }
                                }
                            },
                            "user": {
                                "7a2e3c4d-1b9f-4e2a-8c1d-6f2b7e3a4d5c": {
                                    "assignedService": {
                                        "3a7e2c4d-1b9f-4e2a-8c1d-6f2b7e3c4d5a": {
                                            "Conditional Access": false,
                                            "Access Review": true,
                                            "Entitlement Management": false,
                                            "Identity Protection": true
                                        },
                                        "7b2e1c4d-3a8f-4e2b-9d1a-6f3c7e2a4d5b": null
                                    },
                                    "assignedLicense": [
                                        {
                                            "id": "4e2b7a1c-3d8f-4e2a-9c1d-5f6a7b8e2c3d",
                                            "servicePlanList": [
                                                "6f2a3c4d-1b7e-4e2c-8a1d-5f3b7e2a4d6c",
                                                "9c1d2a3e-4b7f-4e2c-8a1d-5f6b7c8e2d3a"
                                            ]
                                        }
                                    ],
                                    "consumedService": {
                                        "2a7e3c4d-1b8f-4e2a-9c1d-5f6a7b8e2c3d": {
                                            "Conditional Access": true,
                                            "Access Review": false,
                                            "Entitlement Management": false,
                                            "Identity Protection": true
                                        },
                                        "4c7e2a1d-8b3f-4e2c-9a1d-5f6b7e2c3d4a": 15
                                    },
                                    "llmInferred": {
                                        "isServiceAccount": true,
                                        "isFrontlineWorker": false,
                                        "isTempWorker": null
                                    },
                                    "principalMetadata": {
                                        "sharedMailbox": false
                                    },
                                    "enhancedData": {
                                        "userPrincipalName": "some_user@example.com",
                                        "idpJobTitle": "Senior Engineer",
                                        "idpDepartment": "Engineering",
                                        "idpOfficeLocation": "Building 1 / Floor 3",
                                        "idpEmployeeType": "Full-Time"
                                    }
                                }
                            }
                        },
                        "schemaVersion": "1"
                    }
                ],
                "type": "object",
                "properties": {
                    "availableLicense": {
                        "title": "License Report - Available Licenses",
                        "description": "Collection of licenses that have been purchased by the customer.",
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "count": {
                                    "description": "Number of licenses that are purchased of the specific license.",
                                    "type": "integer",
                                    "format": "int32",
                                    "examples": [
                                        1500
                                    ]
                                },
                                "id": {
                                    "description": "Well known ID of the license bundle.",
                                    "format": "uuid",
                                    "maxLength": 36,
                                    "minLength": 36,
                                    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                    "type": "string",
                                    "examples": [
                                        "7e2b1c8e-4f3a-4b2e-9c1d-8a7f6e5d4c3b"
                                    ]
                                },
                                "servicePlanList": {
                                    "description": "List of available service plans for the current license.",
                                    "type": "array",
                                    "items": {
                                        "format": "uuid",
                                        "maxLength": 36,
                                        "minLength": 36,
                                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                        "type": "string",
                                        "examples": [
                                            "2a1f4b7c-8e3d-4c2a-9b5e-7d6f1a2b3c4d"
                                        ]
                                    },
                                    "examples": [
                                        [
                                            "2a1f4b7c-8e3d-4c2a-9b5e-7d6f1a2b3c4d",
                                            "9c8b7a6d-5e4f-3a2b-1c0d-8e7f6a5b4c3d"
                                        ]
                                    ]
                                }
                            },
                            "required": [
                                "id",
                                "count",
                                "servicePlanList"
                            ],
                            "examples": [
                                {
                                    "id": "7e2b1c8e-4f3a-4b2e-9c1d-8a7f6e5d4c3b",
                                    "count": 1500,
                                    "servicePlanList": [
                                        "2a1f4b7c-8e3d-4c2a-9b5e-7d6f1a2b3c4d",
                                        "9c8b7a6d-5e4f-3a2b-1c0d-8e7f6a5b4c3d"
                                    ]
                                }
                            ]
                        },
                        "examples": [
                            [
                                {
                                    "id": "7e2b1c8e-4f3a-4b2e-9c1d-8a7f6e5d4c3b",
                                    "count": 1500,
                                    "servicePlanList": [
                                        "2a1f4b7c-8e3d-4c2a-9b5e-7d6f1a2b3c4d",
                                        "9c8b7a6d-5e4f-3a2b-1c0d-8e7f6a5b4c3d"
                                    ]
                                }
                            ]
                        ]
                    },
                    "correlation": {
                        "$ref": "#/components/schemas/LicenseReport.CorrelationRecord"
                    },
                    "principalData": {
                        "title": "Architecture Report - Principle Data",
                        "description": "Container for all of the data that can be correlated to various principals.",
                        "type": "object",
                        "properties": {
                            "device": {
                                "description": "Device principal data. Where the key is the Object ID (`GUID`/`UUIDv4`) of the principal. The value is the collected data.",
                                "type": "object",
                                "additionalProperties": {
                                    "description": "Structure of the data that represents a device principal.",
                                    "type": "object",
                                    "properties": {
                                        "assignedService": {
                                            "description": "Service configuration assignment. This is used to record the set of principals that are 'benefiting' from the service, regardless of license status.",
                                            "type": "object",
                                            "additionalProperties": {
                                                "oneOf": [
                                                    {
                                                        "$ref": "#/components/schemas/LicenseReport.FeatureBreakdown"
                                                    },
                                                    {
                                                        "type": "integer",
                                                        "format": "int32",
                                                        "examples": [
                                                            7
                                                        ]
                                                    },
                                                    {
                                                        "type": "null"
                                                    }
                                                ]
                                            },
                                            "examples": [
                                                {
                                                    "9c1e4b7a-5d2f-4e3b-8a1c-6f2b7e3c1d4a": {
                                                        "Conditional Access": false,
                                                        "Access Review": true,
                                                        "Entitlement Management": false,
                                                        "Identity Protection": true
                                                    },
                                                    "2a7e3c4d-1b8f-4e2a-9c1d-5f6a7b8e2c3d": 10
                                                }
                                            ]
                                        },
                                        "assignedLicense": {
                                            "description": "List of the licenses and their associated service plans assigned to the current principal.",
                                            "type": "array",
                                            "items": {
                                                "type": "object",
                                                "properties": {
                                                    "id": {
                                                        "description": "Unique identifier for the assigned license. These IDs are well-known and can be used with a lookup table to derive a display name.",
                                                        "format": "uuid",
                                                        "maxLength": 36,
                                                        "minLength": 36,
                                                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                                        "type": "string",
                                                        "examples": [
                                                            "1f4e2b7a-3c8d-4e1a-9b2c-7d6e5f3a2b1c"
                                                        ]
                                                    },
                                                    "servicePlanList": {
                                                        "description": "List of service plans that are associated with the principal's assigned license. This list is only active/valid service plans. Disabled plans are filtered out.",
                                                        "type": "array",
                                                        "items": {
                                                            "format": "uuid",
                                                            "maxLength": 36,
                                                            "minLength": 36,
                                                            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                                            "type": "string",
                                                            "examples": [
                                                                "5a7c3e2d-1b9f-4d2a-8c1e-6f3b7e2a4d5c"
                                                            ]
                                                        },
                                                        "examples": [
                                                            [
                                                                "5a7c3e2d-1b9f-4d2a-8c1e-6f3b7e2a4d5c",
                                                                "8e1c2a3d-4b7f-4e2c-9a1d-5f6b7c8e2d3a"
                                                            ]
                                                        ]
                                                    }
                                                },
                                                "required": [
                                                    "id",
                                                    "servicePlanList"
                                                ],
                                                "examples": [
                                                    {
                                                        "id": "1f4e2b7a-3c8d-4e1a-9b2c-7d6e5f3a2b1c",
                                                        "servicePlanList": [
                                                            "5a7c3e2d-1b9f-4d2a-8c1e-6f3b7e2a4d5c",
                                                            "8e1c2a3d-4b7f-4e2c-9a1d-5f6b7c8e2d3a"
                                                        ]
                                                    }
                                                ]
                                            },
                                            "examples": [
                                                [
                                                    {
                                                        "id": "1f4e2b7a-3c8d-4e1a-9b2c-7d6e5f3a2b1c",
                                                        "servicePlanList": [
                                                            "5a7c3e2d-1b9f-4d2a-8c1e-6f3b7e2a4d5c",
                                                            "8e1c2a3d-4b7f-4e2c-9a1d-5f6b7c8e2d3a"
                                                        ]
                                                    }
                                                ]
                                            ]
                                        },
                                        "consumedService": {
                                            "description": "Usage telemetry retrieved for the service to indicate if the specific principal is consuming the service or not, regardless of license status.",
                                            "type": "object",
                                            "additionalProperties": {
                                                "oneOf": [
                                                    {
                                                        "$ref": "#/components/schemas/LicenseReport.FeatureBreakdown"
                                                    },
                                                    {
                                                        "type": "integer",
                                                        "format": "int32",
                                                        "examples": [
                                                            3
                                                        ]
                                                    },
                                                    {
                                                        "type": "null"
                                                    }
                                                ]
                                            },
                                            "examples": [
                                                {
                                                    "7e2e1c7b-2b6e-4e7a-8c1a-2e7b8e1c2a3f": {
                                                        "Conditional Access": true,
                                                        "Access Review": false,
                                                        "Entitlement Management": false,
                                                        "Identity Protection": true
                                                    },
                                                    "3f8b2e1d-4c7a-4e2b-9d1a-7e2b3c4d5f6a": 5
                                                }
                                            ]
                                        },
                                        "principalMetadata": {
                                            "description": "Metadata that is derived by analysis rules, not wishy washy LLMs.",
                                            "type": "object",
                                            "properties": {
                                                "sharedComputer": {
                                                    "description": "Flag that indicates that the device has more than one user using it.",
                                                    "type": "boolean",
                                                    "examples": [
                                                        false
                                                    ]
                                                }
                                            },
                                            "required": [
                                                "sharedComputer"
                                            ],
                                            "examples": [
                                                {
                                                    "sharedComputer": false
                                                }
                                            ]
                                        }
                                    },
                                    "required": [
                                        "assignedService",
                                        "assignedLicense",
                                        "consumedService",
                                        "principalMetadata"
                                    ],
                                    "examples": [
                                        {
                                            "assignedService": {
                                                "9c1e4b7a-5d2f-4e3b-8a1c-6f2b7e3c1d4a": {
                                                    "Conditional Access": false,
                                                    "Access Review": true,
                                                    "Entitlement Management": false,
                                                    "Identity Protection": true
                                                },
                                                "2a7e3c4d-1b8f-4e2a-9c1d-5f6a7b8e2c3d": 10
                                            },
                                            "assignedLicense": [
                                                {
                                                    "id": "1f4e2b7a-3c8d-4e1a-9b2c-7d6e5f3a2b1c",
                                                    "servicePlanList": [
                                                        "5a7c3e2d-1b9f-4d2a-8c1e-6f3b7e2a4d5c",
                                                        "8e1c2a3d-4b7f-4e2c-9a1d-5f6b7c8e2d3a"
                                                    ]
                                                }
                                            ],
                                            "consumedService": {
                                                "7e2e1c7b-2b6e-4e7a-8c1a-2e7b8e1c2a3f": {
                                                    "Conditional Access": true,
                                                    "Access Review": false,
                                                    "Entitlement Management": false,
                                                    "Identity Protection": true
                                                },
                                                "3f8b2e1d-4c7a-4e2b-9d1a-7e2b3c4d5f6a": null
                                            },
                                            "principalMetadata": {
                                                "sharedComputer": false
                                            }
                                        }
                                    ]
                                },
                                "examples": [
                                    {
                                        "2d7e3c4a-1b8f-4e2d-9c1a-5f6a7b8e3c2d": {
                                            "assignedService": {
                                                "9c1e4b7a-5d2f-4e3b-8a1c-6f2b7e3c1d4a": {
                                                    "Conditional Access": false,
                                                    "Access Review": true,
                                                    "Entitlement Management": false,
                                                    "Identity Protection": true
                                                },
                                                "2a7e3c4d-1b8f-4e2a-9c1d-5f6a7b8e2c3d": 10
                                            },
                                            "assignedLicense": [
                                                {
                                                    "id": "1f4e2b7a-3c8d-4e1a-9b2c-7d6e5f3a2b1c",
                                                    "servicePlanList": [
                                                        "5a7c3e2d-1b9f-4d2a-8c1e-6f3b7e2a4d5c",
                                                        "8e1c2a3d-4b7f-4e2c-9a1d-5f6b7c8e2d3a"
                                                    ]
                                                }
                                            ],
                                            "consumedService": {
                                                "7e2e1c7b-2b6e-4e7a-8c1a-2e7b8e1c2a3f": {
                                                    "Conditional Access": true,
                                                    "Access Review": false,
                                                    "Entitlement Management": false,
                                                    "Identity Protection": true
                                                },
                                                "3f8b2e1d-4c7a-4e2b-9d1a-7e2b3c4d5f6a": null
                                            },
                                            "principalMetadata": {
                                                "sharedComputer": false
                                            }
                                        }
                                    }
                                ]
                            },
                            "user": {
                                "description": "User principal data. Where the key is the Object ID (`GUID`/`UUIDv4`) of the principal. The value is the collected data.",
                                "type": "object",
                                "additionalProperties": {
                                    "description": "Structure of the data that represents a user principal.",
                                    "type": "object",
                                    "properties": {
                                        "assignedService": {
                                            "description": "Service configuration assignment. This is used to record the set of principals that are 'benefiting' from the service, regardless of license status.",
                                            "type": "object",
                                            "additionalProperties": {
                                                "oneOf": [
                                                    {
                                                        "$ref": "#/components/schemas/LicenseReport.FeatureBreakdown"
                                                    },
                                                    {
                                                        "type": "integer",
                                                        "format": "int32",
                                                        "examples": [
                                                            12
                                                        ]
                                                    },
                                                    {
                                                        "type": "null"
                                                    }
                                                ]
                                            },
                                            "examples": [
                                                {
                                                    "3a7e2c4d-1b9f-4e2a-8c1d-6f2b7e3c4d5a": {
                                                        "Conditional Access": false,
                                                        "Access Review": true,
                                                        "Entitlement Management": false,
                                                        "Identity Protection": true
                                                    },
                                                    "7b2e1c4d-3a8f-4e2b-9d1a-6f3c7e2a4d5b": null
                                                }
                                            ]
                                        },
                                        "assignedLicense": {
                                            "description": "List of the licenses and their associated service plans assigned to the current principal.",
                                            "type": "array",
                                            "items": {
                                                "type": "object",
                                                "properties": {
                                                    "id": {
                                                        "description": "Unique identifier for the assigned license. These IDs are well-known and can be used with a lookup table to derive a display name.",
                                                        "format": "uuid",
                                                        "maxLength": 36,
                                                        "minLength": 36,
                                                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                                        "type": "string",
                                                        "examples": [
                                                            "4e2b7a1c-3d8f-4e2a-9c1d-5f6a7b8e2c3d"
                                                        ]
                                                    },
                                                    "servicePlanList": {
                                                        "description": "List of service plans that are associated with the principal's assigned license. This list is only active/valid service plans. Disabled plans are filtered out.",
                                                        "type": "array",
                                                        "items": {
                                                            "format": "uuid",
                                                            "maxLength": 36,
                                                            "minLength": 36,
                                                            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                                            "type": "string",
                                                            "examples": [
                                                                "6f2a3c4d-1b7e-4e2c-8a1d-5f3b7e2a4d6c"
                                                            ]
                                                        },
                                                        "examples": [
                                                            [
                                                                "6f2a3c4d-1b7e-4e2c-8a1d-5f3b7e2a4d6c",
                                                                "9c1d2a3e-4b7f-4e2c-8a1d-5f6b7c8e2d3a"
                                                            ]
                                                        ]
                                                    }
                                                },
                                                "required": [
                                                    "id",
                                                    "servicePlanList"
                                                ],
                                                "examples": [
                                                    {
                                                        "id": "4e2b7a1c-3d8f-4e2a-9c1d-5f6a7b8e2c3d",
                                                        "servicePlanList": [
                                                            "6f2a3c4d-1b7e-4e2c-8a1d-5f3b7e2a4d6c",
                                                            "9c1d2a3e-4b7f-4e2c-8a1d-5f6b7c8e2d3a"
                                                        ]
                                                    }
                                                ]
                                            },
                                            "examples": [
                                                [
                                                    {
                                                        "id": "4e2b7a1c-3d8f-4e2a-9c1d-5f6a7b8e2c3d",
                                                        "servicePlanList": [
                                                            "6f2a3c4d-1b7e-4e2c-8a1d-5f3b7e2a4d6c",
                                                            "9c1d2a3e-4b7f-4e2c-8a1d-5f6b7c8e2d3a"
                                                        ]
                                                    }
                                                ]
                                            ]
                                        },
                                        "consumedService": {
                                            "description": "Usage telemetry retrieved for the service to indicate if the specific principal is consuming the service or not, regardless of license status.",
                                            "type": "object",
                                            "additionalProperties": {
                                                "oneOf": [
                                                    {
                                                        "$ref": "#/components/schemas/LicenseReport.FeatureBreakdown"
                                                    },
                                                    {
                                                        "type": "integer",
                                                        "format": "int32",
                                                        "examples": [
                                                            3
                                                        ]
                                                    },
                                                    {
                                                        "type": "null"
                                                    }
                                                ]
                                            },
                                            "examples": [
                                                {
                                                    "2a7e3c4d-1b8f-4e2a-9c1d-5f6a7b8e2c3d": {
                                                        "Conditional Access": true,
                                                        "Access Review": false,
                                                        "Entitlement Management": false,
                                                        "Identity Protection": true
                                                    },
                                                    "4c7e2a1d-8b3f-4e2c-9a1d-5f6b7e2c3d4a": 15
                                                }
                                            ]
                                        },
                                        "llmInferred": {
                                            "description": "User data inferred by the LLM. AI-generated content may be incorrect.",
                                            "type": "object",
                                            "properties": {
                                                "isServiceAccount": {
                                                    "description": "Is the user a service account.",
                                                    "oneOf": [
                                                        {
                                                            "type": "boolean",
                                                            "examples": [
                                                                true
                                                            ]
                                                        },
                                                        {
                                                            "type": "null"
                                                        }
                                                    ],
                                                    "examples": [
                                                        true
                                                    ]
                                                },
                                                "isFrontlineWorker": {
                                                    "description": "Is the user a frontline worker as defined by Microsoft.",
                                                    "oneOf": [
                                                        {
                                                            "type": "boolean",
                                                            "examples": [
                                                                true
                                                            ]
                                                        },
                                                        {
                                                            "type": "null"
                                                        }
                                                    ],
                                                    "examples": [
                                                        false
                                                    ]
                                                },
                                                "isTempWorker": {
                                                    "description": "Is the user a temporary employee. E.g. Intern, Contractor.",
                                                    "oneOf": [
                                                        {
                                                            "type": "boolean",
                                                            "examples": [
                                                                true
                                                            ]
                                                        },
                                                        {
                                                            "type": "null"
                                                        }
                                                    ],
                                                    "examples": [
                                                        false
                                                    ]
                                                }
                                            },
                                            "required": [
                                                "isServiceAccount",
                                                "isFrontlineWorker",
                                                "isTempWorker"
                                            ],
                                            "examples": [
                                                {
                                                    "isServiceAccount": true,
                                                    "isFrontlineWorker": false,
                                                    "isTempWorker": null
                                                }
                                            ]
                                        },
                                        "principalMetadata": {
                                            "description": "Metadata that is derived by analysis rules, not wishy washy LLMs.",
                                            "type": "object",
                                            "properties": {
                                                "sharedMailbox": {
                                                    "description": "Flag that indicates the principal is a shared mailbox in Exchange.",
                                                    "type": "boolean",
                                                    "examples": [
                                                        false
                                                    ]
                                                }
                                            },
                                            "required": [
                                                "sharedMailbox"
                                            ],
                                            "examples": [
                                                {
                                                    "sharedMailbox": false
                                                }
                                            ]
                                        },
                                        "enhancedData": {
                                            "description": "Data that is End User Identifiable Information. Only collected if the customer explicitly agrees to the additional data retrieval.",
                                            "oneOf": [
                                                {
                                                    "type": "object",
                                                    "properties": {
                                                        "userPrincipalName": {
                                                            "description": "Username of the user, frequently is also the email address.",
                                                            "type": "string",
                                                            "examples": [
                                                                "some_user@example.com"
                                                            ]
                                                        },
                                                        "idpJobTitle": {
                                                            "description": "Job title of the user retrieved from the primary IDP's user profile.",
                                                            "oneOf": [
                                                                {
                                                                    "type": "string",
                                                                    "examples": [
                                                                        "Senior Engineer"
                                                                    ]
                                                                },
                                                                {
                                                                    "type": "null"
                                                                }
                                                            ],
                                                            "examples": [
                                                                "Senior Engineer"
                                                            ]
                                                        },
                                                        "idpDepartment": {
                                                            "description": "Job organization metadata retrieved from the primary IDP's user profile.",
                                                            "oneOf": [
                                                                {
                                                                    "type": "string",
                                                                    "examples": [
                                                                        "Engineering"
                                                                    ]
                                                                },
                                                                {
                                                                    "type": "null"
                                                                }
                                                            ],
                                                            "examples": [
                                                                "Engineering"
                                                            ]
                                                        },
                                                        "idpOfficeLocation": {
                                                            "description": "Job location metadata retrieved from the primary IDP's user profile.",
                                                            "oneOf": [
                                                                {
                                                                    "type": "string",
                                                                    "examples": [
                                                                        "Building 1 / Floor 3"
                                                                    ]
                                                                },
                                                                {
                                                                    "type": "null"
                                                                }
                                                            ],
                                                            "examples": [
                                                                "Building 1 / Floor 3"
                                                            ]
                                                        },
                                                        "idpEmployeeType": {
                                                            "description": "Job type metadata retrieved from the primary IDP's user profile.",
                                                            "oneOf": [
                                                                {
                                                                    "type": "string",
                                                                    "examples": [
                                                                        "Full-Time"
                                                                    ]
                                                                },
                                                                {
                                                                    "type": "null"
                                                                }
                                                            ],
                                                            "examples": [
                                                                "Full-Time"
                                                            ]
                                                        }
                                                    },
                                                    "required": [
                                                        "userPrincipalName",
                                                        "idpJobTitle",
                                                        "idpDepartment",
                                                        "idpOfficeLocation",
                                                        "idpEmployeeType"
                                                    ],
                                                    "examples": [
                                                        {
                                                            "userPrincipalName": "some_user@example.com",
                                                            "idpJobTitle": "Senior Engineer",
                                                            "idpDepartment": "Engineering",
                                                            "idpOfficeLocation": "Building 1 / Floor 3",
                                                            "idpEmployeeType": "Full-Time"
                                                        }
                                                    ]
                                                },
                                                {
                                                    "type": "null"
                                                }
                                            ],
                                            "examples": [
                                                {
                                                    "userPrincipalName": "some_user@example.com",
                                                    "idpJobTitle": "Senior Engineer",
                                                    "idpDepartment": "Engineering",
                                                    "idpOfficeLocation": "Building 1 / Floor 3",
                                                    "idpEmployeeType": "Full-Time"
                                                }
                                            ]
                                        }
                                    },
                                    "required": [
                                        "assignedService",
                                        "assignedLicense",
                                        "consumedService",
                                        "llmInferred",
                                        "principalMetadata",
                                        "enhancedData"
                                    ],
                                    "examples": [
                                        {
                                            "assignedService": {
                                                "3a7e2c4d-1b9f-4e2a-8c1d-6f2b7e3c4d5a": {
                                                    "Conditional Access": false,
                                                    "Access Review": true,
                                                    "Entitlement Management": false,
                                                    "Identity Protection": true
                                                },
                                                "7b2e1c4d-3a8f-4e2b-9d1a-6f3c7e2a4d5b": null
                                            },
                                            "assignedLicense": [
                                                {
                                                    "id": "4e2b7a1c-3d8f-4e2a-9c1d-5f6a7b8e2c3d",
                                                    "servicePlanList": [
                                                        "6f2a3c4d-1b7e-4e2c-8a1d-5f3b7e2a4d6c",
                                                        "9c1d2a3e-4b7f-4e2c-8a1d-5f6b7c8e2d3a"
                                                    ]
                                                }
                                            ],
                                            "consumedService": {
                                                "2a7e3c4d-1b8f-4e2a-9c1d-5f6a7b8e2c3d": {
                                                    "Conditional Access": true,
                                                    "Access Review": false,
                                                    "Entitlement Management": false,
                                                    "Identity Protection": true
                                                },
                                                "4c7e2a1d-8b3f-4e2c-9a1d-5f6b7e2c3d4a": 15
                                            },
                                            "llmInferred": {
                                                "isServiceAccount": true,
                                                "isFrontlineWorker": false,
                                                "isTempWorker": null
                                            },
                                            "principalMetadata": {
                                                "sharedMailbox": false
                                            },
                                            "enhancedData": {
                                                "userPrincipalName": "some_user@example.com",
                                                "idpJobTitle": "Senior Engineer",
                                                "idpDepartment": "Engineering",
                                                "idpOfficeLocation": "Building 1 / Floor 3",
                                                "idpEmployeeType": "Full-Time"
                                            }
                                        }
                                    ]
                                },
                                "examples": [
                                    {
                                        "7a2e3c4d-1b9f-4e2a-8c1d-6f2b7e3a4d5c": {
                                            "assignedService": {
                                                "3a7e2c4d-1b9f-4e2a-8c1d-6f2b7e3c4d5a": {
                                                    "Conditional Access": false,
                                                    "Access Review": true,
                                                    "Entitlement Management": false,
                                                    "Identity Protection": true
                                                },
                                                "7b2e1c4d-3a8f-4e2b-9d1a-6f3c7e2a4d5b": null
                                            },
                                            "assignedLicense": [
                                                {
                                                    "id": "4e2b7a1c-3d8f-4e2a-9c1d-5f6a7b8e2c3d",
                                                    "servicePlanList": [
                                                        "6f2a3c4d-1b7e-4e2c-8a1d-5f3b7e2a4d6c",
                                                        "9c1d2a3e-4b7f-4e2c-8a1d-5f6b7c8e2d3a"
                                                    ]
                                                }
                                            ],
                                            "consumedService": {
                                                "2a7e3c4d-1b8f-4e2a-9c1d-5f6a7b8e2c3d": {
                                                    "Conditional Access": true,
                                                    "Access Review": false,
                                                    "Entitlement Management": false,
                                                    "Identity Protection": true
                                                },
                                                "4c7e2a1d-8b3f-4e2c-9a1d-5f6b7e2c3d4a": 15
                                            },
                                            "llmInferred": {
                                                "isServiceAccount": true,
                                                "isFrontlineWorker": false,
                                                "isTempWorker": null
                                            },
                                            "principalMetadata": {
                                                "sharedMailbox": false
                                            },
                                            "enhancedData": {
                                                "userPrincipalName": "some_user@example.com",
                                                "idpJobTitle": "Senior Engineer",
                                                "idpDepartment": "Engineering",
                                                "idpOfficeLocation": "Building 1 / Floor 3",
                                                "idpEmployeeType": "Full-Time"
                                            }
                                        }
                                    }
                                ]
                            }
                        },
                        "required": [
                            "device",
                            "user"
                        ],
                        "examples": [
                            {
                                "device": {
                                    "2d7e3c4a-1b8f-4e2d-9c1a-5f6a7b8e3c2d": {
                                        "assignedService": {
                                            "9c1e4b7a-5d2f-4e3b-8a1c-6f2b7e3c1d4a": {
                                                "Conditional Access": false,
                                                "Access Review": true,
                                                "Entitlement Management": false,
                                                "Identity Protection": true
                                            },
                                            "2a7e3c4d-1b8f-4e2a-9c1d-5f6a7b8e2c3d": 10
                                        },
                                        "assignedLicense": [
                                            {
                                                "id": "1f4e2b7a-3c8d-4e1a-9b2c-7d6e5f3a2b1c",
                                                "servicePlanList": [
                                                    "5a7c3e2d-1b9f-4d2a-8c1e-6f3b7e2a4d5c",
                                                    "8e1c2a3d-4b7f-4e2c-9a1d-5f6b7c8e2d3a"
                                                ]
                                            }
                                        ],
                                        "consumedService": {
                                            "7e2e1c7b-2b6e-4e7a-8c1a-2e7b8e1c2a3f": {
                                                "Conditional Access": true,
                                                "Access Review": false,
                                                "Entitlement Management": false,
                                                "Identity Protection": true
                                            },
                                            "3f8b2e1d-4c7a-4e2b-9d1a-7e2b3c4d5f6a": null
                                        },
                                        "principalMetadata": {
                                            "sharedComputer": false
                                        }
                                    }
                                },
                                "user": {
                                    "7a2e3c4d-1b9f-4e2a-8c1d-6f2b7e3a4d5c": {
                                        "assignedService": {
                                            "3a7e2c4d-1b9f-4e2a-8c1d-6f2b7e3c4d5a": {
                                                "Conditional Access": false,
                                                "Access Review": true,
                                                "Entitlement Management": false,
                                                "Identity Protection": true
                                            },
                                            "7b2e1c4d-3a8f-4e2b-9d1a-6f3c7e2a4d5b": null
                                        },
                                        "assignedLicense": [
                                            {
                                                "id": "4e2b7a1c-3d8f-4e2a-9c1d-5f6a7b8e2c3d",
                                                "servicePlanList": [
                                                    "6f2a3c4d-1b7e-4e2c-8a1d-5f3b7e2a4d6c",
                                                    "9c1d2a3e-4b7f-4e2c-8a1d-5f6b7c8e2d3a"
                                                ]
                                            }
                                        ],
                                        "consumedService": {
                                            "2a7e3c4d-1b8f-4e2a-9c1d-5f6a7b8e2c3d": {
                                                "Conditional Access": true,
                                                "Access Review": false,
                                                "Entitlement Management": false,
                                                "Identity Protection": true
                                            },
                                            "4c7e2a1d-8b3f-4e2c-9a1d-5f6b7e2c3d4a": 15
                                        },
                                        "llmInferred": {
                                            "isServiceAccount": true,
                                            "isFrontlineWorker": false,
                                            "isTempWorker": null
                                        },
                                        "principalMetadata": {
                                            "sharedMailbox": false
                                        },
                                        "enhancedData": {
                                            "userPrincipalName": "some_user@example.com",
                                            "idpJobTitle": "Senior Engineer",
                                            "idpDepartment": "Engineering",
                                            "idpOfficeLocation": "Building 1 / Floor 3",
                                            "idpEmployeeType": "Full-Time"
                                        }
                                    }
                                }
                            }
                        ]
                    },
                    "schemaVersion": {
                        "title": "License Report - Schema Version",
                        "description": "Indicator for migration scripts to auto migrate the data to newer or older formats.",
                        "type": "integer",
                        "examples": [
                            1
                        ]
                    }
                },
                "required": [
                    "availableLicense",
                    "correlation",
                    "principalData",
                    "schemaVersion"
                ],
                "title": "License Report - Complete Object"
            },
            "ManagedObject.Device": {
                "title": "Managed Device",
                "description": "Structure that represents a all of the states a managed device could be in.",
                "type": "object",
                "examples": [
                    {
                        "commissionedDate": "2023-02-04T05:06:09.601Z",
                        "displayName": "Priv-01534962354",
                        "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                        "parentDeviceId": "81682cf5-0405-491d-8ab8-e07c778d7eaf",
                        "securityClass": "Privileged",
                        "uniqueGroupId": "146964e0-8ca4-4af0-9c2a-894b32912463"
                    }
                ],
                "properties": {
                    "commissionedDate": {
                        "description": "This is the ISO 8601 string format of the time representing the commission date of the PAW.",
                        "examples": [
                            "2023-02-04T05:06:09.601Z"
                        ],
                        "format": "date-time",
                        "type": "string"
                    },
                    "displayName": {
                        "description": "Current computer name of the device according to Entra ID. Empty string indicates that the device has not joined Entra ID yet.",
                        "examples": [
                            "Priv-01534962354"
                        ],
                        "maxLength": 15,
                        "minLength": 0,
                        "type": "string"
                    },
                    "id": {
                        "description": "Entra ID Device ID (Not Object ID) of the specified device.",
                        "examples": [
                            "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf"
                        ],
                        "format": "uuid",
                        "maxLength": 36,
                        "minLength": 36,
                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                        "readOnly": true,
                        "type": "string"
                    },
                    "parentDeviceId": {
                        "description": "DeviceID of the parent PAW device.",
                        "examples": [
                            "81682cf5-0405-491d-8ab8-e07c778d7eaf"
                        ],
                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                        "type": "string"
                    },
                    "securityClass": {
                        "$ref": "#/components/schemas/SecurityClassList"
                    },
                    "uniqueGroupId": {
                        "description": "The object ID of the unique security group that contains the managed Entra ID Device Identity.",
                        "examples": [
                            "146964e0-8ca4-4af0-9c2a-894b32912463"
                        ],
                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                        "readOnly": true,
                        "type": "string"
                    }
                },
                "required": [
                    "commissionedDate",
                    "displayName",
                    "id",
                    "securityClass",
                    "uniqueGroupId"
                ]
            },
            "ManagedObject.PrivilegedDevice": {
                "description": "Set of properties that are available on privileged managed device objects only.",
                "title": "Managed Device - Privileged",
                "type": "object",
                "allOf": [
                    {
                        "$ref": "#/components/schemas/ManagedObject.Device"
                    },
                    {
                        "type": "object",
                        "properties": {
                            "groupAssignmentId": {
                                "description": "This is the ID of the Custom CSP Device Configuration that configures the local admin and local hyper-v group memberships.",
                                "examples": [
                                    "830d8b6f-2f6f-41f7-8800-0c07445abd36"
                                ],
                                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                "type": "string"
                            },
                            "securityClass": {
                                "$ref": "#/components/schemas/SecurityClassList"
                            },
                            "userAssignmentId": {
                                "description": "The ID of the Settings Catalog that contains the user rights assignment of the specified PAW device.",
                                "examples": [
                                    "146964e0-8ca4-4af0-9c2a-894b32912463"
                                ],
                                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                "readOnly": true,
                                "type": "string"
                            },
                            "userAssignmentList": {
                                "description": "List of Object IDs for the privileged user accounts that are assigned to this device.",
                                "examples": [
                                    [
                                        "56d0d4e1-96f6-4cfb-a5e9-a4ee923169a8",
                                        "94a9d681-a8d2-43eb-a83b-d4bfe90259ff",
                                        "c54d4854-9254-4689-8a22-1cc80a3dae4e"
                                    ]
                                ],
                                "type": "array",
                                "items": {
                                    "type": "string",
                                    "format": "uuid"
                                }
                            }
                        },
                        "required": [
                            "groupAssignmentId",
                            "securityClass",
                            "userAssignmentId",
                            "userAssignmentList"
                        ],
                        "examples": [
                            {
                                "commissionedDate": "2023-02-04T05:06:09.601Z",
                                "displayName": "Priv-01534962354",
                                "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                "parentDeviceId": "81682cf5-0405-491d-8ab8-e07c778d7eaf",
                                "uniqueGroupId": "146964e0-8ca4-4af0-9c2a-894b32912463",
                                "groupAssignmentId": "830d8b6f-2f6f-41f7-8800-0c07445abd36",
                                "securityClass": "Privileged",
                                "userAssignmentId": "146964e0-8ca4-4af0-9c2a-894b32912463",
                                "userAssignmentList": [
                                    "56d0d4e1-96f6-4cfb-a5e9-a4ee923169a8",
                                    "94a9d681-a8d2-43eb-a83b-d4bfe90259ff",
                                    "c54d4854-9254-4689-8a22-1cc80a3dae4e"
                                ]
                            }
                        ]
                    }
                ]
            },
            "ManagedObject.User": {
                "title": "Managed User",
                "description": "A user object that has limited properties. The user object is generated by combining multiple pieces of metadata from Entra ID and SHIELD.",
                "properties": {
                    "creationDate": {
                        "description": "A date object representing when the user managed by SHIELD.",
                        "examples": [
                            "2023-10-21T15:24:47.970Z"
                        ],
                        "format": "date-time",
                        "readOnly": true,
                        "type": "string"
                    },
                    "displayName": {
                        "description": "The name shown on UIs for the privileged user according to Entra ID.",
                        "examples": [
                            "Example User (Priv)"
                        ],
                        "maxLength": 256,
                        "type": "string"
                    },
                    "firstName": {
                        "description": "Given name of the privileged user according to Entra ID.",
                        "maxLength": 64,
                        "type": "string",
                        "examples": [
                            "John"
                        ]
                    },
                    "id": {
                        "description": "The Entra ID Object ID of the managed user. This is the one property that is stored in the settings engine. This is the key in the storage systems to uniquely separate the managed user's data from others.",
                        "examples": [
                            "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf"
                        ],
                        "format": "uuid",
                        "maxLength": 36,
                        "minLength": 36,
                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                        "readOnly": true,
                        "type": "string"
                    },
                    "intermediaryAssignmentList": {
                        "type": "array",
                        "description": "List of intermediaries that the user is assigned to.",
                        "items": {
                            "type": "string",
                            "format": "uuid"
                        },
                        "examples": [
                            [
                                "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                "995f3b39-1e01-40d4-9368-ee956343e97c"
                            ]
                        ]
                    },
                    "lastName": {
                        "description": "Surname/family name of the privileged user according to Entra ID.",
                        "maxLength": 64,
                        "type": "string",
                        "examples": [
                            "Doe"
                        ]
                    },
                    "upn": {
                        "description": "User principal name of the user object according to Azure Active Directory.",
                        "examples": [
                            "priv-user@example.com"
                        ],
                        "format": "email",
                        "maxLength": 113,
                        "minLength": 6,
                        "type": "string"
                    },
                    "securityClass": {
                        "$ref": "#/components/schemas/SecurityClassList"
                    },
                    "siloAssignmentList": {
                        "type": "array",
                        "description": "List of silos that the user is assigned to.",
                        "items": {
                            "type": "string",
                            "format": "uuid"
                        },
                        "examples": [
                            [
                                "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                "995f3b39-1e01-40d4-9368-ee956343e97c"
                            ]
                        ]
                    },
                    "uiEducation": {
                        "description": "Indicates if user education is enabled in the UI for the specified user. True is on, false is off.",
                        "examples": [
                            false
                        ],
                        "type": "boolean"
                    },
                    "uniqueGroupId": {
                        "description": "ObjectID of the unique user group that the managed user is a member of.",
                        "examples": [
                            "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d"
                        ],
                        "format": "uuid",
                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                        "readOnly": true,
                        "type": "string"
                    }
                },
                "required": [
                    "creationDate",
                    "securityClass",
                    "id",
                    "intermediaryAssignmentList",
                    "siloAssignmentList",
                    "uiEducation",
                    "uniqueGroupId",
                    "upn"
                ],
                "type": "object",
                "examples": [
                    {
                        "creationDate": "2023-10-21T15:24:47.970Z",
                        "displayName": "Example User (Priv)",
                        "firstName": "John",
                        "lastName": "Doe",
                        "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                        "upn": "priv-user@example.com",
                        "securityClass": "Privileged",
                        "uiEducation": false,
                        "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                        "intermediaryAssignmentList": [
                            "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                            "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                            "995f3b39-1e01-40d4-9368-ee956343e97c"
                        ],
                        "siloAssignmentList": [
                            "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                            "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                            "995f3b39-1e01-40d4-9368-ee956343e97c"
                        ]
                    }
                ]
            },
            "ManagedObject.PrivilegedUser": {
                "title": "Managed User - Privileged",
                "description": "Additional settings that represents a privileged user object. All data in this structure is preserved in the settings engine's permanent storage system.",
                "allOf": [
                    {
                        "$ref": "#/components/schemas/ManagedObject.User"
                    },
                    {
                        "properties": {
                            "deviceAssignmentList": {
                                "type": "array",
                                "description": "List of devices that the privileged users are able to use as endpoints.",
                                "items": {
                                    "type": "string",
                                    "format": "uuid"
                                },
                                "examples": [
                                    [
                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                    ]
                                ]
                            },
                            "generatedPassword": {
                                "description": "The password that was created for the managed user upon managed user creation, this is not stored. This is only available once during user creation. If the password is lost, reset the PWD in Entra ID or have the user perform SSPR.",
                                "examples": [
                                    "GY_w7bZUKRgpIXctD0S2wg"
                                ],
                                "readOnly": true,
                                "type": "string"
                            },
                            "parentId": {
                                "description": "The Entra ID Object ID of the object that the manged user is tied to. This value is only present on privileged users.",
                                "examples": [
                                    "e59a3a64-dc36-4368-80ec-c205eb176ef6"
                                ],
                                "format": "uuid",
                                "maxLength": 36,
                                "minLength": 36,
                                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                "readOnly": true,
                                "type": "string"
                            },
                            "securityClass": {
                                "$ref": "#/components/schemas/SecurityClassList"
                            },
                            "temporaryAccessPass": {
                                "description": "A TAP that was created for the managed user upon managed user creation, this is not stored. This is only available once during user creation. TAP expires at the configured tenant expiration time.",
                                "examples": [
                                    "BCKTSN#E2R&5"
                                ],
                                "readOnly": true,
                                "type": "string"
                            }
                        },
                        "required": [
                            "deviceAssignmentList",
                            "parentId",
                            "securityClass"
                        ],
                        "type": "object"
                    }
                ],
                "examples": [
                    {
                        "creationDate": "2023-10-21T15:24:47.970Z",
                        "displayName": "Example User (Priv)",
                        "firstName": "John",
                        "lastName": "Doe",
                        "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                        "upn": "priv-user@example.com",
                        "securityClass": "Privileged",
                        "uiEducation": false,
                        "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                        "intermediaryAssignmentList": [
                            "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                            "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                            "995f3b39-1e01-40d4-9368-ee956343e97c"
                        ],
                        "siloAssignmentList": [
                            "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                            "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                            "995f3b39-1e01-40d4-9368-ee956343e97c"
                        ],
                        "deviceAssignmentList": [
                            "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                            "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                            "995f3b39-1e01-40d4-9368-ee956343e97c"
                        ],
                        "generatedPassword": "GY_w7bZUKRgpIXctD0S2wg",
                        "parentId": "e59a3a64-dc36-4368-80ec-c205eb176ef6",
                        "temporaryAccessPass": "BCKTSN#E2R&5"
                    }
                ]
            },
            "ObjectPage.Intermediary.Avd": {
                "properties": {
                    "@odata.count": {
                        "type": "number",
                        "examples": [
                            0
                        ]
                    },
                    "@odata.nextLink": {
                        "type": "string",
                        "examples": [
                            "3"
                        ]
                    },
                    "value": {
                        "items": {
                            "allOf": [
                                {
                                    "$ref": "#/components/schemas/ManagedObject.Intermediary"
                                },
                                {
                                    "properties": {
                                        "properties": {
                                            "$ref": "#/components/schemas/ManagedObject.AvdIntermediary"
                                        }
                                    },
                                    "type": "object"
                                }
                            ]
                        },
                        "minItems": 0,
                        "type": "array",
                        "examples": [
                            {
                                "id": "e097a3f5-9599-44a2-8923-fd3276c83ae1",
                                "kind": "AVD",
                                "name": "Legacy Reach Back",
                                "securityClass": "Privileged",
                                "addressRangeCIDR": "172.16.1.0/24",
                                "assignmentGroup": "68873e26-3c35-465c-9422-0884a00beb36",
                                "index": 0,
                                "location": "East US 2",
                                "resourceId": "/subscriptions/742f0d26-daa0-4f84-8d4f-fb052f89f639/resourceGroups/SHIELD_-_PSM-Legacy_Reach_Back/providers/Microsoft.DesktopVirtualization/hostpools/SHIELD_-_PSM-Cluster-Legacy_Reach_Back",
                                "sessionHostGroup": "f99f0918-da9b-4c58-9a8d-9346abc5d9ec",
                                "sessionHostPrefix": "Reach",
                                "vmSku": "Standard_D2s_v5"
                            }
                        ]
                    }
                },
                "examples": [
                    {
                        "@odata.count": 1,
                        "@odata.nextLink": "1",
                        "value": [
                            {
                                "id": "e097a3f5-9599-44a2-8923-fd3276c83ae1",
                                "kind": "AVD",
                                "name": "Legacy Reach Back",
                                "securityClass": "Privileged",
                                "addressRangeCIDR": "172.16.1.0/24",
                                "assignmentGroup": "68873e26-3c35-465c-9422-0884a00beb36",
                                "index": 0,
                                "location": "East US 2",
                                "resourceId": "/subscriptions/742f0d26-daa0-4f84-8d4f-fb052f89f639/resourceGroups/SHIELD_-_PSM-Legacy_Reach_Back/providers/Microsoft.DesktopVirtualization/hostpools/SHIELD_-_PSM-Cluster-Legacy_Reach_Back",
                                "sessionHostGroup": "f99f0918-da9b-4c58-9a8d-9346abc5d9ec",
                                "sessionHostPrefix": "Reach",
                                "vmSku": "Standard_D2s_v5"
                            }
                        ]
                    }
                ],
                "required": [
                    "value"
                ],
                "title": "Page of AVD Intermediary Objects",
                "type": "object"
            },
            "ObjectPage.ManagedDevice": {
                "properties": {
                    "@odata.count": {
                        "type": "number",
                        "examples": [
                            3
                        ]
                    },
                    "@odata.nextLink": {
                        "type": "string",
                        "examples": [
                            "2"
                        ]
                    },
                    "value": {
                        "items": {
                            "oneOf": [
                                {
                                    "$ref": "#/components/schemas/ManagedObject.Device"
                                },
                                {
                                    "$ref": "#/components/schemas/ManagedObject.PrivilegedDevice"
                                }
                            ]
                        },
                        "minItems": 0,
                        "type": "array",
                        "examples": [
                            {
                                "commissionedDate": "2023-02-04T05:06:09.601Z",
                                "displayName": "Priv-01534962354",
                                "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                "parentDeviceId": "81682cf5-0405-491d-8ab8-e07c778d7eaf",
                                "securityClass": "Privileged",
                                "uniqueGroupId": "146964e0-8ca4-4af0-9c2a-894b32912463"
                            },
                            {
                                "commissionedDate": "2023-02-04T05:06:09.601Z",
                                "displayName": "Priv-01534962354",
                                "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                "parentDeviceId": "81682cf5-0405-491d-8ab8-e07c778d7eaf",
                                "uniqueGroupId": "146964e0-8ca4-4af0-9c2a-894b32912463",
                                "groupAssignmentId": "830d8b6f-2f6f-41f7-8800-0c07445abd36",
                                "securityClass": "Privileged",
                                "userAssignmentId": "146964e0-8ca4-4af0-9c2a-894b32912463",
                                "userAssignmentList": [
                                    "56d0d4e1-96f6-4cfb-a5e9-a4ee923169a8",
                                    "94a9d681-a8d2-43eb-a83b-d4bfe90259ff",
                                    "c54d4854-9254-4689-8a22-1cc80a3dae4e"
                                ]
                            }
                        ]
                    }
                },
                "required": [
                    "value"
                ],
                "title": "Page of Managed Device Objects",
                "type": "object",
                "examples": [
                    {
                        "@odata.count": 3,
                        "@odata.nextLink": "2",
                        "value": [
                            {
                                "commissionedDate": "2023-02-04T05:06:09.601Z",
                                "displayName": "Priv-01534962354",
                                "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                "parentDeviceId": "81682cf5-0405-491d-8ab8-e07c778d7eaf",
                                "securityClass": "Privileged",
                                "uniqueGroupId": "146964e0-8ca4-4af0-9c2a-894b32912463"
                            },
                            {
                                "commissionedDate": "2023-02-04T05:06:09.601Z",
                                "displayName": "Priv-01534962354",
                                "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                "parentDeviceId": "81682cf5-0405-491d-8ab8-e07c778d7eaf",
                                "uniqueGroupId": "146964e0-8ca4-4af0-9c2a-894b32912463",
                                "groupAssignmentId": "830d8b6f-2f6f-41f7-8800-0c07445abd36",
                                "securityClass": "Privileged",
                                "userAssignmentId": "146964e0-8ca4-4af0-9c2a-894b32912463",
                                "userAssignmentList": [
                                    "56d0d4e1-96f6-4cfb-a5e9-a4ee923169a8",
                                    "94a9d681-a8d2-43eb-a83b-d4bfe90259ff",
                                    "c54d4854-9254-4689-8a22-1cc80a3dae4e"
                                ]
                            }
                        ]
                    }
                ]
            },
            "ObjectPage.ManagedPrivilegedDevice": {
                "properties": {
                    "@odata.count": {
                        "type": "number"
                    },
                    "@odata.nextLink": {
                        "type": "string"
                    },
                    "value": {
                        "items": {
                            "$ref": "#/components/schemas/ManagedObject.PrivilegedDevice"
                        },
                        "minItems": 0,
                        "type": "array"
                    }
                },
                "required": [
                    "value"
                ],
                "title": "Page of Managed Privileged Device Objects",
                "type": "object"
            },
            "ObjectPage.ManagedUser": {
                "properties": {
                    "@odata.count": {
                        "type": "number",
                        "examples": [
                            3
                        ]
                    },
                    "@odata.nextLink": {
                        "type": "string",
                        "examples": [
                            "2"
                        ]
                    },
                    "value": {
                        "items": {
                            "oneOf": [
                                {
                                    "$ref": "#/components/schemas/ManagedObject.User"
                                },
                                {
                                    "$ref": "#/components/schemas/ManagedObject.PrivilegedUser"
                                }
                            ]
                        },
                        "minItems": 0,
                        "type": "array",
                        "examples": [
                            {
                                "creationDate": "2023-10-21T15:24:47.970Z",
                                "displayName": "Example User (Priv)",
                                "firstName": "John",
                                "lastName": "Doe",
                                "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                "upn": "priv-user@example.com",
                                "securityClass": "Privileged",
                                "uiEducation": false,
                                "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                                "intermediaryAssignmentList": [
                                    "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                    "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                    "995f3b39-1e01-40d4-9368-ee956343e97c"
                                ],
                                "siloAssignmentList": [
                                    "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                    "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                    "995f3b39-1e01-40d4-9368-ee956343e97c"
                                ]
                            },
                            {
                                "creationDate": "2023-10-21T15:24:47.970Z",
                                "displayName": "Example User (Priv)",
                                "firstName": "John",
                                "lastName": "Doe",
                                "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                "upn": "priv-user@example.com",
                                "securityClass": "Privileged",
                                "uiEducation": false,
                                "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                                "intermediaryAssignmentList": [
                                    "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                    "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                    "995f3b39-1e01-40d4-9368-ee956343e97c"
                                ],
                                "siloAssignmentList": [
                                    "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                    "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                    "995f3b39-1e01-40d4-9368-ee956343e97c"
                                ],
                                "deviceAssignmentList": [
                                    "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                    "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                    "995f3b39-1e01-40d4-9368-ee956343e97c"
                                ],
                                "generatedPassword": "GY_w7bZUKRgpIXctD0S2wg",
                                "parentId": "e59a3a64-dc36-4368-80ec-c205eb176ef6",
                                "temporaryAccessPass": "BCKTSN#E2R&5"
                            }
                        ]
                    }
                },
                "required": [
                    "value"
                ],
                "title": "Page of Managed User Objects",
                "type": "object",
                "examples": [
                    {
                        "@odata.count": 3,
                        "@odata.nextLink": "2",
                        "value": [
                            {
                                "creationDate": "2023-10-21T15:24:47.970Z",
                                "displayName": "Example User (Priv)",
                                "firstName": "John",
                                "lastName": "Doe",
                                "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                "upn": "priv-user@example.com",
                                "securityClass": "Privileged",
                                "uiEducation": false,
                                "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                                "intermediaryAssignmentList": [
                                    "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                    "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                    "995f3b39-1e01-40d4-9368-ee956343e97c"
                                ],
                                "siloAssignmentList": [
                                    "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                    "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                    "995f3b39-1e01-40d4-9368-ee956343e97c"
                                ]
                            },
                            {
                                "creationDate": "2023-10-21T15:24:47.970Z",
                                "displayName": "Example User (Priv)",
                                "firstName": "John",
                                "lastName": "Doe",
                                "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                "upn": "priv-user@example.com",
                                "securityClass": "Privileged",
                                "uiEducation": false,
                                "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                                "intermediaryAssignmentList": [
                                    "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                    "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                    "995f3b39-1e01-40d4-9368-ee956343e97c"
                                ],
                                "siloAssignmentList": [
                                    "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                    "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                    "995f3b39-1e01-40d4-9368-ee956343e97c"
                                ],
                                "deviceAssignmentList": [
                                    "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                    "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                    "995f3b39-1e01-40d4-9368-ee956343e97c"
                                ],
                                "generatedPassword": "GY_w7bZUKRgpIXctD0S2wg",
                                "parentId": "e59a3a64-dc36-4368-80ec-c205eb176ef6",
                                "temporaryAccessPass": "BCKTSN#E2R&5"
                            }
                        ]
                    }
                ]
            },
            "ObjectPage.ManagedPrivilegedUser": {
                "properties": {
                    "@odata.count": {
                        "type": "number"
                    },
                    "@odata.nextLink": {
                        "type": "string"
                    },
                    "value": {
                        "items": {
                            "$ref": "#/components/schemas/ManagedObject.PrivilegedUser"
                        },
                        "minItems": 0,
                        "type": "array"
                    }
                },
                "required": [
                    "value"
                ],
                "title": "Page of Managed Privileged User Objects",
                "type": "object"
            },
            "SecurityClassList": {
                "description": "Security class types as described in https://learn.microsoft.com/en-us/security/compass/privileged-access-security-levels.",
                "enum": [
                    "Privileged",
                    "Specialized",
                    "Enterprise",
                    "Unmanaged"
                ],
                "examples": [
                    "Privileged"
                ],
                "title": "Type of security class the object(s) belongs to",
                "type": "string"
            },
            "ArchitectureReport.CorrelationRecord": {
                "description": "Metadata that describes the execution session (run) that is used to tie/relate all of the architecture report together.",
                "examples": [
                    {
                        "auditTenantAccount": "first-user@example.com",
                        "correlationId": "b25f54b3-f30e-4447-9236-24ecac2e9261",
                        "reportTenantAccount": "other-user@example.com",
                        "tenantId": "a7159bdc-678d-4726-901e-cd6d018d46e2",
                        "createdAt": "2025-11-01T00:10:10.821Z",
                        "updatedAt": "2025-12-01T20:10:12.821Z"
                    }
                ],
                "properties": {
                    "auditTenantAccount": {
                        "description": "The user principal name used to authenticate into the tenant being audited.",
                        "examples": [
                            "admin-user@example.com"
                        ],
                        "format": "email",
                        "type": "string"
                    },
                    "correlationId": {
                        "description": "Unique Identifier that represents a single run of architectural analysis. This record is used to identify which architecture report records should be grouped together.",
                        "examples": [
                            "88da2253-758f-4135-9d37-64448c8b65c1"
                        ],
                        "type": "string",
                        "format": "uuid",
                        "maxLength": 36,
                        "minLength": 36,
                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$"
                    },
                    "reportTenantAccount": {
                        "description": "User account used to store/report the architecture report to the SHI Lab cloud service.",
                        "examples": [
                            "generic-user@example.com"
                        ],
                        "format": "email",
                        "type": "string"
                    },
                    "tenantId": {
                        "description": "Unique identifier of the customer tenant that the report was created for.",
                        "examples": [
                            "0e1fe83f-a33f-4250-8546-225b8d45ae01"
                        ],
                        "type": "string",
                        "format": "uuid",
                        "maxLength": 36,
                        "minLength": 36,
                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$"
                    },
                    "createdAt": {
                        "description": "Timestamp when the record was created.",
                        "examples": [
                            "2024-08-01T21:12:22.148Z"
                        ],
                        "format": "date-time",
                        "type": "string"
                    },
                    "updatedAt": {
                        "description": "Timestamp when the record was updated last.",
                        "examples": [
                            "2024-08-01T21:12:22.148Z"
                        ],
                        "format": "date-time",
                        "type": "string"
                    }
                },
                "required": [
                    "auditTenantAccount"
                ],
                "title": "Architecture Report - Correlation Record",
                "type": "object"
            }
        },
        "securitySchemes": {
            "EntraID": {
                "type": "http",
                "scheme": "bearer",
                "bearerFormat": "JWT",
                "description": "The Access Token from Entra ID for the `SHIELD - End User Login` Enterprise App (may need to be created from the App Registration)."
            }
        }
    },
    "externalDocs": {
        "description": "Official Documentation",
        "url": "https://docs.shilab.com"
    },
    "info": {
        "contact": {
            "email": "elliot_huffman@shi.com",
            "name": "SHI - Lab"
        },
        "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.2.1"
    },
    "openapi": "3.1.1",
    "paths": {
        "/Api/Core/SystemRequirements": {
            "get": {
                "description": "Provides a detailed breakdown of if the system requirements are being met for the various components of the SHIELD.",
                "operationId": "/Api/Core/SystemRequirements/Get",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Core.SystemRequirements"
                                },
                                "examples": {
                                    "System Requirement": {
                                        "value": {
                                            "authenticatorPermissions": true,
                                            "azurePermissions": false,
                                            "defendEntitlement": true,
                                            "deployEntitlement": false,
                                            "discoverEntitlement": true,
                                            "msGraphPermissions": false,
                                            "dataGatewayPermissions": false,
                                            "entraDirectoryRole": false
                                        },
                                        "summary": "Example System Requirement Object Returned From the API Endpoint",
                                        "description": "An example that indicates: <br/> - Azure RBAC assignment(s) are not present. <br/> - SHIELD Defend licenses are present. <br/> - SHIELD Deploy licenses are present. <br/> - SHIELD Discover licenses are present. <br/> - Permissions for the Microsoft Graph API have not been configured properly. <br/> - Permissions for the SHI - Data Gateway have not been configured properly. <br/> - Permissions for Entra Directory Role assignment have not been configured properly."
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "Core"
                ],
                "security": [],
                "summary": "Indicates If the System Requirements Are Met or Not."
            }
        },
        "/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.",
                "operationId": "/Api/Auth/Id/Get",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "properties": {
                                        "appId": {
                                            "description": "Application ID that should be used in Access Tokens as the audience and the endpoint necessary for auth code flows.",
                                            "type": "string",
                                            "format": "uuid",
                                            "examples": [
                                                "85cbe72b-3215-48bc-9eeb-fa7896c31498"
                                            ]
                                        },
                                        "tenantId": {
                                            "description": "Tenant ID necessary for authority host URL configuration and UI customization.",
                                            "type": "string",
                                            "format": "uuid",
                                            "examples": [
                                                "3fa85f64-5717-4562-b3fc-2c963f66afa6"
                                            ]
                                        }
                                    },
                                    "type": "object",
                                    "required": [
                                        "appId",
                                        "tenantId"
                                    ]
                                },
                                "examples": {
                                    "valid request": {
                                        "value": {
                                            "appId": "85cbe72b-3215-48bc-9eeb-fa7896c31498",
                                            "tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
                                        },
                                        "summary": "Example Request Object",
                                        "description": "An example request object to retrieve the IDs required to authenticate."
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "tags": [
                    "Authentication"
                ],
                "security": [],
                "summary": "Retrieves the IDs Required to Authenticate."
            }
        },
        "/Api/Auth/Authenticator": {
            "get": {
                "summary": "Provides Attestation for Authenticator App",
                "description": "Provides the attestation to the authenticator that this endpoint is authorized for receiving credentials from the authenticator.\n\nThis endpoint requires the `Authentication.Actions.Attest`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Auth/Authenticator/GetAttest",
                "responses": {
                    "200": {
                        "content": {
                            "text/plain": {
                                "schema": {
                                    "description": "Access token that SHIELD uses to prove it is a valid recipient of credentials.",
                                    "type": "string",
                                    "examples": [
                                        "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6Ik1jN2wzSXo5M2c3dXdnTmVFbW13X1dZR1BrbyJ9.eyJhdWQiOiJjYjU5ZjIyOC0wNjkwLTRhY2ItOWE3Yi0wMGMzNmEyZjRlOGQiLCJpc3MiOiJodHRwczovL2xvZ2luLm1pY3Jvc29mdG9ubGluZS5jb20vMmQxMDJkYTktZDExZS00YTgwLTkwMjItYzQxOGZhNDg1NGM3L3YyLjAiLCJpYXQiOjE3MjczNjgzODQsIm5iZiI6MTcyNzM2ODM4NCwiZXhwIjoxNzI3MzcyMjg0LCJhaW8iOiJBU1FBMi84WUFBQUFSN0hyaW5XTmRwcisvdnoreWlkZER6WVExeFRpc3BSZGY4TG1XNjhRaE0wPSIsImF6cCI6IjRlODU5MTQ2LWY5M2UtNDlmMi05ODZmLWI3MjIyNmZjZDViOSIsImF6cGFjciI6IjEiLCJvaWQiOiJlMmRlNzQ0ZC1hZjVlLTQ4NDEtYmI4Zi02OTRkZDI1ZmVmNGQiLCJyaCI6IjAuQWNvQXFTMFFMUjdSZ0VxUUlzUVkta2hVeHlqeVdjdVFCc3RLbW5zQXcyb3ZUbzM2QUFBLiIsInJvbGVzIjpbIkF1dGhlbnRpY2F0b3IuQXR0ZXN0Il0sInN1YiI6ImUyZGU3NDRkLWFmNWUtNDg0MS1iYjhmLTY5NGRkMjVmZWY0ZCIsInRpZCI6IjJkMTAyZGE5LWQxMWUtNGE4MC05MDIyLWM0MThmYTQ4NTRjNyIsInV0aSI6Il9MaUdVWWxmS2txNFZoR09NeGw4QUEiLCJ2ZXIiOiIyLjAifQ.xlXZfOnDoOVW3_aOiSIZH8uiySeohro-HVnDzDEff2EjmOk9adrTOP5Sw1av6g3vy38r6dSu4tViwNGrb7Z2krgRKKvp-4A9rkPqeJjjd2rhFl2KiOlxL0mmykbroZZ70RJzwHy2GC7wfuLwJwr-5m7POV2grbxIAlTsMdZWDFXYi-AahfDVtLugarWG5-tXAqiPBKjaU6ntAJIbu7Ol1vYZaeYMsNKTs8O1P10YM460zN9OkfoI1gV7_InHEr8RSyQnEPCJ2W1Or4lDhqdey4ohMoP9EzLgMsn9Ckss5g5C6vVE0GQawUoeGozPOBpgb31J8JzZUyB1JyVfi-vKkQ"
                                    ]
                                },
                                "examples": {
                                    "valid access token": {
                                        "value": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6Ik1jN2wzSXo5M2c3dXdnTmVFbW13X1dZR1BrbyJ9.eyJhdWQiOiJjYjU5ZjIyOC0wNjkwLTRhY2ItOWE3Yi0wMGMzNmEyZjRlOGQiLCJpc3MiOiJodHRwczovL2xvZ2luLm1pY3Jvc29mdG9ubGluZS5jb20vMmQxMDJkYTktZDExZS00YTgwLTkwMjItYzQxOGZhNDg1NGM3L3YyLjAiLCJpYXQiOjE3MjczNjgzODQsIm5iZiI6MTcyNzM2ODM4NCwiZXhwIjoxNzI3MzcyMjg0LCJhaW8iOiJBU1FBMi84WUFBQUFSN0hyaW5XTmRwcisvdnoreWlkZER6WVExeFRpc3BSZGY4TG1XNjhRaE0wPSIsImF6cCI6IjRlODU5MTQ2LWY5M2UtNDlmMi05ODZmLWI3MjIyNmZjZDViOSIsImF6cGFjciI6IjEiLCJvaWQiOiJlMmRlNzQ0ZC1hZjVlLTQ4NDEtYmI4Zi02OTRkZDI1ZmVmNGQiLCJyaCI6IjAuQWNvQXFTMFFMUjdSZ0VxUUlzUVkta2hVeHlqeVdjdVFCc3RLbW5zQXcyb3ZUbzM2QUFBLiIsInJvbGVzIjpbIkF1dGhlbnRpY2F0b3IuQXR0ZXN0Il0sInN1YiI6ImUyZGU3NDRkLWFmNWUtNDg0MS1iYjhmLTY5NGRkMjVmZWY0ZCIsInRpZCI6IjJkMTAyZGE5LWQxMWUtNGE4MC05MDIyLWM0MThmYTQ4NTRjNyIsInV0aSI6Il9MaUdVWWxmS2txNFZoR09NeGw4QUEiLCJ2ZXIiOiIyLjAifQ.xlXZfOnDoOVW3_aOiSIZH8uiySeohro-HVnDzDEff2EjmOk9adrTOP5Sw1av6g3vy38r6dSu4tViwNGrb7Z2krgRKKvp-4A9rkPqeJjjd2rhFl2KiOlxL0mmykbroZZ70RJzwHy2GC7wfuLwJwr-5m7POV2grbxIAlTsMdZWDFXYi-AahfDVtLugarWG5-tXAqiPBKjaU6ntAJIbu7Ol1vYZaeYMsNKTs8O1P10YM460zN9OkfoI1gV7_InHEr8RSyQnEPCJ2W1Or4lDhqdey4ohMoP9EzLgMsn9Ckss5g5C6vVE0GQawUoeGozPOBpgb31J8JzZUyB1JyVfi-vKkQ",
                                        "summary": "Example Valid Access Token",
                                        "description": "An example string that represents the access token that SHIELD uses to prove it is a valid recipient of credentials."
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "Authentication"
                ]
            }
        },
        "/Api/Auth/Authenticator/Cache/Status": {
            "get": {
                "summary": "Indicates If SHIELD Is Waiting for Any Credentials.",
                "description": "Provides a breakdown view of if SHIELD is waiting for any specific type of credential or credentials.\n\nThis endpoint requires the `Authentication.Read`, `Authentication.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Auth/Authenticator/Cache/Status/Get",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "examples": {
                                    "Waiting on Nothing": {
                                        "summary": "Not Waiting for Credentials",
                                        "description": "No credentials are being requested at the moment.",
                                        "value": {
                                            "accessToken": false,
                                            "sccAuth": false
                                        }
                                    },
                                    "Waiting on Access Token": {
                                        "summary": "Waiting on Access Token",
                                        "description": "Waiting on an Access Token with the Audience of the Legacy Windows Graph API.",
                                        "value": {
                                            "accessToken": {
                                                "audience": "00000002-0000-0000-c000-000000000000"
                                            },
                                            "sccAuth": false
                                        }
                                    },
                                    "Waiting on SccAuth": {
                                        "summary": "Waiting on SCC Auth Data",
                                        "description": "Waiting on an SCC Auth data from the SHIELD - Authenticator App.",
                                        "value": {
                                            "accessToken": false,
                                            "sccAuth": true
                                        }
                                    }
                                },
                                "schema": {
                                    "$ref": "#/components/schemas/Authenticator.RequestStatus"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "Authentication"
                ]
            }
        },
        "/Api/Auth/Authenticator/Cache/SccAuth": {
            "post": {
                "description": "Configure SHIELD to use the specific SCC Auth credentials from the authenticator app to run web requests on behalf of the end user.\n\nThis endpoint requires the `Authentication.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Auth/Authenticator/Cache/SccAuth/Post",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Authenticator.Container.SccAuthCredentials"
                            },
                            "examples": {
                                "valid Scc Auth credentials": {
                                    "value": {
                                        "authenticatedUpn": "user@example.com",
                                        "security": {
                                            "sccAuth": "54BKPtTL-eSMFp5cqYTMMSblm2U80cUJqQgmbe4f_sRn4ammMmU1NKNurn9HqpsUtS4FrMJRTKa3Or_pFbedM_57R0fVBfNJ-m2Pvey9OweWIDradzT0dB1WnufPTJiT2y7zSQy91Y9wJIn1_aY5q-MNh75qwjM84Dng-mYzbd9KqUfyPUolOo-j-... (Truncated)",
                                            "xsrf": "PEDwTvWdm2qSTe-n8h-1praK4OcQK1ELTJ08DWYqBRzQiyA2MIuEKEMNLu4ExjDNpAOUnAxmsqOeuGzb82MJYkegOE6hW8BzpSM6k9nbTbJ4yjNGzMSQvWUnyqrBvGa8JfSRiSeaKdXGBnxGd90Spw2:... (truncated)"
                                        },
                                        "purview": {
                                            "sccAuth": "54BKPtTL-eSMFp5cqYTMMSblm2U80cUJqQgmbe4f_sRn4ammMmU1NKNurn9HqpsUtS4FrMJRTKa3Or_pFbedM_57R0fVBfNJ-m2Pvey9OweWIDradzT0dB1WnufPTJiT2y7zSQy91Y9wJIn1_aY5q-MNh75qwjM84Dng-mYzbd9KqUfyPUolOo-j-... (Truncated)",
                                            "xsrf": "PEDwTvWdm2qSTe-n8h-1praK4OcQK1ELTJ08DWYqBRzQiyA2MIuEKEMNLu4ExjDNpAOUnAxmsqOeuGzb82MJYkegOE6hW8BzpSM6k9nbTbJ4yjNGzMSQvWUnyqrBvGa8JfSRiSeaKdXGBnxGd90Spw2:... (truncated)"
                                        },
                                        "expiration": "2024-09-26T18:16:29.340Z",
                                        "defender": {
                                            "sccAuth": "54BKPtTL-eSMFp5cqYTMMSblm2U80cUJqQgmbe4f_sRn4ammMmU1NKNurn9HqpsUtS4FrMJRTKa3Or_pFbedM_57R0fVBfNJ-m2Pvey9OweWIDradzT0dB1WnufPTJiT2y7zSQy91Y9wJIn1_aY5q-MNh75qwjM84Dng-mYzbd9KqUfyPUolOo-j-... (Truncated)",
                                            "xsrf": "PEDwTvWdm2qSTe-n8h-1praK4OcQK1ELTJ08DWYqBRzQiyA2MIuEKEMNLu4ExjDNpAOUnAxmsqOeuGzb82MJYkegOE6hW8BzpSM6k9nbTbJ4yjNGzMSQvWUnyqrBvGa8JfSRiSeaKdXGBnxGd90Spw2:... (truncated)"
                                        }
                                    },
                                    "summary": "Example SCC Auth Credentials",
                                    "description": "An example of valid Scc Auth credentials used to configure SHIELD."
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "204": {
                        "description": "Credential was successfully stored"
                    }
                },
                "summary": "Provide Your SHIELD Authenticator Credentials - SCC Auth",
                "tags": [
                    "Authentication"
                ]
            }
        },
        "/Api/Auth/Authenticator/Cache/AccessToken": {
            "post": {
                "summary": "Provide Your SHIELD Authenticator Credentials - Access Token",
                "description": "Configure SHIELD to use the specific Access Token credentials from the authenticator app to run web requests on behalf of the end user.\n\nThis endpoint requires the `Authentication.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Auth/Authenticator/Cache/AccessToken/Post",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "description": "Access Token to be stored in the SHIELD authentication engine.",
                                "type": "object",
                                "properties": {
                                    "token": {
                                        "description": "This is transmitted as a property instead of a raw string as the body parser ignores it in Express.JS. Functionally identical though.",
                                        "type": "string",
                                        "examples": [
                                            "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6Ik1jN2wzSXo5M2c3dXdnTmVFbW13X1dZR1BrbyJ9.eyJhdWQiOiI0YzQwMjgxYi1hMzA1LTRhYWYtOTBhNC1kNWJiZWU2ZWI4ZWQiLCJpc3MiOiJodHRwczovL2xvZ2luLm1pY3Jvc29mdG9ubGluZS5jb20vMmQxMDJkYTktZDExZS00YTgwLTkwMjItYzQxOGZhNDg1NGM3L3YyLjAiLCJpYXQiOjE3MjczNzUzNzMsIm5iZiI6MTcyNzM3NTM3MywiZXhwIjoxNzI3Mzc5MjczLCJhaW8iOiJrMkJnWU9BM1ByL2lTc2loRmYzeU9uVk40UTZOc1dsZnRnWEhoMW5HYm5saWVuS1hRZ2tBIiwiYXpwIjoiNGU4NTkxNDYtZjkzZS00OWYyLTk4NmYtYjcyMjI2ZmNkNWI5IiwiYXpwYWNyIjoiMSIsIm9pZCI6ImUyZGU3NDRkLWFmNWUtNDg0MS1iYjhmLTY5NGRkMjVmZWY0ZCIsInJoIjoiMC5BY29BcVMwUUxSN1JnRXFRSXNRWS1raFV4eHNvUUV3Rm82OUtrS1RWdS01dXVPMzZBQUEuIiwicm9sZXMiOlsiVGVsZW1ldHJ5LlNvcC5SZWFkV3JpdGUiLCJMaWNlbnNlUmVwb3J0LlJlYWRXcml0ZSJdLCJzdWIiOiJlMmRlNzQ0ZC1hZjVlLTQ4NDEtYmI4Zi02OTRkZDI1ZmVmNGQiLCJ0aWQiOiIyZDEwMmRhOS1kMTFlLTRhODAtOTAyMi1jNDE4ZmE0ODU0YzciLCJ1dGkiOiJfTGlHVVlsZktrcTRWaEdPXzNpRkFBIiwidmVyIjoiMi4wIn0.CZMOfyo5Lo1Km8bgWtOw8f30n1AZ5HJQ-StyIPr_P_eEjanzHVSEiRsHweNATW0GQFfLs0lGH43xztFcNNepu7CctyEzoktJ-9De2mMLIMJviF1rlB19mxH3a3hUSPZuPeYPPONkYtjL4fZj0mCYcALoq-orc0Oswg0l3fatbS7a-DAgxZdLHa6M7OtXksMlMXwooxmocOQeg_zhpko1zyuzSsVwNrz1uMZYpivwaM1ImWZiqgjMc1NWCN2Co1nYNuvxg6Chcr0OOsPRaXayfzrP7IlsZIg5Itg9lrqN0cjT3t8GSejL2P8HmfPcYftlqOobCesjSfBthir5hGUoNA"
                                        ]
                                    }
                                },
                                "examples": [
                                    {
                                        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6Ik1jN2wzSXo5M2c3dXdnTmVFbW13X1dZR1BrbyJ9.eyJhdWQiOiI0YzQwMjgxYi1hMzA1LTRhYWYtOTBhNC1kNWJiZWU2ZWI4ZWQiLCJpc3MiOiJodHRwczovL2xvZ2luLm1pY3Jvc29mdG9ubGluZS5jb20vMmQxMDJkYTktZDExZS00YTgwLTkwMjItYzQxOGZhNDg1NGM3L3YyLjAiLCJpYXQiOjE3MjczNzUzNzMsIm5iZiI6MTcyNzM3NTM3MywiZXhwIjoxNzI3Mzc5MjczLCJhaW8iOiJrMkJnWU9BM1ByL2lTc2loRmYzeU9uVk40UTZOc1dsZnRnWEhoMW5HYm5saWVuS1hRZ2tBIiwiYXpwIjoiNGU4NTkxNDYtZjkzZS00OWYyLTk4NmYtYjcyMjI2ZmNkNWI5IiwiYXpwYWNyIjoiMSIsIm9pZCI6ImUyZGU3NDRkLWFmNWUtNDg0MS1iYjhmLTY5NGRkMjVmZWY0ZCIsInJoIjoiMC5BY29BcVMwUUxSN1JnRXFRSXNRWS1raFV4eHNvUUV3Rm82OUtrS1RWdS01dXVPMzZBQUEuIiwicm9sZXMiOlsiVGVsZW1ldHJ5LlNvcC5SZWFkV3JpdGUiLCJMaWNlbnNlUmVwb3J0LlJlYWRXcml0ZSJdLCJzdWIiOiJlMmRlNzQ0ZC1hZjVlLTQ4NDEtYmI4Zi02OTRkZDI1ZmVmNGQiLCJ0aWQiOiIyZDEwMmRhOS1kMTFlLTRhODAtOTAyMi1jNDE4ZmE0ODU0YzciLCJ1dGkiOiJfTGlHVVlsZktrcTRWaEdPXzNpRkFBIiwidmVyIjoiMi4wIn0.CZMOfyo5Lo1Km8bgWtOw8f30n1AZ5HJQ-StyIPr_P_eEjanzHVSEiRsHweNATW0GQFfLs0lGH43xztFcNNepu7CctyEzoktJ-9De2mMLIMJviF1rlB19mxH3a3hUSPZuPeYPPONkYtjL4fZj0mCYcALoq-orc0Oswg0l3fatbS7a-DAgxZdLHa6M7OtXksMlMXwooxmocOQeg_zhpko1zyuzSsVwNrz1uMZYpivwaM1ImWZiqgjMc1NWCN2Co1nYNuvxg6Chcr0OOsPRaXayfzrP7IlsZIg5Itg9lrqN0cjT3t8GSejL2P8HmfPcYftlqOobCesjSfBthir5hGUoNA"
                                    }
                                ]
                            },
                            "examples": {
                                "Valid request body": {
                                    "value": {
                                        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6Ik1jN2wzSXo5M2c3dXdnTmVFbW13X1dZR1BrbyJ9.eyJhdWQiOiI0YzQwMjgxYi1hMzA1LTRhYWYtOTBhNC1kNWJiZWU2ZWI4ZWQiLCJpc3MiOiJodHRwczovL2xvZ2luLm1pY3Jvc29mdG9ubGluZS5jb20vMmQxMDJkYTktZDExZS00YTgwLTkwMjItYzQxOGZhNDg1NGM3L3YyLjAiLCJpYXQiOjE3MjczNzUzNzMsIm5iZiI6MTcyNzM3NTM3MywiZXhwIjoxNzI3Mzc5MjczLCJhaW8iOiJrMkJnWU9BM1ByL2lTc2loRmYzeU9uVk40UTZOc1dsZnRnWEhoMW5HYm5saWVuS1hRZ2tBIiwiYXpwIjoiNGU4NTkxNDYtZjkzZS00OWYyLTk4NmYtYjcyMjI2ZmNkNWI5IiwiYXpwYWNyIjoiMSIsIm9pZCI6ImUyZGU3NDRkLWFmNWUtNDg0MS1iYjhmLTY5NGRkMjVmZWY0ZCIsInJoIjoiMC5BY29BcVMwUUxSN1JnRXFRSXNRWS1raFV4eHNvUUV3Rm82OUtrS1RWdS01dXVPMzZBQUEuIiwicm9sZXMiOlsiVGVsZW1ldHJ5LlNvcC5SZWFkV3JpdGUiLCJMaWNlbnNlUmVwb3J0LlJlYWRXcml0ZSJdLCJzdWIiOiJlMmRlNzQ0ZC1hZjVlLTQ4NDEtYmI4Zi02OTRkZDI1ZmVmNGQiLCJ0aWQiOiIyZDEwMmRhOS1kMTFlLTRhODAtOTAyMi1jNDE4ZmE0ODU0YzciLCJ1dGkiOiJfTGlHVVlsZktrcTRWaEdPXzNpRkFBIiwidmVyIjoiMi4wIn0.CZMOfyo5Lo1Km8bgWtOw8f30n1AZ5HJQ-StyIPr_P_eEjanzHVSEiRsHweNATW0GQFfLs0lGH43xztFcNNepu7CctyEzoktJ-9De2mMLIMJviF1rlB19mxH3a3hUSPZuPeYPPONkYtjL4fZj0mCYcALoq-orc0Oswg0l3fatbS7a-DAgxZdLHa6M7OtXksMlMXwooxmocOQeg_zhpko1zyuzSsVwNrz1uMZYpivwaM1ImWZiqgjMc1NWCN2Co1nYNuvxg6Chcr0OOsPRaXayfzrP7IlsZIg5Itg9lrqN0cjT3t8GSejL2P8HmfPcYftlqOobCesjSfBthir5hGUoNA"
                                    },
                                    "summary": "Example Request Body",
                                    "description": "An example object that represents the request body to be sent to the API endpoint."
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "204": {
                        "description": "Credential was successfully stored"
                    },
                    "400": {
                        "description": "Invalid Access Token"
                    }
                },
                "tags": [
                    "Authentication"
                ]
            }
        },
        "/Api/Update": {
            "get": {
                "summary": "Checks if an Update Is Pending",
                "description": "Provides the state of the update engine. Where `true` means there is an update detected and `false` means there isn't an update available. This endpoint is available to all authorization levels.",
                "operationId": "/Api/Update/Get",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "boolean",
                                    "examples": [
                                        true
                                    ]
                                },
                                "examples": {
                                    "Example value": {
                                        "summary": "Example Value",
                                        "description": "An example boolean value that represents an update to SHIELD is pending.",
                                        "value": true
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "Update"
                ]
            }
        },
        "/Api/Update/Check": {
            "get": {
                "summary": "Checks for a New Version",
                "description": "Checks with data gateway and compares the reported version to the version that is locally installed. If there is a difference, a new update is marked as available. Always returns the latest version available on data gateway, even if that version is installed locally.\n\nThis endpoint requires the `Update.Read`, `Update.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Update/Check/Get",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "properties": {
                                        "appVersion": {
                                            "description": "Follows symantec versioning as laid out here: https://semver.org/. This number is the version of the application package.",
                                            "examples": [
                                                "1.2.3"
                                            ],
                                            "type": "string"
                                        }
                                    },
                                    "type": "object",
                                    "examples": [
                                        {
                                            "appVersion": "1.2.3"
                                        }
                                    ]
                                },
                                "examples": {
                                    "Example response": {
                                        "summary": "Example Reported SHIELD Version",
                                        "description": "An example of latest semantic version of the SHIELD available.",
                                        "value": {
                                            "appVersion": "1.2.3"
                                        }
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "Update"
                ]
            }
        },
        "/Api/Update/Check/Channel/{Update Channel Name}": {
            "get": {
                "summary": "Checks for a New Version in Channel",
                "description": "Checks with the SHI Data Gateway in the specified update channel and compares the reported version to the version that is locally installed. If there is a difference, a new update is marked as available. Always returns the latest version available on data gateway, even if that version is installed locally.\n\nThis endpoint requires the `Update.Read`, `Update.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Update/Check/Channel/UpdateChannelName/Get",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/updateChannelName"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "properties": {
                                        "appVersion": {
                                            "description": "Follows symantec versioning as laid out here: https://semver.org/. This number is the version of the application package.",
                                            "examples": [
                                                "1.2.3"
                                            ],
                                            "type": "string"
                                        }
                                    },
                                    "type": "object",
                                    "examples": [
                                        {
                                            "appVersion": "1.2.3"
                                        }
                                    ]
                                },
                                "examples": {
                                    "SHIELD version": {
                                        "summary": "Example Semantic Version",
                                        "description": "An example string that represents the latest semantic version of SHIELD available in specific channel.",
                                        "value": {
                                            "appVersion": "1.2.3"
                                        }
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "Update"
                ]
            }
        },
        "/Api/Update/Install": {
            "post": {
                "summary": "Installs SHIELD Core Update",
                "description": "Installs the latest version that is available from SHI Data Gateway. Even if that version is the same that is installed.\n\nThis endpoint requires the `Update.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Update/Install/Post",
                "responses": {
                    "204": {
                        "description": "OK: Update Submitted to Azure"
                    }
                },
                "tags": [
                    "Update"
                ]
            }
        },
        "/Api/Update/Install/Channel/{Update Channel Name}": {
            "post": {
                "summary": "Installs SHIELD Core Update from Channel",
                "description": "Installs the latest version that is available from SHI Data Gateway in the specified channel. Even if that version is the same that is installed.\n\nThis endpoint requires the `Update.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Update/Install/Channel/UpdateChannelName/Post",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/updateChannelName"
                    }
                ],
                "responses": {
                    "204": {
                        "description": "OK: Update Submitted to Azure"
                    }
                },
                "tags": [
                    "Update"
                ]
            }
        },
        "/Api/Update/Upload": {
            "post": {
                "summary": "Uploads Custom Update Package",
                "description": "THIS API SHOULD ONLY BE USED IF INSTRUCTED BY SHI EMPLOYEES!\n\nUploads the specified ZIP package, validates signature and installs it if it matches. This ignores version numbers and will allow you to install the same version again if necessary.\n\nThis endpoint requires the `Update.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Update/Upload/Post",
                "requestBody": {
                    "content": {
                        "application/octet-stream": {
                            "schema": {
                                "type": "string",
                                "format": "binary"
                            }
                        }
                    }
                },
                "responses": {
                    "204": {
                        "description": "OK: Update Submitted to Azure"
                    }
                },
                "tags": [
                    "Update"
                ]
            }
        },
        "/Api/Discover/Status": {
            "get": {
                "summary": "Returns State of the Discover Module",
                "description": "Provides a detailed breakdown of the current state of the discover module and it progress.\n\nThis endpoint requires the `Discover.Read`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Discover/Status/Get",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Discover.ExecutionStatus"
                                },
                                "examples": {
                                    "Execution Status": {
                                        "value": {
                                            "running": true
                                        },
                                        "summary": "Example Execution Status",
                                        "description": "An example execution status object that indicates a SHIELD Discover run is already in progress."
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "Discover"
                ]
            }
        },
        "/Api/Discover/Progress": {
            "get": {
                "summary": "Returns Current Execution Progress of the Discover Module",
                "description": "Provides a detailed breakdown of the current progress of the discover module and it progress.\n\nThis endpoint requires the `Discover.Read`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Discover/Progress/Get",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Core.ProgressBar"
                                },
                                "examples": {
                                    "Progress Bar": {
                                        "value": {
                                            "childBar": [],
                                            "description": "Collecting data from the Microsoft Entra ID system.",
                                            "displayName": "Running Entra ID Plugin",
                                            "id": "b759230f-48cb-496e-ad57-5f079083226b",
                                            "currentStep": 5,
                                            "totalStepCount": 7
                                        },
                                        "summary": "Example Progress Bar Object",
                                        "description": "An example progress bar object returned from the endpoint. It indicates: <br/> - The purpose of a progress bar. <br/> - The text label of a progress bar. <br/> - The unique identifier in type UUID of a specific SHIELD instance for search. <br/> - The total number of steps of a progress bar. <br/> - The current step/value of a progress bar. <br/> - No child progress bar."
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "Discover"
                ]
            }
        },
        "/Api/Discover/Report": {
            "get": {
                "summary": "Starts Discover's Report Generation",
                "description": "Starts the Discover module's report collection engine to create a license report and upload it to the data gateway.\n\nThis endpoint requires the `Discover.Action.Run`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Discover/Report/Start",
                "responses": {
                    "202": {
                        "$ref": "#/components/responses/202"
                    },
                    "409": {
                        "$ref": "#/components/responses/409"
                    }
                },
                "tags": [
                    "Discover"
                ]
            }
        },
        "/Api/Discover/LicenseReport/Correlation": {
            "get": {
                "description": "Retrieves the list of correlation records for the authenticated tenant. Correlation records store the metadata for a specific license report.\n\nThis endpoint requires the `Discover.Read`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Discover/LicenseReport/Correlation/Get",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "examples": {
                                    "anything": {
                                        "description": "Sample list of correlation records for the authenticated tenant.",
                                        "summary": "Available Correlation Records",
                                        "value": [
                                            {
                                                "auditTenantAccount": "somebodyThatI@example.com",
                                                "correlationId": "6d7c9271-9e68-4bdf-9ae3-f90c4213f74b",
                                                "reportTenantAccount": "usedToKnow@example.com",
                                                "tenantId": "3d6e7b7e-8d9a-4eb0-8753-67829b3934db",
                                                "createdAt": "2024-08-01T21:14:45.026Z",
                                                "updatedAt": "2024-08-01T21:14:45.026Z"
                                            },
                                            {
                                                "auditTenantAccount": "somebodyThatI@example.com",
                                                "correlationId": "d8095827-a313-40e1-b086-f72636de0edf",
                                                "reportTenantAccount": "usedToKnow@example.com",
                                                "tenantId": "3d6e7b7e-8d9a-4eb0-8753-67829b3934db",
                                                "createdAt": "2024-07-25T21:14:45.026Z",
                                                "updatedAt": "2024-07-25T21:14:45.026Z"
                                            }
                                        ]
                                    }
                                },
                                "schema": {
                                    "type": "array",
                                    "minItems": 0,
                                    "items": {
                                        "$ref": "#/components/schemas/LicenseReport.CorrelationRecord"
                                    },
                                    "examples": [
                                        [
                                            {
                                                "auditTenantAccount": "somebodyThatI@example.com",
                                                "correlationId": "6d7c9271-9e68-4bdf-9ae3-f90c4213f74b",
                                                "reportTenantAccount": "usedToKnow@example.com",
                                                "tenantId": "3d6e7b7e-8d9a-4eb0-8753-67829b3934db",
                                                "createdAt": "2024-08-01T21:14:45.026Z",
                                                "updatedAt": "2024-08-01T21:14:45.026Z"
                                            },
                                            {
                                                "auditTenantAccount": "somebodyThatI@example.com",
                                                "correlationId": "d8095827-a313-40e1-b086-f72636de0edf",
                                                "reportTenantAccount": "usedToKnow@example.com",
                                                "tenantId": "3d6e7b7e-8d9a-4eb0-8753-67829b3934db",
                                                "createdAt": "2024-07-25T21:14:45.026Z",
                                                "updatedAt": "2024-07-25T21:14:45.026Z"
                                            }
                                        ]
                                    ]
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "403": {
                        "$ref": "#/components/responses/403"
                    }
                },
                "tags": [
                    "Discover"
                ],
                "summary": "Retrieve the List of License Report Correlation Records"
            }
        },
        "/Api/Discover/LicenseReport/Correlation/{correlationId}/Data": {
            "get": {
                "description": "Retrieves the full license report for the specified correlation ID in the authenticated tenant. The license report contains all of the license usage and compliance information with the required correlation data.\n\nThis endpoint requires the `Discover.Read`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Discover/LicenseReport/Correlation/:correlationId/Data/Get",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/correlationId"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "examples": {
                                    "License Report": {
                                        "description": "Sample, truncated report from an example customer environment.",
                                        "summary": "Example License Report",
                                        "value": {
                                            "availableLicense": [
                                                {
                                                    "id": "7e2b1c8e-4f3a-4b2e-9c1d-8a7f6e5d4c3b",
                                                    "count": 1500,
                                                    "servicePlanList": [
                                                        "2a1f4b7c-8e3d-4c2a-9b5e-7d6f1a2b3c4d",
                                                        "9c8b7a6d-5e4f-3a2b-1c0d-8e7f6a5b4c3d"
                                                    ]
                                                }
                                            ],
                                            "correlation": {
                                                "auditTenantAccount": "priv-user@example.com",
                                                "correlationId": "9d838115-0868-45d4-b8a5-98adc1af7e42",
                                                "reportTenantAccount": "ent-user@example.com",
                                                "tenantId": "7e536189-b2dd-4c8b-98b1-9b174777883f",
                                                "createdAt": "2024-08-01T21:13:12.821Z",
                                                "updatedAt": "2024-08-01T21:13:12.821Z"
                                            },
                                            "principalData": {
                                                "device": {
                                                    "2d7e3c4a-1b8f-4e2d-9c1a-5f6a7b8e3c2d": {
                                                        "assignedService": {
                                                            "9c1e4b7a-5d2f-4e3b-8a1c-6f2b7e3c1d4a": {
                                                                "Conditional Access": false,
                                                                "Access Review": true,
                                                                "Entitlement Management": false,
                                                                "Identity Protection": true
                                                            },
                                                            "2a7e3c4d-1b8f-4e2a-9c1d-5f6a7b8e2c3d": 10
                                                        },
                                                        "assignedLicense": [
                                                            {
                                                                "id": "1f4e2b7a-3c8d-4e1a-9b2c-7d6e5f3a2b1c",
                                                                "servicePlanList": [
                                                                    "5a7c3e2d-1b9f-4d2a-8c1e-6f3b7e2a4d5c",
                                                                    "8e1c2a3d-4b7f-4e2c-9a1d-5f6b7c8e2d3a"
                                                                ]
                                                            }
                                                        ],
                                                        "consumedService": {
                                                            "7e2e1c7b-2b6e-4e7a-8c1a-2e7b8e1c2a3f": {
                                                                "Conditional Access": true,
                                                                "Access Review": false,
                                                                "Entitlement Management": false,
                                                                "Identity Protection": true
                                                            },
                                                            "3f8b2e1d-4c7a-4e2b-9d1a-7e2b3c4d5f6a": null
                                                        },
                                                        "principalMetadata": {
                                                            "sharedComputer": false
                                                        }
                                                    }
                                                },
                                                "user": {
                                                    "7a2e3c4d-1b9f-4e2a-8c1d-6f2b7e3a4d5c": {
                                                        "assignedService": {
                                                            "3a7e2c4d-1b9f-4e2a-8c1d-6f2b7e3c4d5a": {
                                                                "Conditional Access": false,
                                                                "Access Review": true,
                                                                "Entitlement Management": false,
                                                                "Identity Protection": true
                                                            },
                                                            "7b2e1c4d-3a8f-4e2b-9d1a-6f3c7e2a4d5b": null
                                                        },
                                                        "assignedLicense": [
                                                            {
                                                                "id": "4e2b7a1c-3d8f-4e2a-9c1d-5f6a7b8e2c3d",
                                                                "servicePlanList": [
                                                                    "6f2a3c4d-1b7e-4e2c-8a1d-5f3b7e2a4d6c",
                                                                    "9c1d2a3e-4b7f-4e2c-8a1d-5f6b7c8e2d3a"
                                                                ]
                                                            }
                                                        ],
                                                        "consumedService": {
                                                            "2a7e3c4d-1b8f-4e2a-9c1d-5f6a7b8e2c3d": {
                                                                "Conditional Access": true,
                                                                "Access Review": false,
                                                                "Entitlement Management": false,
                                                                "Identity Protection": true
                                                            },
                                                            "4c7e2a1d-8b3f-4e2c-9a1d-5f6b7e2c3d4a": 15
                                                        },
                                                        "llmInferred": {
                                                            "isServiceAccount": true,
                                                            "isFrontlineWorker": false,
                                                            "isTempWorker": null
                                                        },
                                                        "principalMetadata": {
                                                            "sharedMailbox": false
                                                        },
                                                        "enhancedData": {
                                                            "userPrincipalName": "some_user@example.com",
                                                            "idpJobTitle": "Senior Engineer",
                                                            "idpDepartment": "Engineering",
                                                            "idpOfficeLocation": "Building 1 / Floor 3",
                                                            "idpEmployeeType": "Full-Time"
                                                        }
                                                    }
                                                }
                                            },
                                            "schemaVersion": "1"
                                        }
                                    }
                                },
                                "schema": {
                                    "$ref": "#/components/schemas/LicenseReport"
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "400": {
                        "$ref": "#/components/responses/400"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "403": {
                        "$ref": "#/components/responses/403"
                    }
                },
                "tags": [
                    "Discover"
                ],
                "summary": "Retrieve the Specified License Report"
            }
        },
        "/Api/Discover/ArchitectureReport/Correlation": {
            "get": {
                "description": "Retrieves the list of correlation records for the authenticated tenant. Correlation records store the metadata for a specific architecture report.\n\nThis endpoint requires the `Discover.Read`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Discover/ArchitectureReport/Correlation/Get",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "examples": {
                                    "Typical Response": {
                                        "description": "Sample list of correlation records for the authenticated tenant.",
                                        "summary": "Available Correlation Records for Architecture Report",
                                        "value": [
                                            {
                                                "auditTenantAccount": "somebody@example.com",
                                                "correlationId": "e0b0ebef-d0bf-4467-80c8-6a3a5f37fb24",
                                                "reportTenantAccount": "tenantUser@example.com",
                                                "tenantId": "79f7e8c4-15fa-4ae2-8f05-74f3c5071798",
                                                "createdAt": "2025-10-01T12:14:45.026Z",
                                                "updatedAt": "2025-11-02T00:14:45.026Z"
                                            },
                                            {
                                                "auditTenantAccount": "somebodyElse@example.com",
                                                "correlationId": "de4a7293-eed0-4167-b622-efeb764a2148",
                                                "reportTenantAccount": "anotherUser@example.com",
                                                "tenantId": "23317352-da99-4b52-ac1c-ad8e16310296",
                                                "createdAt": "2025-06-20T20:14:45.026Z",
                                                "updatedAt": "2025-07-22T12:10:45.026Z"
                                            }
                                        ]
                                    }
                                },
                                "schema": {
                                    "type": "array",
                                    "minItems": 0,
                                    "items": {
                                        "$ref": "#/components/schemas/ArchitectureReport.CorrelationRecord"
                                    },
                                    "examples": [
                                        [
                                            {
                                                "auditTenantAccount": "somebody@example.com",
                                                "correlationId": "e0b0ebef-d0bf-4467-80c8-6a3a5f37fb24",
                                                "reportTenantAccount": "tenantUser@example.com",
                                                "tenantId": "79f7e8c4-15fa-4ae2-8f05-74f3c5071798",
                                                "createdAt": "2025-10-01T12:14:45.026Z",
                                                "updatedAt": "2025-11-02T00:14:45.026Z"
                                            }
                                        ]
                                    ]
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "403": {
                        "$ref": "#/components/responses/403"
                    }
                },
                "tags": [
                    "Discover"
                ],
                "summary": "Retrieve the List of Architecture Report Correlation Records"
            }
        },
        "/Api/Discover/ArchitectureReport/Correlation/{correlationId}/Data": {
            "get": {
                "description": "Retrieves the CSPM assessment coverage calculation results on the architecture report for the specified correlation ID in the authenticated tenant.\n\nThis endpoint requires the `Discover.Read`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Discover/ArchitectureReport/Correlation/:correlationId/Data/Get",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/correlationId"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "examples": {
                                    "CspmPolicyAssessment": {
                                        "description": "Sample CSPM Policy Assessment including a mapping of configuration item template IDs to their corresponding policy records containing coverage status.",
                                        "summary": "Example CSPM Policy Assessment Response",
                                        "value": {
                                            "policyList": {
                                                "e7b8c2a2-2e4a-4b6a-9c3d-8f1e2a7b6c4d": {
                                                    "categoryList": [
                                                        "Access Control",
                                                        "Compliance"
                                                    ],
                                                    "coverageMetricsNormalized": {
                                                        "covered": 80,
                                                        "noCover": 0,
                                                        "partial": 20
                                                    },
                                                    "coverageMetricsRaw": {
                                                        "covered": 8,
                                                        "noCover": 0,
                                                        "partial": 2
                                                    },
                                                    "coverageStatus": "full",
                                                    "name": "Sample Policy 1"
                                                },
                                                "2a1e3c4d-5b6f-4e7a-8c9d-0f1b2a3c4d5e": {
                                                    "categoryList": [
                                                        "Data Protection"
                                                    ],
                                                    "coverageMetricsNormalized": {
                                                        "covered": 50,
                                                        "noCover": 20,
                                                        "partial": 30
                                                    },
                                                    "coverageMetricsRaw": {
                                                        "covered": 5,
                                                        "noCover": 2,
                                                        "partial": 3
                                                    },
                                                    "coverageStatus": "partial",
                                                    "name": "Sample Policy 2"
                                                },
                                                "9f8e7d6c-5b4a-3c2e-1d0f-8a7b6c5d4e3f": {
                                                    "categoryList": [
                                                        "Network Security"
                                                    ],
                                                    "coverageMetricsNormalized": {
                                                        "covered": 0,
                                                        "noCover": 100,
                                                        "partial": 0
                                                    },
                                                    "coverageMetricsRaw": {
                                                        "covered": 0,
                                                        "noCover": 10,
                                                        "partial": 0
                                                    },
                                                    "coverageStatus": "none",
                                                    "name": "Sample Policy 3"
                                                },
                                                "1f0e9d8c-7b6a-5c4d-3e2f-1a0b9c8d7e6f": {
                                                    "categoryList": [
                                                        "Identity Management"
                                                    ],
                                                    "coverageMetricsNormalized": {
                                                        "covered": 70,
                                                        "noCover": 20,
                                                        "partial": 10
                                                    },
                                                    "coverageMetricsRaw": {
                                                        "covered": 7,
                                                        "noCover": 2,
                                                        "partial": 1
                                                    },
                                                    "coverageStatus": "partial",
                                                    "name": "Sample Policy 4"
                                                }
                                            },
                                            "reportCreatedDate": "2025-11-25T11:00:00Z",
                                            "reportUpdatedDate": "2025-11-26T11:00:00Z"
                                        }
                                    }
                                },
                                "schema": {
                                    "$ref": "#/components/schemas/Discover.ArchitectureReport.CspmPolicyAssessment"
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "400": {
                        "$ref": "#/components/responses/400"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "403": {
                        "$ref": "#/components/responses/403"
                    }
                },
                "tags": [
                    "Discover"
                ],
                "summary": "Retrieve the Specified Architecture Report's CSPM Assessment Coverage Calculations"
            }
        },
        "/Api/Discover/Cache/Reset": {
            "post": {
                "summary": "Request to Rebuild the Delta Engine's Cache From Scratch",
                "description": "Requests the Cache Engine to clear and request latest data from the tenant to be available for the report generation.\n\nThis endpoint requires the `Discover.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Discover/Cache/Reset/Post",
                "responses": {
                    "202": {
                        "$ref": "#/components/responses/202"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "403": {
                        "$ref": "#/components/responses/403"
                    }
                },
                "tags": [
                    "Discover"
                ]
            }
        },
        "/Api/Deploy": {
            "get": {
                "summary": "Gets the Current Status of the Infrastructure Deployment",
                "description": "Has the core infrastructure engine check if the config engine can initialize properly.\n\nThis endpoint requires the `Deploy.Read`, `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Deploy/Get",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "examples": {
                                    "Infra deployed": {
                                        "description": "All API calls should be available since the core infrastructure is deployed.",
                                        "summary": "Infrastructure Is Deployed",
                                        "value": {
                                            "deployedArchitecture": "4a7f2e9c-1b3d-4c6a-9f8e-2d5b3e1a7c9f",
                                            "deployTagInclude": true,
                                            "deployedTags": [
                                                "5e2a9c1f-8b3d-4f6a-9e7c-2d1f3a6b4c8e",
                                                "9c7f2e1a-3b6d-4a8e-9f5c-1d2a4b7e6c3f"
                                            ],
                                            "isDeploying": true
                                        }
                                    },
                                    "Infra not deployed": {
                                        "description": "Infrastructure is not deployed. Please run the deployment before attempting different API calls.",
                                        "summary": "Infrastructure Is Not Deployed",
                                        "value": {
                                            "deployedArchitecture": null,
                                            "deployTagInclude": false,
                                            "deployedTags": [],
                                            "isDeploying": false
                                        }
                                    }
                                },
                                "schema": {
                                    "properties": {
                                        "deployedArchitecture": {
                                            "description": "Reference of the architecture type being deployed that defines what resources could be targeted.",
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "format": "uuid",
                                            "maxLength": 36,
                                            "minLength": 36,
                                            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                            "examples": [
                                                "6a2b7e1c-3d4f-4a8b-9e6a-2c1b7f3d8e4a"
                                            ]
                                        },
                                        "deployTagInclude": {
                                            "description": "Flag that indicates if the tag list has been set to be in inclusion mode (`true`) or exclusion mode (`false`).",
                                            "type": "boolean",
                                            "examples": [
                                                true
                                            ]
                                        },
                                        "deployedTags": {
                                            "description": "Collection of references to the groupings that list related or dependent resources to be deployed.",
                                            "type": "array",
                                            "items": {
                                                "type": "string",
                                                "format": "uuid",
                                                "maxLength": 36,
                                                "minLength": 36,
                                                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                                "examples": [
                                                    "9e1c2b7a-5d3f-4a8b-2c6e-7f1a3d9e8b5c"
                                                ]
                                            },
                                            "minItems": 0
                                        },
                                        "isDeploying": {
                                            "description": "Flag to indicate if process has started and ongoing (true) or not (false).",
                                            "type": "boolean",
                                            "examples": [
                                                true
                                            ]
                                        }
                                    },
                                    "type": "object",
                                    "required": [
                                        "deployedArchitecture",
                                        "deployTagInclude",
                                        "deployedTags",
                                        "isDeploying"
                                    ]
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            },
            "post": {
                "summary": "Deploys the Core Infrastructure Architecture Specification",
                "description": "After the user consents, deploy the core security groups, scope tag, configurations and metadata.\n\nThis endpoint requires the `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Deploy/Post",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "examples": {
                                "Ignorant Deploy Request": {
                                    "description": "Clueless dev trying to automate this application without reading the docs. RTFM!",
                                    "summary": "Ignorant Deploy Request",
                                    "value": {}
                                },
                                "No User Consent": {
                                    "description": "User did not agree to the terms and conditions. This post should not have been sent.",
                                    "summary": "User Did Not Consent",
                                    "value": {
                                        "deploymentConsent": false,
                                        "architectureId": "3f9c1a2e-4b7e-4f5e-9c3e-8d2f7a1b6c9d",
                                        "tagList": [
                                            "7a2e5b1f-9c4d-4e3a-8f1b-2d6c3e9a7f4e"
                                        ],
                                        "include": true
                                    }
                                },
                                "User Consented": {
                                    "description": "User agreed to the terms and conditions and pressed the deploy button.",
                                    "summary": "User Consented",
                                    "value": {
                                        "deploymentConsent": true,
                                        "architectureId": "1d4f9c7a-3e2b-4a6d-9f8e-7c2a1b5e3d9f",
                                        "tagList": [
                                            "6b3e2f1a-8d9c-4f7e-9a3b-1c2d5e7f4a6b",
                                            "9e1c3a7b-2f4d-4e6a-8c9f-3b7d1a5e2f6c"
                                        ],
                                        "include": false
                                    }
                                }
                            },
                            "schema": {
                                "properties": {
                                    "deploymentConsent": {
                                        "description": "Flag that indicates the end user has consented to deploying the architecture (`true`) or not (`false`).",
                                        "type": "boolean",
                                        "examples": [
                                            true
                                        ]
                                    },
                                    "architectureId": {
                                        "description": "Reference of the architecture type being deployed that defines what resources could be targeted.",
                                        "type": "string",
                                        "format": "uuid",
                                        "maxLength": 36,
                                        "minLength": 36,
                                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                        "examples": [
                                            "3b8e2a1c-7d4f-4a8b-9e6a-2c1b7f3d8e4a"
                                        ]
                                    },
                                    "tagList": {
                                        "description": "Collection of references to the groupings that list related or dependent resources to be deployed.",
                                        "type": "array",
                                        "items": {
                                            "type": "string",
                                            "format": "uuid",
                                            "maxLength": 36,
                                            "minLength": 36,
                                            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                            "examples": [
                                                "5d1c7e2b-3a4f-4a8b-9e6a-7f2b3d1c9e45"
                                            ]
                                        },
                                        "minItems": 0
                                    },
                                    "include": {
                                        "description": "Flag to indicate if calculated resources should be included (true) or excluded (false) from the deploy.",
                                        "type": "boolean",
                                        "examples": [
                                            true
                                        ]
                                    }
                                },
                                "type": "object",
                                "required": [
                                    "deploymentConsent",
                                    "architectureId",
                                    "tagList",
                                    "include"
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "202": {
                        "description": "Request for deployment is accepted and process is running"
                    },
                    "400": {
                        "description": "User information or choice are invalid for the operation"
                    },
                    "409": {
                        "description": "Operation is already in progress"
                    },
                    "503": {
                        "description": "System requirements have not been met!"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            },
            "patch": {
                "summary": "Augments the List of Tags Set as Deployed and Provisions New Resources",
                "description": "Changes the list of tags based on include flags, calculates the list of matchings resources and deploys all the ones marked as not provisioned.\n\nThis endpoint requires the `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Deploy/Patch",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "examples": {
                                "Invalid Request": {
                                    "description": "User submits request with empty list.",
                                    "summary": "Empty Request",
                                    "value": {
                                        "tagList": []
                                    }
                                },
                                "Acceptable Request": {
                                    "description": "User provides one or more values for the list of tags.",
                                    "summary": "Request with Data",
                                    "value": {
                                        "tagList": [
                                            "f3b9c7e2-1a4d-4c2e-9f3e-8b6a1c2d9e7a",
                                            "a7d2f1c4-3e8b-4b6f-9c1d-2f4e7a9b3c6d"
                                        ]
                                    }
                                }
                            },
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "tagList": {
                                        "type": "array",
                                        "items": {
                                            "type": "string",
                                            "format": "uuid",
                                            "maxLength": 36,
                                            "minLength": 36,
                                            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                            "examples": [
                                                "f3b9c7e2-1a4d-4c2e-9f3e-8b6a1c2d9e7a"
                                            ]
                                        },
                                        "minItems": 1,
                                        "examples": [
                                            [
                                                "f3b9c7e2-1a4d-4c2e-9f3e-8b6a1c2d9e7a",
                                                "a7d2f1c4-3e8b-4b6f-9c1d-2f4e7a9b3c6d"
                                            ]
                                        ]
                                    }
                                },
                                "required": [
                                    "tagList"
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "202": {
                        "description": "Request for changes is accepted and deployment of the additional resources is running"
                    },
                    "400": {
                        "description": "User information is invalid/incomplete for the operation"
                    },
                    "503": {
                        "description": "System requirements have not been met!"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            }
        },
        "/Api/Deploy/BreakGlass": {
            "get": {
                "summary": "Check the Status of the Break Glass Groups and Required Users Existence",
                "description": "Retrieves the status of required user quantity existence in the break glass group.\n\nThis endpoint requires the `Deploy.Read` scope (permission).",
                "operationId": "/Api/Deploy/BreakGlass/Get",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "boolean",
                                    "examples": [
                                        true
                                    ]
                                },
                                "examples": {
                                    "2 or more users": {
                                        "summary": "2 or More Users",
                                        "description": "An example boolean value that represents the existence of 2 or more users in the break glass group.",
                                        "value": true
                                    },
                                    "Less than 2 users": {
                                        "summary": "Less Than 2 Users",
                                        "description": "An example boolean value that represents the existence of less than 2 users in the break glass group.",
                                        "value": false
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            },
            "post": {
                "summary": "Request to Create BreakGlass Security Group",
                "description": "Attempts to create BreakGlass security group in the tenant. If group has already been provisioned it will return the name of the group to reference.\n\nThis endpoint requires the `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission). ",
                "operationId": "/Api/Deploy/BreakGlass/Post",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "examples": {
                                    "Response with data": {
                                        "summary": "Example of the Returned Data",
                                        "description": "An example of the name of the resource either created or already existing.",
                                        "value": {
                                            "groupName": "SHIELD - BreakGlass"
                                        }
                                    }
                                },
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "groupName": {
                                            "type": "string",
                                            "description": "Name of the security group created now or already existing in the tenant.",
                                            "examples": [
                                                "SHIELD - BreakGlass"
                                            ]
                                        }
                                    },
                                    "required": [
                                        "groupName"
                                    ],
                                    "examples": [
                                        {
                                            "groupName": "SHIELD - BreakGlass"
                                        }
                                    ]
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "503": {
                        "description": "System requirements have not been met!"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            }
        },
        "/Api/Deploy/Component/Architecture": {
            "get": {
                "summary": "Returns List of Available Architectures",
                "description": "Retrieves the collection of possible architecture configurations to be deployed including all metadata accompanying these records.\n\nThis endpoint requires the `Deploy.Read`, `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Deploy/Component/Architecture/Get",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "examples": {
                                    "Sample List of Available Architectures": {
                                        "description": "Sample list of architecture records available to be deployed.",
                                        "summary": "Available Architectures",
                                        "value": [
                                            {
                                                "id": "4a7f2e9c-1b3d-4c6a-9f8e-2d5b3e1a7c9f",
                                                "name": "Standard Security Baseline",
                                                "description": "Provides a standard security baseline for most organizations with core security groups, scope tags and configurations.",
                                                "version": "1.0.0",
                                                "isActive": true,
                                                "createdAt": "2024-01-15T12:00:00Z",
                                                "updatedAt": "2024-06-20T08:30:00Z"
                                            },
                                            {
                                                "id": "7e2a5b1f-9c4d-4e3a-8f1b-2d6c3e9a7f4e",
                                                "name": "Enhanced Security Posture",
                                                "description": "An enhanced security posture architecture with additional configurations and stricter access controls.",
                                                "version": "2.1.0",
                                                "isActive": true,
                                                "createdAt": "2024-03-10T09:15:00Z",
                                                "updatedAt": "2024-07-05T14:45:00Z"
                                            }
                                        ]
                                    }
                                },
                                "schema": {
                                    "$ref": "#/components/schemas/Deploy.ArchitectureData"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            }
        },
        "/Api/Deploy/Component/ConfigurationItem": {
            "get": {
                "summary": "Returns List of Available Configuration Items",
                "description": "Retrieves the collection of all existing configuration items with curated set of metadata.\n\nThis endpoint requires the `Deploy.Read`, `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Deploy/Component/ConfigurationItem/Get",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "examples": {
                                    "Sample List of Available Configuration Items": {
                                        "description": "Sample list of configuration item records available to be deployed.",
                                        "summary": "Available Configuration Items",
                                        "value": [
                                            {
                                                "childDependencies": [
                                                    "7e1a2b3c-4d5f-4a8b-9e6a-1c2b7f3d8e4a",
                                                    "9c2e7a1b-5d3f-4a8b-2c6e-7f1a3d9e8b5c"
                                                ],
                                                "deployState": "deployed",
                                                "groupTagList": [
                                                    {
                                                        "description": "Collection of policies covering critical conditional access settings.",
                                                        "displayName": "Conditional Policy",
                                                        "tagId": "3b7e2a1c-4d5f-4a8b-9e6a-2c1b7f3d8e4a"
                                                    }
                                                ],
                                                "msCloudTypes": [
                                                    "Public"
                                                ],
                                                "parentDependencies": [
                                                    "8e6a1c2b-7f3d-4a8b-9c2e-5d3f7a1b2e4a"
                                                ],
                                                "templateId": "2a1c7e3b-5d4f-4a8b-9e6a-7f3d2b1c8e4a",
                                                "urlPath": "/identity/conditionalAccess/policies"
                                            },
                                            {
                                                "childDependencies": [
                                                    "1c2b5d3f-7a1b-4a8b-9e6a-2e4a3b7e8c5d"
                                                ],
                                                "deployState": "notDeployed",
                                                "groupTagList": [
                                                    {
                                                        "description": "Principal containers that are used to provide assignments.",
                                                        "displayName": "Administrative Unit",
                                                        "tagId": "5d3f9c2e-7a1b-4a8b-2c6e-1a3d7e8b5c4a"
                                                    }
                                                ],
                                                "msCloudTypes": [
                                                    "Public"
                                                ],
                                                "parentDependencies": [],
                                                "templateId": "4a8b7e1a-2b3c-4d5f-9e6a-1c2b7f3d8e4a",
                                                "urlPath": "/directory/administrativeUnits"
                                            }
                                        ]
                                    }
                                },
                                "schema": {
                                    "$ref": "#/components/schemas/Deploy.ConfigurationItem"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            }
        },
        "/Api/Deploy/Component/ConfigurationItem/{templateId}/Docs": {
            "get": {
                "summary": "Return Result of Retrieving Configuration Item Documentation",
                "description": "Retrieves additional metadata from the configuration item if it was entered, or provides a message indicating it is missing.\n\nThis endpoint requires the `Deploy.Read`, `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission). ",
                "operationId": "/Api/Deploy/Component/ConfigurationItem/:templateId/Docs/Get",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/templateId"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "examples": {
                                    "Response With Documentation": {
                                        "description": "Sample response object of the documentation for the specific configuration item.",
                                        "summary": "Configuration Item Documentation",
                                        "value": {
                                            "title": "Multi-Factor Authentication (MFA)",
                                            "description": "This policy enforces multi-factor authentication (MFA) for enterprise identities during sign-in to reduce the risk of identity compromise.",
                                            "licenseRequirement": "Microsoft Entra ID P1",
                                            "priority": 1,
                                            "operationalRisk": 50,
                                            "importanceReasonList": [
                                                "MFA adds a layer of protection to the sign-in process."
                                            ],
                                            "deploymentBenefitList": [
                                                "Reduces the risk of compromised user credentials.",
                                                "Prevents brute-force attack."
                                            ],
                                            "nonDeploymentRiskList": [
                                                "Dramatically increased risk of account compromise.",
                                                "Higher chance of account compromise through phishing attacks."
                                            ],
                                            "guideStepList": [
                                                "Communicate the restriction to EntraID-joined devices and provide transition guidance.",
                                                "Stage the rollout with a pilot group and exclude critical accounts."
                                            ],
                                            "compliancePositionList": [
                                                "Deploying MFA helps meet compliance requirements for various industry regulations and standards."
                                            ],
                                            "compliancePositionStandardList": [
                                                "ISO 27001",
                                                "NIST"
                                            ],
                                            "disclaimerList": [
                                                "Please be aware that deploying this policy will enforce MFA for all users on their next sign-in."
                                            ],
                                            "baseLink": "https://entra.microsoft.com",
                                            "learnLinkList": [
                                                "https://learn.microsoft.com/en-us/azure/active-directory/authentication/concept-mfa-howitworks",
                                                "https://learn.microsoft.com/en-us/azure/active-directory/authentication/tutorial-enable-azure-mfa"
                                            ],
                                            "manualCreateGuideList": [
                                                "• Name: \"PSM - Token Binding\"",
                                                "• Users",
                                                "  • What does this policy apply to: Users and groups",
                                                "  • Include",
                                                "  • Select: Select users and groups",
                                                "  • Select: Users and groups",
                                                "  • Select: Users and groups to include",
                                                "• Exclude",
                                                "  • Select: Select users and groups",
                                                "  • Select: Users and groups",
                                                "    • Select: Windows",
                                                "[Go to this link](https://google.com/)"
                                            ]
                                        }
                                    }
                                },
                                "schema": {
                                    "$ref": "#/components/schemas/Deploy.ConfigurationItemMetaData"
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "400": {
                        "$ref": "#/components/responses/400"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            }
        },
        "/Api/Deploy/Progress": {
            "get": {
                "summary": "Returns Current Execution Progress of the Deploy Module",
                "description": "Provides a detailed breakdown of the current progress of the deploy module and its sub-components, if any.\n\nThis endpoint requires the `Deploy.Read`, `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Deploy/Progress/Get",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/operation"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Core.ProgressBar"
                                },
                                "examples": {
                                    "Progress Bar": {
                                        "value": {
                                            "childBar": [
                                                {
                                                    "description": "Collecting data from the Microsoft Purview.",
                                                    "displayName": "Running SHIELD Deploy - Purview",
                                                    "id": "b759230f-48cb-496e-ad57-5f079083226c",
                                                    "currentStep": 1,
                                                    "totalStepCount": 3
                                                }
                                            ],
                                            "description": "Collecting data from the Microsoft Entra ID system.",
                                            "displayName": "Running SHIELD Deploy",
                                            "id": "b759230f-48cb-496e-ad57-5f079083226b",
                                            "currentStep": 5,
                                            "totalStepCount": 7
                                        },
                                        "summary": "Example Progress Bar Object",
                                        "description": "An example progress bar object returned from the endpoint. It indicates: <br/> - The purpose of a progress bar. <br/> - The text label of a progress bar. <br/> - The unique identifier in type UUID of a specific SHIELD instance for search. <br/> - The total number of steps of a progress bar. <br/> - The current step/value of a progress bar. <br/> - With a child progress bar."
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            }
        },
        "/Api/Deploy/Remediate": {
            "get": {
                "summary": "Retrieves Collected Remediation Results",
                "description": "Returns results of the performed remediation action including any errors that occurred as well as mapping of templateId/name for the created resources.\n\nThis endpoint requires the `Deploy.Read`, or `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Deploy/Remediate/Get",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "examples": {
                                    "Response with Remediation Data": {
                                        "summary": "Example of the Remediation Results",
                                        "description": "An example of the current results of the remediation action.",
                                        "value": {
                                            "errors": [
                                                {
                                                    "templateId": "7e2b1c3d-4f5a-4a8b-9e6a-1c2b7f3d8e4a",
                                                    "message": "Failed to create dedicated group for the resource: Unexpected error."
                                                },
                                                {
                                                    "templateId": "2a1c7e3b-5d4f-4a8b-9e6a-7f3d2b1c8e4a",
                                                    "message": "Failed to create the resource: invalid value for 'id' reference."
                                                }
                                            ],
                                            "results": {
                                                "4a8b7e1a-2b3c-4d5f-9e6a-1c2b7f3d8e4a": "CSPM - MDCA",
                                                "b3e2c1d4-7f5a-4a8b-9e6a-2c1b7f3d8e4a": "CSPM - Authentication Methods"
                                            }
                                        }
                                    }
                                },
                                "schema": {
                                    "$ref": "#/components/schemas/Deploy.RemediationResponse"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            },
            "post": {
                "summary": "Perform Remediation Steps to Address Discovered Gaps in Security Posture",
                "description": "After the user consents, perform necessary steps to deploy resources to cover the security gap.\n\nThis endpoint requires the `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Deploy/Remediate/Post",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "examples": {
                                "Insufficient Remediation Request": {
                                    "description": "Someone trying to automate this application without reading the documentation.",
                                    "summary": "Remediation Request Missing Needed Data",
                                    "value": {}
                                },
                                "No User Consent": {
                                    "description": "User did not agree to the terms and conditions. This post should not have been sent.",
                                    "summary": "User Did Not Consent",
                                    "value": {
                                        "remediationConsent": false,
                                        "templateList": [
                                            "8e2b1c7a-4d5f-4a8b-9e6a-2c1b7f3d8e4a",
                                            "3a7e2b1c-5d4f-4a8b-9e6a-7f2b3d1c9e45"
                                        ]
                                    }
                                },
                                "User Consented": {
                                    "description": "User agreed to the terms and conditions and pressed the remediate button.",
                                    "summary": "User Consented",
                                    "value": {
                                        "remediationConsent": true,
                                        "templateList": [
                                            "9c1e7a2b-5d3f-4a8b-2c6e-1a7f3d9e8b5c",
                                            "2b3e7a1c-4d5f-4a8b-9e6a-5d1c7e2b3a4f",
                                            "7f1a3d9e-8b5c-4a8b-2c6e-9c2e7a1b5d3f"
                                        ]
                                    }
                                }
                            },
                            "schema": {
                                "properties": {
                                    "remediationConsent": {
                                        "description": "Flag that indicates the end user has consented to remediation steps (`true`) or not (`false`).",
                                        "type": "boolean",
                                        "examples": [
                                            true
                                        ]
                                    },
                                    "templateList": {
                                        "description": "List of templateIds that indicate configuration items to be applied as part of remediation.",
                                        "type": "array",
                                        "items": {
                                            "type": "string",
                                            "format": "uuid",
                                            "maxLength": 36,
                                            "minLength": 36,
                                            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                            "examples": [
                                                "5d1c7e2b-3a4f-4a8b-9e6a-7f2b3d1c9e45"
                                            ]
                                        },
                                        "minItems": 0
                                    }
                                },
                                "type": "object",
                                "required": [
                                    "remediationConsent",
                                    "templateList"
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "202": {
                        "description": "Request for remediation is accepted and process is running"
                    },
                    "400": {
                        "description": "User provided information or choice are invalid for the operation"
                    },
                    "409": {
                        "description": "Operation is already in progress"
                    },
                    "503": {
                        "description": "System requirements have not been met!"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            }
        },
        "/Api/Deploy/Compare": {
            "get": {
                "summary": "Retrieves Cached Evaluation Results",
                "description": "Returns results of the last performed comparison of the values in the existing resources and their original requested configurations. Resulting object consists of several categories and includes timestamp when the evaluation was performed.\n\nThis endpoint requires the `Deploy.Read`, or `Deploy.ReadWrite`, or `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Deploy/Compare/Get",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "examples": {
                                    "Response with Cached Data": {
                                        "summary": "Example of the Comparison Results",
                                        "description": "An example of the cached results from the previous comparison operation.",
                                        "value": {
                                            "invalid": [
                                                {
                                                    "templateId": "a14402b8-98c5-41e3-ba99-e5e1a536f68d",
                                                    "message": "Setting ID '58246273-d366-40d5-ac3d-daacb8bc2655' - Item not found."
                                                },
                                                {
                                                    "templateId": "9af9209d-d191-4b42-9f65-dfd8b7882bba",
                                                    "message": "Setting ID 'f6f5d07b-230c-4818-93de-e407b8ca9537' - Insufficient access to view this data."
                                                }
                                            ],
                                            "lastRunTimestamp": "2025-03-25T14:28:54Z",
                                            "missing": [
                                                {
                                                    "templateId": "78afd77c-c2a6-4328-9c61-b9fd44114823",
                                                    "message": "{\"displayName\":\"Privileged Objects\",\"description\":\"Privileged objects managed by application.\",\"membershipType\":\"Assigned\"}"
                                                }
                                            ],
                                            "results": [
                                                {
                                                    "templateId": "c47c20bd-46fa-4dfe-b971-3e5b1ce34a86",
                                                    "variants": [
                                                        {
                                                            "actions": [
                                                                2,
                                                                3
                                                            ],
                                                            "errorCode": 5,
                                                            "path": "/displayName"
                                                        },
                                                        {
                                                            "actions": [
                                                                2
                                                            ],
                                                            "errorCode": 1,
                                                            "path": "/groupPolicyUploadedLanguageFiles"
                                                        }
                                                    ]
                                                },
                                                {
                                                    "templateId": "4b26b6f6-9cb3-4384-bd1e-6d298455c2c4",
                                                    "variants": [
                                                        {
                                                            "actions": [
                                                                3
                                                            ],
                                                            "errorCode": 3,
                                                            "path": "/roleScopeTagIds/1"
                                                        }
                                                    ]
                                                }
                                            ]
                                        }
                                    }
                                },
                                "schema": {
                                    "$ref": "#/components/schemas/Deploy.CompareResponse"
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            }
        },
        "/Api/Deploy/Compare/Invoke": {
            "post": {
                "summary": "Requests to Run New Evaluation and Returns Results",
                "description": "Resets all cached data and initiates process to compar the values in the existing resources and their original requested configurations. Returns resulting object split into several categories and including timestamp when the evaluation was performed.\n\nThis endpoint requires the `Deploy.ReadWrite` or `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/DeployCompare/Invoke/Post",
                "requestBody": {
                    "description": "No payload is expected or needed for this operation",
                    "content": {
                        "application/json": {}
                    }
                },
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "examples": {
                                    "Response with New Data": {
                                        "summary": "Example of the Comparison Results",
                                        "description": "An example of the newly calculated results after performing comparison operation.",
                                        "value": {
                                            "invalid": [
                                                {
                                                    "templateId": "a14402b8-98c5-41e3-ba99-e5e1a536f68d",
                                                    "message": "Setting ID '58246273-d366-40d5-ac3d-daacb8bc2655' - Item not found."
                                                },
                                                {
                                                    "templateId": "9af9209d-d191-4b42-9f65-dfd8b7882bba",
                                                    "message": "Setting ID 'f6f5d07b-230c-4818-93de-e407b8ca9537' - Insufficient access to view this data."
                                                }
                                            ],
                                            "lastRunTimestamp": "2025-03-25T14:28:54Z",
                                            "missing": [
                                                {
                                                    "templateId": "78afd77c-c2a6-4328-9c61-b9fd44114823",
                                                    "message": "{\"displayName\":\"Privileged Objects\",\"description\":\"Privileged objects managed by application.\",\"membershipType\":\"Assigned\"}"
                                                }
                                            ],
                                            "results": [
                                                {
                                                    "templateId": "c47c20bd-46fa-4dfe-b971-3e5b1ce34a86",
                                                    "variants": [
                                                        {
                                                            "actions": [
                                                                2,
                                                                3
                                                            ],
                                                            "errorCode": 5,
                                                            "path": "/displayName"
                                                        },
                                                        {
                                                            "actions": [
                                                                2
                                                            ],
                                                            "errorCode": 1,
                                                            "path": "/groupPolicyUploadedLanguageFiles"
                                                        }
                                                    ]
                                                },
                                                {
                                                    "templateId": "4b26b6f6-9cb3-4384-bd1e-6d298455c2c4",
                                                    "variants": [
                                                        {
                                                            "actions": [
                                                                3
                                                            ],
                                                            "errorCode": 3,
                                                            "path": "/roleScopeTagIds/1"
                                                        }
                                                    ]
                                                }
                                            ]
                                        }
                                    }
                                },
                                "schema": {
                                    "$ref": "#/components/schemas/Deploy.CompareResponse"
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "503": {
                        "description": "Deployed architecture is invalid or missing!"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            }
        },
        "/Api/Deploy/Analyze/Invoke": {
            "post": {
                "summary": "Requests to Run the Infrastructure Configuration Analysis",
                "description": "Initiates an asynchronous analysis of all deployed configuration items in the infrastructure. It starts the analysis process, to discover any and all inconsistencies at the configuration item level.\n\nThis endpoint requires the `Deploy.ReadWrite` or `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Analyze/Invoke/Post",
                "requestBody": {
                    "description": "No payload is expected or needed for this operation",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {}
                            }
                        }
                    }
                },
                "responses": {
                    "202": {
                        "description": "Request for analyze is accepted and process is initiated"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            }
        },
        "/Api/Deploy/Skip": {
            "get": {
                "summary": "Retrieves List of Existing Override Rules",
                "description": "Retrieves the details of override property in the Settings Engine and returns list grouped by configuration item reference.\n\nThis endpoint requires `Deploy.Read`, or `Deploy.ReadWrite`, or `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Deploy/Skip/Get",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "examples": {
                                    "Example Response with Current Rules": {
                                        "summary": "Example of the Returned List of the Skipped Items",
                                        "description": "An example of the list indicating configuration items and the properties that are designed to be ignored during the comparison operation.",
                                        "value": {
                                            "f47ac10b-58cc-4372-a567-0e02b2c3d479": [
                                                "/"
                                            ],
                                            "9c858901-8a57-4791-81fe-4c455b099bc9": [
                                                "/description",
                                                "/name"
                                            ]
                                        }
                                    }
                                },
                                "schema": {
                                    "type": "object",
                                    "additionalProperties": {
                                        "type": "array",
                                        "items": {
                                            "type": "string",
                                            "description": "Flat path representing entire item or specific nested property in the configuration item.",
                                            "examples": [
                                                "/description"
                                            ]
                                        },
                                        "examples": [
                                            [
                                                "/",
                                                "/description"
                                            ]
                                        ]
                                    },
                                    "description": "Collection of references to configuration items (using templateId property as property name) and array of strings as value.",
                                    "examples": [
                                        {
                                            "f47ac10b-58cc-4372-a567-0e02b2c3d479": [
                                                "/"
                                            ],
                                            "9c858901-8a57-4791-81fe-4c455b099bc9": [
                                                "/description",
                                                "/name"
                                            ]
                                        }
                                    ]
                                }
                            }
                        },
                        "description": "OK"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            }
        },
        "/Api/Deploy/Skip/{templateId}": {
            "post": {
                "summary": "Records New Entry to Skip During Evaluation",
                "description": "Stores the reference to the entity to be skipped during the evaluation process. Could be entire configuration item or a specific property.\n\nThis endpoint requires the `Deploy.ReadWrite` or `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Deploy/Skip/:templateId/Post",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/templateId"
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Deploy.PathIndicator"
                            }
                        }
                    }
                },
                "responses": {
                    "204": {
                        "description": "Recorded successfully"
                    },
                    "400": {
                        "description": "The body does not match expected format!"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            },
            "delete": {
                "summary": "Removes Existing Entry From Being Skipped",
                "description": "Deletes the entry so it is no longer ignored during the evaluation process.\n\nThis endpoint requires the `Deploy.ReadWrite` or `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Deploy/Skip/:templateId/Delete",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/templateId"
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Deploy.PathIndicator"
                            }
                        }
                    }
                },
                "responses": {
                    "204": {
                        "description": "Record has been removed successfully"
                    },
                    "400": {
                        "description": "The body does not match expected format!"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            }
        },
        "/Api/Deploy/Restore/{templateId}": {
            "patch": {
                "summary": "Restores the Details Of the Deployed Resource",
                "description": "Calculates and applies a change to the deployed resource to restore original value from the entire configuration item or single property.\n\nThis endpoint requires the `Deploy.ReadWrite` or `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Deploy/Restore/:templateId/Patch",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/templateId"
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Deploy.PathIndicator"
                            }
                        }
                    }
                },
                "responses": {
                    "204": {
                        "description": "Restoration of configuration item or its property is successful"
                    },
                    "400": {
                        "description": "The body does not match expected format!"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            }
        },
        "/Api/Deploy/Remove": {
            "get": {
                "summary": "Indicates if the Remove Function Can Be Ran",
                "description": "Provides a flag that indicates if the core infrastructure removal command can be ran or not.\n\nThis endpoint requires the `Deploy.Read`, `Deploy.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Deploy/Remove/Get",
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "boolean"
                                },
                                "examples": {
                                    "Remove Ready": {
                                        "value": true,
                                        "summary": "Removal Ready",
                                        "description": "Flag that indicates that no dependent components are present and the core infra can be removed."
                                    },
                                    "Remove Not Ready": {
                                        "value": false,
                                        "summary": "Removal Not Ready",
                                        "description": "Flag that indicates that dependent components are present and the core infra should not be removed."
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "503": {
                        "description": "Deployed architecture is invalid or missing!"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            },
            "delete": {
                "summary": "Removes All Provisioned Infrastructure Resources",
                "description": "Deletes all resources in the tenant that were created during the initial deploy or any update operation since.\n\nThis endpoint requires the `Deploy.ReadWrite` or `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/DeployRemove/Delete",
                "responses": {
                    "202": {
                        "description": "Request for removal is accepted and process initiated"
                    },
                    "503": {
                        "description": "Deployed architecture is invalid or missing!"
                    }
                },
                "tags": [
                    "Deploy"
                ]
            }
        },
        "/Api/Defend/Intermediary/Type/{securityClass}/Offering/8a921026-ec06-4e08-af19-8812e161e61f": {
            "get": {
                "description": "Retrieves a list of all AVD intermediaries for the specified security class filter. Next links may be provided for pagination to allow for good performance on larger environments. If a nextLink is return, not all data was returned on this query and the next link can be sent back to the API to get the next page of data.\n\nThis endpoint requires the `Intermediary.Privileged.Read`, `Intermediary.Privileged.ReadWrite`, `Intermediary.Specialized.Read`, `Intermediary.Specialized.ReadWrite`, `Intermediary.Enterprise.ReadWrite`, `Intermediary.Enterprise.Read`, or the `Everything.ReadWrite` scope (permission). The security class parameter in the URL path corresponds to the same permission in the scope. That means if you are granted a privileged role, you can only call the privilege class URL.",
                "operationId": "/Api/Defend/Intermediary/Type/:securityClass/Offering/AVD/Get",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/securityClass"
                    },
                    {
                        "$ref": "#/components/parameters/nextLink"
                    },
                    {
                        "$ref": "#/components/parameters/search"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ObjectPage.Intermediary.Avd"
                                },
                                "examples": {
                                    "Paged AVD intermediaries": {
                                        "summary": "Example Paged AVD Intermediary List",
                                        "description": "An example paged AVD intermediary list returned that represents the current page of all AVD intermediary instances form the specified security class.",
                                        "value": {
                                            "@odata.count": 1,
                                            "@odata.nextLink": "1",
                                            "value": [
                                                {
                                                    "id": "e097a3f5-9599-44a2-8923-fd3276c83ae1",
                                                    "kind": "AVD",
                                                    "name": "Legacy Reach Back",
                                                    "securityClass": "Privileged",
                                                    "addressRangeCIDR": "172.16.1.0/24",
                                                    "assignmentGroup": "68873e26-3c35-465c-9422-0884a00beb36",
                                                    "index": 0,
                                                    "location": "East US 2",
                                                    "resourceId": "/subscriptions/742f0d26-daa0-4f84-8d4f-fb052f89f639/resourceGroups/SHIELD_-_PSM-Legacy_Reach_Back/providers/Microsoft.DesktopVirtualization/hostpools/SHIELD_-_PSM-Cluster-Legacy_Reach_Back",
                                                    "sessionHostGroup": "f99f0918-da9b-4c58-9a8d-9346abc5d9ec",
                                                    "sessionHostPrefix": "Reach",
                                                    "vmSku": "Standard_D2s_v5"
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Retrieves All AVD Intermediary Instances",
                "tags": [
                    "Intermediary"
                ]
            }
        },
        "/Api/Defend/Intermediary/{intermediaryId}/Type/{securityClass}/Offering/8a921026-ec06-4e08-af19-8812e161e61f": {
            "delete": {
                "description": "Deletes the specified intermediary (by the parent group's Entra ID Object ID) using the requested security class as a filter.\n\nThis endpoint requires the `Intermediary.Privileged.ReadWrite`, `Intermediary.Specialized.ReadWrite`, `Intermediary.Enterprise.ReadWrite`, or the `Everything.ReadWrite` scope (permission). The security class parameter in the URL path corresponds to the same permission in the scope. That means if you are granted a privileged role, you can only call the privilege class URL.",
                "operationId": "/Api/Defend/Intermediary/:intermediaryId/Type/:securityClass/Offering/AVD/Delete",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/securityClass"
                    },
                    {
                        "$ref": "#/components/parameters/intermediaryId"
                    }
                ],
                "responses": {
                    "204": {
                        "description": "OK: Deleted successfully"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Deletes a Single AVD Intermediary Instance",
                "tags": [
                    "Intermediary"
                ]
            },
            "get": {
                "description": "Retrieves the specified intermediary (by the parent group's Entra ID Object ID) using the requested security class as a filter.\n\nThis endpoint requires the `Intermediary.Privileged.Read`, `Intermediary.Privileged.ReadWrite`, `Intermediary.Specialized.Read`, `Intermediary.Specialized.ReadWrite`, `Intermediary.Enterprise.ReadWrite`, `Intermediary.Enterprise.Read`, or the `Everything.ReadWrite` scope (permission). The security class parameter in the URL path corresponds to the same permission in the scope. That means if you are granted a privileged role, you can only call the privilege class URL.",
                "operationId": "/Api/Defend/Intermediary/:intermediaryId/Type/:securityClass/Offering/AVD/Get",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/securityClass"
                    },
                    {
                        "$ref": "#/components/parameters/intermediaryId"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ObjectPage.Intermediary.Avd"
                                },
                                "examples": {
                                    "Paged AVD intermediary result": {
                                        "summary": "Example Paged Result of an AVD Intermediary List",
                                        "description": "An example paged result that represents the current page of retrieved AVD intermediary list from a parent group filtered by specified class.",
                                        "value": {
                                            "@odata.count": 1,
                                            "@odata.nextLink": "1",
                                            "value": [
                                                {
                                                    "id": "e097a3f5-9599-44a2-8923-fd3276c83ae1",
                                                    "kind": "AVD",
                                                    "name": "Legacy Reach Back",
                                                    "securityClass": "Privileged",
                                                    "addressRangeCIDR": "172.16.1.0/24",
                                                    "assignmentGroup": "68873e26-3c35-465c-9422-0884a00beb36",
                                                    "index": 0,
                                                    "location": "East US 2",
                                                    "resourceId": "/subscriptions/742f0d26-daa0-4f84-8d4f-fb052f89f639/resourceGroups/SHIELD_-_PSM-Legacy_Reach_Back/providers/Microsoft.DesktopVirtualization/hostpools/SHIELD_-_PSM-Cluster-Legacy_Reach_Back",
                                                    "sessionHostGroup": "f99f0918-da9b-4c58-9a8d-9346abc5d9ec",
                                                    "sessionHostPrefix": "Reach",
                                                    "vmSku": "Standard_D2s_v5"
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Retrieves a Single AVD Intermediary Instance",
                "tags": [
                    "Intermediary"
                ]
            }
        },
        "/Api/Defend/Intermediary/{intermediaryId}/Type/{securityClass}/Offering/8a921026-ec06-4e08-af19-8812e161e61f/Assign": {
            "delete": {
                "description": "Removes the specified user(s) as identified by their Object ID from the AVD cluster and deletes their corresponding session host(s).\n\nThis endpoint requires the `Intermediary.Privileged.ReadWrite`, `Intermediary.Specialized.ReadWrite`, `Intermediary.Enterprise.ReadWrite`, or the `Everything.ReadWrite` scope (permission). The security class parameter in the URL path corresponds to the same permission in the scope. That means if you are granted a privileged role, you can only call the privilege class URL.",
                "operationId": "/Api/Defend/Intermediary/:intermediaryId/Type/:securityClass/Offering/AVD/Assign/Delete",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/securityClass"
                    },
                    {
                        "$ref": "#/components/parameters/intermediaryId"
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "examples": {
                                "One user": {
                                    "description": "Removes 1 session host, and removed the requested user from the assignments security group.",
                                    "summary": "Remove Single User",
                                    "value": {
                                        "userList": [
                                            "cf5b12a9-b939-4d5c-a380-fb62e4fe88ef"
                                        ]
                                    }
                                },
                                "Two users": {
                                    "description": "Removes 3 session hosts, and removed the requested users from the assignments security group.",
                                    "summary": "Remove Multiple Users",
                                    "value": {
                                        "userList": [
                                            "0c56b055-9042-4f54-8e6e-6510e12a81dc",
                                            "dd27937c-6287-45b3-98de-387725b068f3",
                                            "989d3dc1-43f4-4ff7-82ba-43661f94a428"
                                        ]
                                    }
                                }
                            },
                            "schema": {
                                "properties": {
                                    "userList": {
                                        "items": {
                                            "format": "uuid",
                                            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                            "type": "string"
                                        },
                                        "type": "array"
                                    }
                                },
                                "type": "object"
                            }
                        }
                    }
                },
                "responses": {
                    "204": {
                        "description": "OK: Deleted successfully"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Removes the Assignment of the Specified Users",
                "tags": [
                    "Intermediary"
                ]
            },
            "get": {
                "description": "Gets the list of assigned user from the specified AVD Intermediary.\n\nThis endpoint requires the `Intermediary.Privileged.Read`, `Intermediary.Privileged.ReadWrite`, `Intermediary.Specialized.Read`, `Intermediary.Specialized.ReadWrite`, `Intermediary.Enterprise.ReadWrite`, `Intermediary.Enterprise.Read`, or the `Everything.ReadWrite` scope (permission). The security class parameter in the URL path corresponds to the same permission in the scope. That means if you are granted a privileged role, you can only call the privilege class URL.",
                "operationId": "/Api/Defend/Intermediary/:intermediaryId/Type/:securityClass/Offering/AVD/Assign/Get",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/securityClass"
                    },
                    {
                        "$ref": "#/components/parameters/intermediaryId"
                    },
                    {
                        "$ref": "#/components/parameters/nextLink"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ObjectPage.ManagedUser"
                                },
                                "examples": {
                                    "Managed user page": {
                                        "summary": "Example Paged User Result",
                                        "description": "An example of paged user result that represents the current page of assigned user list retrieved from the specified AVD intermediary.",
                                        "value": {
                                            "@odata.count": 3,
                                            "@odata.nextLink": "2",
                                            "value": [
                                                {
                                                    "creationDate": "2023-10-21T15:24:47.970Z",
                                                    "displayName": "Example User (Priv)",
                                                    "firstName": "John",
                                                    "lastName": "Doe",
                                                    "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                                    "upn": "priv-user@example.com",
                                                    "securityClass": "Privileged",
                                                    "uiEducation": false,
                                                    "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                                                    "intermediaryAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ],
                                                    "siloAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ]
                                                },
                                                {
                                                    "creationDate": "2023-10-21T15:24:47.970Z",
                                                    "displayName": "Example User (Priv)",
                                                    "firstName": "John",
                                                    "lastName": "Doe",
                                                    "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                                    "upn": "priv-user@example.com",
                                                    "securityClass": "Privileged",
                                                    "uiEducation": false,
                                                    "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                                                    "intermediaryAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ],
                                                    "siloAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ],
                                                    "deviceAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ],
                                                    "generatedPassword": "GY_w7bZUKRgpIXctD0S2wg",
                                                    "parentId": "e59a3a64-dc36-4368-80ec-c205eb176ef6",
                                                    "temporaryAccessPass": "BCKTSN#E2R&5"
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "List All Assigned Users (Paginated)",
                "tags": [
                    "Intermediary"
                ]
            },
            "post": {
                "description": "Assigns the specified user(s) as identified by their Object ID to the AVD cluster and create corresponding session host(s) for them.\n\nThis endpoint requires the `Intermediary.Privileged.ReadWrite`, `Intermediary.Specialized.ReadWrite`, `Intermediary.Enterprise.ReadWrite`, or the `Everything.ReadWrite` scope (permission). The security class parameter in the URL path corresponds to the same permission in the scope. That means if you are granted a privileged role, you can only call the privilege class URL.",
                "operationId": "/Api/Defend/Intermediary/:intermediaryId/Type/:securityClass/Offering/AVD/Assign/Post",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/securityClass"
                    },
                    {
                        "$ref": "#/components/parameters/intermediaryId"
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "examples": {
                                "One user": {
                                    "description": "Creates 1 session host, and added the requested user to the assignments security group.",
                                    "summary": "Assign Single User",
                                    "value": {
                                        "userList": [
                                            "cf5b12a9-b939-4d5c-a380-fb62e4fe88ef"
                                        ]
                                    }
                                },
                                "Two users": {
                                    "description": "Creates 3 session hosts, and added the requested users to the assignments security group.",
                                    "summary": "Assign Multiple Users",
                                    "value": {
                                        "userList": [
                                            "0c56b055-9042-4f54-8e6e-6510e12a81dc",
                                            "dd27937c-6287-45b3-98de-387725b068f3",
                                            "989d3dc1-43f4-4ff7-82ba-43661f94a428"
                                        ]
                                    }
                                }
                            },
                            "schema": {
                                "properties": {
                                    "userList": {
                                        "items": {
                                            "format": "uuid",
                                            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                            "type": "string",
                                            "examples": [
                                                "0c56b055-9042-4f54-8e6e-6510e12a81dc"
                                            ]
                                        },
                                        "type": "array",
                                        "examples": [
                                            [
                                                "0c56b055-9042-4f54-8e6e-6510e12a81dc"
                                            ]
                                        ]
                                    }
                                },
                                "type": "object",
                                "examples": [
                                    {
                                        "userList": [
                                            "0c56b055-9042-4f54-8e6e-6510e12a81dc"
                                        ]
                                    }
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/ManagedObject.User"
                                    },
                                    "minItems": 0,
                                    "type": "array"
                                },
                                "examples": {
                                    "Managed user": {
                                        "summary": "Example Managed Users Returned",
                                        "description": "An example of managed user array returned that represents the users has been assigned to the specified AVD cluster and created corresponding session host successfully.",
                                        "value": [
                                            {
                                                "creationDate": "2023-10-21T15:24:47.970Z",
                                                "displayName": "Example User (Priv)",
                                                "firstName": "John",
                                                "lastName": "Doe",
                                                "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                                "upn": "priv-user@example.com",
                                                "securityClass": "Privileged",
                                                "uiEducation": false,
                                                "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                                                "intermediaryAssignmentList": [
                                                    "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                    "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                    "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                ],
                                                "siloAssignmentList": [
                                                    "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                    "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                    "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                ]
                                            }
                                        ]
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Assigns the List of Specified Users",
                "tags": [
                    "Intermediary"
                ]
            }
        },
        "/Api/Defend/Intermediary/{intermediaryId}/Type/{securityClass}/Offering/8a921026-ec06-4e08-af19-8812e161e61f/Assign/{userId}": {
            "get": {
                "description": "Get the specified managed user(s) from the specified AVD intermediary assignment list.\n\nThis endpoint requires the `Intermediary.Privileged.Read`, `Intermediary.Privileged.ReadWrite`, `Intermediary.Specialized.Read`, `Intermediary.Specialized.ReadWrite`, `Intermediary.Enterprise.ReadWrite`, `Intermediary.Enterprise.Read`, or the `Everything.ReadWrite` scope (permission). The security class parameter in the URL path corresponds to the same permission in the scope. That means if you are granted a privileged role, you can only call the privilege class URL.",
                "operationId": "/Api/Defend/Intermediary/:intermediaryId/Type/:securityClass/Offering/AVD/Assign/:userId/Get",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/securityClass"
                    },
                    {
                        "$ref": "#/components/parameters/intermediaryId"
                    },
                    {
                        "$ref": "#/components/parameters/userId"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ObjectPage.ManagedUser"
                                },
                                "examples": {
                                    "Assigned users": {
                                        "summary": "Example Assigned User List",
                                        "description": "An example paged assigned user list that represents the current page retrieved from specified AVD intermediary assignment list.",
                                        "value": {
                                            "@odata.count": 3,
                                            "@odata.nextLink": "2",
                                            "value": [
                                                {
                                                    "creationDate": "2023-10-21T15:24:47.970Z",
                                                    "displayName": "Example User (Priv)",
                                                    "firstName": "John",
                                                    "lastName": "Doe",
                                                    "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                                    "upn": "priv-user@example.com",
                                                    "securityClass": "Privileged",
                                                    "uiEducation": false,
                                                    "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                                                    "intermediaryAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ],
                                                    "siloAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ]
                                                },
                                                {
                                                    "creationDate": "2023-10-21T15:24:47.970Z",
                                                    "displayName": "Example User (Priv)",
                                                    "firstName": "John",
                                                    "lastName": "Doe",
                                                    "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                                    "upn": "priv-user@example.com",
                                                    "securityClass": "Privileged",
                                                    "uiEducation": false,
                                                    "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                                                    "intermediaryAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ],
                                                    "siloAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ],
                                                    "deviceAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ],
                                                    "generatedPassword": "GY_w7bZUKRgpIXctD0S2wg",
                                                    "parentId": "e59a3a64-dc36-4368-80ec-c205eb176ef6",
                                                    "temporaryAccessPass": "BCKTSN#E2R&5"
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Get a Specific Assigned User",
                "tags": [
                    "Intermediary"
                ]
            }
        },
        "/Api/Defend/Device/{deviceId}/Type/Privileged/Assign": {
            "delete": {
                "description": "Remove the specified user list from the device.\n\nThis endpoint requires the `Device.Privileged.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Defend/Device/:deviceId/Type/Privileged/Assign/Delete",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/deviceId"
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "examples": {
                                "Multiple Users": {
                                    "description": "Remove multiple user assignments from a managed device.",
                                    "summary": "Unassign Multiple Users",
                                    "value": {
                                        "userList": [
                                            "0674276a-31e8-4773-8ed9-6fb49dbd0fa8",
                                            "66714224-b1a6-4fd6-b9d8-5263fdf755fc"
                                        ]
                                    }
                                },
                                "Single User": {
                                    "description": "Remove a single user assignment from a managed device.",
                                    "summary": "Unassign One User",
                                    "value": {
                                        "userList": [
                                            "01ebf268-cf28-4607-954a-261dfd480453"
                                        ]
                                    }
                                }
                            },
                            "schema": {
                                "properties": {
                                    "userList": {
                                        "items": {
                                            "examples": [
                                                "d1bc9d1a-5a30-4d66-898a-1dd300e707bc"
                                            ],
                                            "format": "uuid",
                                            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                            "type": "string"
                                        },
                                        "type": "array",
                                        "examples": [
                                            [
                                                "d1bc9d1a-5a30-4d66-898a-1dd300e707bc"
                                            ]
                                        ]
                                    }
                                },
                                "type": "object",
                                "examples": [
                                    {
                                        "userList": [
                                            "d1bc9d1a-5a30-4d66-898a-1dd300e707bc"
                                        ]
                                    }
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/ManagedObject.User"
                                    },
                                    "minItems": 0,
                                    "type": "array"
                                },
                                "examples": {
                                    "Removed user list": {
                                        "summary": "Example Removed User List",
                                        "description": "An example array of ManagedObject.User that represents those removed from specific privileged device assignment.",
                                        "value": [
                                            {
                                                "creationDate": "2023-10-21T15:24:47.970Z",
                                                "displayName": "Example User (Priv)",
                                                "firstName": "John",
                                                "lastName": "Doe",
                                                "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                                "upn": "priv-user@example.com",
                                                "securityClass": "Privileged",
                                                "uiEducation": false,
                                                "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                                                "intermediaryAssignmentList": [
                                                    "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                    "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                    "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                ],
                                                "siloAssignmentList": [
                                                    "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                    "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                    "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                ]
                                            }
                                        ]
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Remove User Assignments",
                "tags": [
                    "Device Management"
                ]
            },
            "get": {
                "description": "Lists all of the users that are currently assigned to the specified device.\n\nThis endpoint requires the `Device.Privileged.Read`, `Device.Privileged.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Defend/Device/:deviceId/Type/Privileged/Assign/Get",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/deviceId"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ObjectPage.ManagedUser"
                                },
                                "examples": {
                                    "Example response": {
                                        "summary": "Example Paged Response",
                                        "description": "An example of ObjectPage.ManagedUser returned that represents the list of users assigned to specific privileged device.",
                                        "value": {
                                            "@odata.count": 3,
                                            "@odata.nextLink": "2",
                                            "value": [
                                                {
                                                    "creationDate": "2023-10-21T15:24:47.970Z",
                                                    "displayName": "Example User (Priv)",
                                                    "firstName": "John",
                                                    "lastName": "Doe",
                                                    "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                                    "upn": "priv-user@example.com",
                                                    "securityClass": "Privileged",
                                                    "uiEducation": false,
                                                    "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                                                    "intermediaryAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ],
                                                    "siloAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ]
                                                },
                                                {
                                                    "creationDate": "2023-10-21T15:24:47.970Z",
                                                    "displayName": "Example User (Priv)",
                                                    "firstName": "John",
                                                    "lastName": "Doe",
                                                    "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                                    "upn": "priv-user@example.com",
                                                    "securityClass": "Privileged",
                                                    "uiEducation": false,
                                                    "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                                                    "intermediaryAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ],
                                                    "siloAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ],
                                                    "deviceAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ],
                                                    "generatedPassword": "GY_w7bZUKRgpIXctD0S2wg",
                                                    "parentId": "e59a3a64-dc36-4368-80ec-c205eb176ef6",
                                                    "temporaryAccessPass": "BCKTSN#E2R&5"
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "List User Assignments",
                "tags": [
                    "Device Management"
                ]
            },
            "post": {
                "description": "Adds the specified list of users to the list of users that are allowed to log in on the specific privileged device.\n\nThis endpoint requires the `Device.Privileged.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Defend/Device/:deviceId/Type/Privileged/Assign/Post",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/deviceId"
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "examples": {
                                "1:1 map": {
                                    "description": "This example is the security best practice of having only one user mapped to a managed device.",
                                    "summary": "1:1 User Mapping",
                                    "value": {
                                        "userList": [
                                            "0674276a-31e8-4773-8ed9-6fb49dbd0fa8"
                                        ]
                                    }
                                },
                                "Multi-User Managed Device": {
                                    "description": "This example is the security best practice of having multiple users mapped to a managed device.",
                                    "summary": "Multi-User Assignment",
                                    "value": {
                                        "userList": [
                                            "0674276a-31e8-4773-8ed9-6fb49dbd0fa8",
                                            "66714224-b1a6-4fd6-b9d8-5263fdf755fc"
                                        ]
                                    }
                                }
                            },
                            "schema": {
                                "properties": {
                                    "userList": {
                                        "items": {
                                            "examples": [
                                                "d1bc9d1a-5a30-4d66-898a-1dd300e707bc"
                                            ],
                                            "format": "uuid",
                                            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                            "type": "string"
                                        },
                                        "type": "array",
                                        "examples": [
                                            [
                                                "d1bc9d1a-5a30-4d66-898a-1dd300e707bc"
                                            ]
                                        ]
                                    }
                                },
                                "type": "object",
                                "examples": [
                                    {
                                        "userList": [
                                            "d1bc9d1a-5a30-4d66-898a-1dd300e707bc"
                                        ]
                                    }
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "items": {
                                        "$ref": "#/components/schemas/ManagedObject.User"
                                    },
                                    "minItems": 0,
                                    "type": "array"
                                },
                                "examples": {
                                    "List of Managed Users": {
                                        "summary": "Users Assigned to the Privileged Device",
                                        "description": "An example of ManagedObject.User array that represents the list of users which successfully assigned to the specified privileged device.",
                                        "value": [
                                            {
                                                "creationDate": "2023-10-21T15:24:47.970Z",
                                                "displayName": "Example User (Priv)",
                                                "firstName": "John",
                                                "lastName": "Doe",
                                                "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                                "upn": "priv-user@example.com",
                                                "securityClass": "Privileged",
                                                "uiEducation": false,
                                                "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                                                "intermediaryAssignmentList": [
                                                    "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                    "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                    "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                ],
                                                "siloAssignmentList": [
                                                    "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                    "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                    "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                ]
                                            }
                                        ]
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Add User Assignments",
                "tags": [
                    "Device Management"
                ]
            }
        },
        "/Api/Defend/Device/Type/{securityClass}": {
            "get": {
                "description": "Returns a list of all devices managed or unmanaged.\n\nThis endpoint requires the `Device.Privileged.Read`, `Device.Privileged.ReadWrite`, `Device.Specialized.Read`, `Device.Specialized.ReadWrite`, `Device.Enterprise.ReadWrite`, `Device.Enterprise.Read`, or the `Everything.ReadWrite` scope (permission). The security class parameter in the URL path corresponds to the same permission in the scope. That means if you are granted a privileged role, you can only call the privilege class URL. When reading the `unmanaged` objects, any security class permission can read them, no need for a specific `unmanaged` class assignment.",
                "operationId": "/Api/Defend/Device/Type/:securityClass/Get",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/securityClass"
                    },
                    {
                        "$ref": "#/components/parameters/nextLink"
                    },
                    {
                        "$ref": "#/components/parameters/search"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ObjectPage.ManagedDevice"
                                },
                                "examples": {
                                    "Managed device list": {
                                        "summary": "Example List of Managed Devices",
                                        "description": "An example paged result returned that represents a specific page of managed device list.",
                                        "value": {
                                            "@odata.count": 3,
                                            "@odata.nextLink": "2",
                                            "value": [
                                                {
                                                    "commissionedDate": "2023-02-04T05:06:09.601Z",
                                                    "displayName": "Priv-01534962354",
                                                    "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                                    "parentDeviceId": "81682cf5-0405-491d-8ab8-e07c778d7eaf",
                                                    "securityClass": "Privileged",
                                                    "uniqueGroupId": "146964e0-8ca4-4af0-9c2a-894b32912463"
                                                },
                                                {
                                                    "commissionedDate": "2023-02-04T05:06:09.601Z",
                                                    "displayName": "Priv-01534962354",
                                                    "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                                    "parentDeviceId": "81682cf5-0405-491d-8ab8-e07c778d7eaf",
                                                    "uniqueGroupId": "146964e0-8ca4-4af0-9c2a-894b32912463",
                                                    "groupAssignmentId": "830d8b6f-2f6f-41f7-8800-0c07445abd36",
                                                    "securityClass": "Privileged",
                                                    "userAssignmentId": "146964e0-8ca4-4af0-9c2a-894b32912463",
                                                    "userAssignmentList": [
                                                        "56d0d4e1-96f6-4cfb-a5e9-a4ee923169a8",
                                                        "94a9d681-a8d2-43eb-a83b-d4bfe90259ff",
                                                        "c54d4854-9254-4689-8a22-1cc80a3dae4e"
                                                    ]
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Get All Devices",
                "tags": [
                    "Device Management"
                ]
            },
            "post": {
                "description": "Commissions a new device, into the device hierarchy and appends appropriate metadata and initial policies. Appends required metadata to proper locations.\n\nThis endpoint requires the `Device.Privileged.ReadWrite`, `Device.Specialized.ReadWrite`, `Device.Enterprise.ReadWrite`, or the `Everything.ReadWrite` scope (permission). The security class parameter in the URL path corresponds to the same permission in the scope. That means if you are granted a privileged role, you can only call the privilege class URL.",
                "operationId": "/Api/Defend/Device/Type/:securityClass/Post",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/securityClass"
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "examples": {
                                "Request body": {
                                    "value": {
                                        "deviceId": "f7e1a66f-ce2e-4351-83df-2776813ef95d"
                                    },
                                    "summary": "Example Request Body",
                                    "description": "An example request body object that represents a request to commission the device specified in the deviceId field."
                                }
                            },
                            "schema": {
                                "properties": {
                                    "deviceId": {
                                        "description": "The SHIELD ID (Entra ID Device ID) of the device to target.",
                                        "examples": [
                                            "75da7fa4-4a04-44c8-8f2c-c1b2fa29aa51"
                                        ],
                                        "format": "uuid",
                                        "maxLength": 36,
                                        "minLength": 36,
                                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                        "type": "string"
                                    }
                                },
                                "required": [
                                    "deviceId"
                                ],
                                "type": "object",
                                "examples": [
                                    {
                                        "deviceId": "f7e1a66f-ce2e-4351-83df-2776813ef95d"
                                    }
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ManagedObject.Device"
                                },
                                "examples": {
                                    "Commissioned managed device": {
                                        "summary": "Example Managed Device Info",
                                        "description": "An example managed device object returned that represents a successfully commissioned device.",
                                        "value": {
                                            "commissionedDate": "2023-02-04T05:06:09.601Z",
                                            "displayName": "Priv-01534962354",
                                            "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                            "parentDeviceId": "81682cf5-0405-491d-8ab8-e07c778d7eaf",
                                            "securityClass": "Privileged",
                                            "uniqueGroupId": "146964e0-8ca4-4af0-9c2a-894b32912463"
                                        }
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Commission a New Device",
                "tags": [
                    "Device Management"
                ]
            }
        },
        "/Api/Defend/Device/Type/Privileged": {
            "get": {
                "description": "Returns a list of all privileged managed devices.\n\nThis endpoint requires the `Device.Privileged.Read`, `Device.Privileged.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Defend/Device/Type/Privileged/Get",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/nextLink"
                    },
                    {
                        "$ref": "#/components/parameters/search"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ObjectPage.ManagedPrivilegedDevice"
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Get All Privileged Devices",
                "tags": [
                    "Device Management"
                ]
            },
            "post": {
                "description": "Commissions a new device, into the device hierarchy and appends appropriate metadata and initial policies. Appends required metadata to proper locations.\n\nThis endpoint requires the `Device.Privileged.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Defend/Device/Type/Privileged/Post",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "example": {
                                "deviceId": "f7e1a66f-ce2e-4351-83df-2776813ef95d"
                            },
                            "schema": {
                                "properties": {
                                    "deviceId": {
                                        "description": "The SHIELD ID (Entra ID Device ID) of the device to target.",
                                        "example": "75da7fa4-4a04-44c8-8f2c-c1b2fa29aa51",
                                        "format": "uuid",
                                        "maxLength": 36,
                                        "minLength": 36,
                                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                        "type": "string"
                                    }
                                },
                                "required": [
                                    "deviceId"
                                ],
                                "type": "object"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ManagedObject.PrivilegedDevice"
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Commission a New PAW.",
                "tags": [
                    "Device Management"
                ]
            }
        },
        "/Api/Defend/Device/{deviceId}/Type/{securityClass}": {
            "delete": {
                "description": "Removes the device from the management hierarchy, removes metadata tagging and issues the wipe command to the devices.\n\nThis endpoint requires the `Device.Privileged.ReadWrite`, `Device.Specialized.ReadWrite`, `Device.Enterprise.ReadWrite`, or the `Everything.ReadWrite` scope (permission). The security class parameter in the URL path corresponds to the same permission in the scope. That means if you are granted a privileged role, you can only call the privilege class URL.",
                "operationId": "/Api/Defend/Device/:deviceId/Type/:securityClass/Delete",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/securityClass"
                    },
                    {
                        "$ref": "#/components/parameters/deviceId"
                    }
                ],
                "responses": {
                    "204": {
                        "description": "OK: Deleted successfully"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Decommission Specified Device",
                "tags": [
                    "Device Management"
                ]
            },
            "get": {
                "description": "Get the specified managed device by its Entra ID Device ID.\n\nThis endpoint requires the `Device.Privileged.Read`, `Device.Privileged.ReadWrite`, `Device.Specialized.Read`, `Device.Specialized.ReadWrite`, `Device.Enterprise.ReadWrite`, `Device.Enterprise.Read`, or the `Everything.ReadWrite` scope (permission). The security class parameter in the URL path corresponds to the same permission in the scope. That means if you are granted a privileged role, you can only call the privilege class URL.",
                "operationId": "/Api/Defend/Device/:deviceId/Type/:securityClass/Get",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/securityClass"
                    },
                    {
                        "$ref": "#/components/parameters/deviceId"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ManagedObject.Device"
                                },
                                "examples": {
                                    "Managed device": {
                                        "summary": "Example Managed Device",
                                        "description": "An example of ManagedObject.Device object returned that represents a managed device queried by a device ID with specified security class.",
                                        "value": {
                                            "commissionedDate": "2023-02-04T05:06:09.601Z",
                                            "displayName": "Priv-01534962354",
                                            "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                            "parentDeviceId": "81682cf5-0405-491d-8ab8-e07c778d7eaf",
                                            "securityClass": "Privileged",
                                            "uniqueGroupId": "146964e0-8ca4-4af0-9c2a-894b32912463"
                                        }
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Get Specified Device by ID",
                "tags": [
                    "Device Management"
                ]
            }
        },
        "/Api/Defend/User/Type/{securityClass}": {
            "get": {
                "description": "Returns a list of all devices managed or unmanaged.\n\nThis endpoint requires the `User.Privileged.Read`, `User.Privileged.ReadWrite`, `User.Specialized.Read`, `User.Specialized.ReadWrite`, `User.Enterprise.ReadWrite`, `User.Enterprise.Read`, or the `Everything.ReadWrite` scope (permission). The security class parameter in the URL path corresponds to the same permission in the scope. That means if you are granted a privileged role, you can only call the privilege class URL. When reading the `unmanaged` objects, any security class permission can read them, no need for a specific `unmanaged` class assignment.",
                "operationId": "/Api/Defend/User/Type/:securityClass/Get",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/securityClass"
                    },
                    {
                        "$ref": "#/components/parameters/nextLink"
                    },
                    {
                        "$ref": "#/components/parameters/search"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ObjectPage.ManagedUser"
                                },
                                "examples": {
                                    "Managed user": {
                                        "summary": "Example Paged User List",
                                        "description": "An examples of ObjectPage.ManagedUser returned that represents a page of a managed user list.",
                                        "value": {
                                            "@odata.count": 3,
                                            "@odata.nextLink": "2",
                                            "value": [
                                                {
                                                    "creationDate": "2023-10-21T15:24:47.970Z",
                                                    "displayName": "Example User (Priv)",
                                                    "firstName": "John",
                                                    "lastName": "Doe",
                                                    "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                                    "upn": "priv-user@example.com",
                                                    "securityClass": "Privileged",
                                                    "uiEducation": false,
                                                    "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                                                    "intermediaryAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ],
                                                    "siloAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ]
                                                },
                                                {
                                                    "creationDate": "2023-10-21T15:24:47.970Z",
                                                    "displayName": "Example User (Priv)",
                                                    "firstName": "John",
                                                    "lastName": "Doe",
                                                    "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                                    "upn": "priv-user@example.com",
                                                    "securityClass": "Privileged",
                                                    "uiEducation": false,
                                                    "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                                                    "intermediaryAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ],
                                                    "siloAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ],
                                                    "deviceAssignmentList": [
                                                        "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                        "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                        "995f3b39-1e01-40d4-9368-ee956343e97c"
                                                    ],
                                                    "generatedPassword": "GY_w7bZUKRgpIXctD0S2wg",
                                                    "parentId": "e59a3a64-dc36-4368-80ec-c205eb176ef6",
                                                    "temporaryAccessPass": "BCKTSN#E2R&5"
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Get All Users",
                "tags": [
                    "User Management"
                ]
            },
            "post": {
                "description": "For Specialized or Enterprise, adds existing user into management. For Privileged, securely clones the specified user's properties into a new managed user object in the privileged baselines.\n\nThis endpoint requires the `User.Privileged.ReadWrite`, `User.Specialized.ReadWrite`, `User.Enterprise.ReadWrite`, or the `Everything.ReadWrite` scope (permission). The security class parameter in the URL path corresponds to the same permission in the scope. That means if you are granted a privileged role, you can only call the privilege class URL.",
                "operationId": "/Api/Defend/User/Type/:securityClass/Post",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/securityClass"
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "examples": {
                                "Request body": {
                                    "value": {
                                        "userId": "d886680d-a283-4fc2-803f-370d81d62366"
                                    },
                                    "summary": "Example Request Body",
                                    "description": "An example object that represents a request to assign the specified user to target security class."
                                }
                            },
                            "schema": {
                                "properties": {
                                    "userId": {
                                        "description": "The Entra ID object ID of the user to clone.",
                                        "examples": [
                                            "264a8bed-0714-48fd-8b9d-0e4c4715cee5"
                                        ],
                                        "format": "uuid",
                                        "maxLength": 36,
                                        "minLength": 36,
                                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                        "type": "string"
                                    }
                                },
                                "required": [
                                    "userId"
                                ],
                                "type": "object",
                                "examples": [
                                    {
                                        "userId": "264a8bed-0714-48fd-8b9d-0e4c4715cee5"
                                    }
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ManagedObject.User"
                                },
                                "examples": {
                                    "Created or cloned user": {
                                        "summary": "Example User Created/Cloned",
                                        "description": "An example managed user object returned that represents the user brought into management successfully.",
                                        "value": {
                                            "creationDate": "2023-10-21T15:24:47.970Z",
                                            "displayName": "Example User (Priv)",
                                            "firstName": "John",
                                            "lastName": "Doe",
                                            "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                            "upn": "priv-user@example.com",
                                            "securityClass": "Privileged",
                                            "uiEducation": false,
                                            "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                                            "intermediaryAssignmentList": [
                                                "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                "995f3b39-1e01-40d4-9368-ee956343e97c"
                                            ],
                                            "siloAssignmentList": [
                                                "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                "995f3b39-1e01-40d4-9368-ee956343e97c"
                                            ]
                                        }
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    },
                    "409": {
                        "description": "User is already managed."
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Create/Bring User Into Management",
                "tags": [
                    "User Management"
                ]
            }
        },
        "/Api/Defend/User/Type/Privileged": {
            "get": {
                "description": "Returns a list of all privileged managed users.\n\nThis endpoint requires the `User.Privileged.Read`, `User.Privileged.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Defend/User/Type/Privileged/Get",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/nextLink"
                    },
                    {
                        "$ref": "#/components/parameters/search"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ObjectPage.ManagedPrivilegedUser"
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Get All Privileged Users",
                "tags": [
                    "User Management"
                ]
            },
            "post": {
                "description": "Securely clones the specified user's properties into a new managed user object in the privileged baselines.\n\nThis endpoint requires the `User.Privileged.ReadWrite`, or the `Everything.ReadWrite` scope (permission).",
                "operationId": "/Api/Defend/User/Type/Privileged/Post",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "example": {
                                "userId": "d886680d-a283-4fc2-803f-370d81d62366"
                            },
                            "schema": {
                                "properties": {
                                    "userId": {
                                        "description": "The Entra ID object ID of the user to clone.",
                                        "example": "264a8bed-0714-48fd-8b9d-0e4c4715cee5",
                                        "format": "uuid",
                                        "maxLength": 36,
                                        "minLength": 36,
                                        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                        "type": "string"
                                    }
                                },
                                "required": [
                                    "userId"
                                ],
                                "type": "object"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ManagedObject.PrivilegedUser"
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    },
                    "409": {
                        "description": "User is already managed."
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Create/Bring New Privileged User Into Management",
                "tags": [
                    "User Management"
                ]
            }
        },
        "/Api/Defend/User/{userId}/Type/{securityClass}": {
            "delete": {
                "description": "Deletes the user account and removes the management artifacts.\n\nThis endpoint requires the `User.Privileged.ReadWrite`, `User.Specialized.ReadWrite`, `User.Enterprise.ReadWrite`, or the `Everything.ReadWrite` scope (permission). The security class parameter in the URL path corresponds to the same permission in the scope. That means if you are granted a privileged role, you can only call the privilege class URL.",
                "operationId": "/Api/Defend/User/:userId/Type/:securityClass/Delete",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/securityClass"
                    },
                    {
                        "$ref": "#/components/parameters/userId"
                    }
                ],
                "responses": {
                    "204": {
                        "description": "OK: Deleted successfully"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Delete Managed User by ID",
                "tags": [
                    "User Management"
                ]
            },
            "get": {
                "description": "Retrieves the specified managed user by its Entra ID User ID.\n\nThis endpoint requires the `User.Privileged.Read`, `User.Privileged.ReadWrite`, `User.Specialized.Read`, `User.Specialized.ReadWrite`, `User.Enterprise.ReadWrite`, `User.Enterprise.Read`, or the `Everything.ReadWrite` scope (permission). The security class parameter in the URL path corresponds to the same permission in the scope. That means if you are granted a privileged role, you can only call the privilege class URL.",
                "operationId": "/Api/Defend/User/:userId/Type/:securityClass/Get",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/securityClass"
                    },
                    {
                        "$ref": "#/components/parameters/userId"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ManagedObject.User"
                                },
                                "examples": {
                                    "Removed user": {
                                        "summary": "Example Removed User",
                                        "description": "An example of managed user returned that represents the user has been removed from specified security class successfully.",
                                        "value": {
                                            "creationDate": "2023-10-21T15:24:47.970Z",
                                            "displayName": "Example User (Priv)",
                                            "firstName": "John",
                                            "lastName": "Doe",
                                            "id": "9f237e13-9a04-4daf-b3d4-6d2beec3c2bf",
                                            "upn": "priv-user@example.com",
                                            "securityClass": "Privileged",
                                            "uiEducation": false,
                                            "uniqueGroupId": "ad402c42-1bc9-4ba5-9419-7dbfb46a9c4d",
                                            "intermediaryAssignmentList": [
                                                "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                "995f3b39-1e01-40d4-9368-ee956343e97c"
                                            ],
                                            "siloAssignmentList": [
                                                "0390fb3e-c58b-4d73-b02c-eae41ec5e4a5",
                                                "593d97dc-9a43-4bc7-9d79-ecde407d7782",
                                                "995f3b39-1e01-40d4-9368-ee956343e97c"
                                            ]
                                        }
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Gets Managed User by ID",
                "tags": [
                    "User Management"
                ]
            }
        },
        "/Api/Defend/Marketplace/Type/{securityClass}/Offering/{offeringId}": {
            "post": {
                "description": "Creates the offering with the requested settings. In the body payload, the `type` property in the `property` object is ignored. See the AVD example.\n\nThis endpoint requires the `Intermediary.Privileged.ReadWrite`, `Intermediary.Specialized.ReadWrite`, `Intermediary.Enterprise.ReadWrite`, or the `Everything.ReadWrite` scope (permission). The security class parameter in the URL path corresponds to the same permission in the scope. That means if you are granted a privileged role, you can only call the privilege class URL.",
                "operationId": "/Api/Defend/Marketplace/Type/:securityClass/Offering/:offeringId/Post",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/securityClass"
                    },
                    {
                        "$ref": "#/components/parameters/offeringId"
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "allOf": [
                                    {
                                        "$ref": "#/components/schemas/ManagedObject.Intermediary"
                                    },
                                    {
                                        "properties": {
                                            "properties": {
                                                "$ref": "#/components/schemas/ManagedObject.AvdIntermediary"
                                            }
                                        },
                                        "type": "object"
                                    }
                                ],
                                "examples": [
                                    {
                                        "name": "Legacy Reach Back",
                                        "properties": {
                                            "addressRangeCIDR": "172.16.1.0/24",
                                            "index": 0,
                                            "location": "East US 2",
                                            "sessionHostPrefix": "Reach",
                                            "vmSku": "Standard_D2s_v5"
                                        }
                                    }
                                ]
                            },
                            "examples": {
                                "Example intermediary object request": {
                                    "summary": "Example Intermediary Object Request",
                                    "description": "An example of create offering request body with minimal fields.",
                                    "value": {
                                        "id": "e097a3f5-9599-44a2-8923-fd3276c83ae1",
                                        "kind": "AVD",
                                        "name": "Legacy Reach Back",
                                        "securityClass": "Privileged",
                                        "properties": {
                                            "addressRangeCIDR": "172.16.1.0/24",
                                            "index": 0,
                                            "location": "East US 2",
                                            "sessionHostPrefix": "Reach",
                                            "vmSku": "Standard_D2s_v5"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ManagedObject.AvdIntermediary"
                                },
                                "examples": {
                                    "Returned AVD intermediary": {
                                        "summary": "Example AVD Intermediary Returned",
                                        "description": "An example of AVD intermediary object returned that represents an successfully deployed offering.",
                                        "value": {
                                            "addressRangeCIDR": "172.16.1.0/24",
                                            "assignmentGroup": "68873e26-3c35-465c-9422-0884a00beb36",
                                            "index": 0,
                                            "location": "East US 2",
                                            "resourceId": "/subscriptions/742f0d26-daa0-4f84-8d4f-fb052f89f639/resourceGroups/SHIELD_-_PSM-Legacy_Reach_Back/providers/Microsoft.DesktopVirtualization/hostpools/SHIELD_-_PSM-Cluster-Legacy_Reach_Back",
                                            "sessionHostGroup": "f99f0918-da9b-4c58-9a8d-9346abc5d9ec",
                                            "sessionHostPrefix": "Reach",
                                            "vmSku": "Standard_D2s_v5"
                                        }
                                    }
                                }
                            }
                        },
                        "description": "OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/401"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    },
                    "525": {
                        "$ref": "#/components/responses/525"
                    }
                },
                "summary": "Deploy Marketplace Offering",
                "tags": [
                    "Marketplace"
                ]
            }
        }
    },
    "security": [
        {
            "EntraID": []
        }
    ],
    "servers": [
        {
            "description": "The service",
            "url": "/"
        }
    ],
    "tags": [
        {
            "description": "Configures the specified web server to support and process the authentication API routes.",
            "name": "Core"
        },
        {
            "description": "Used to manage UI and API authentication.",
            "name": "Authentication"
        },
        {
            "description": "License report creation and retrieval.",
            "name": "Discover"
        },
        {
            "description": "Device lifecycle management.",
            "name": "Device Management"
        },
        {
            "description": "User lifecycle management.",
            "name": "User Management"
        },
        {
            "description": "Manages the lifecycle of the various intermediary system types.",
            "name": "Intermediary"
        },
        {
            "description": "Metadata and deployment management for market offerings. Lifecycle management is not handled in this route.",
            "name": "Marketplace"
        },
        {
            "description": "Collection of tasks to perform deploy or removal of the infrastructure entities, evaluate details of the resources, handle restoration steps, and support handling architecture/configuration choices from the user.",
            "name": "Deploy"
        },
        {
            "description": "Manage the updates for SHIELD and the policies deployed into the managed environment.",
            "name": "Update"
        }
    ]
}