Analyze and Risk Assessment APIs

Get Analyze Scenarios (GET)

Returns all available analysis scenarios.

Route

URI	/api/v1/Analyze/Scenarios
Method	GET
Result	JSON - Array of ScenarioModel

Parameters

None

Example

GET http://localhost/api/v1/Analyze/Scenarios
[
    {
        "Label": "All Scenarios",
        "Scenarios": [
            {
                "ScenarioId": "f53edb73-380a-47ac-83dd-2da23913d8e3",
                "ScenarioGroupId": "adusers",
                "Label": "Accounts with never expiring password",
                "GroupLabel": "AD users",
                "Description": "Create a list of all user accounts whose passwords do not expire. Change the password options in Bulk.",
                "GroupOrderValue": 1
            },
            {
                "ScenarioId": "0d55d530-e6b4-4955-add0-52d090c2156d",
                "ScenarioGroupId": "adusers",
                "Label": "All AD user accounts",
                "GroupLabel": "AD users",
                "Description": "Create a list of all Active Directory user accounts for one or more domains.",
                "GroupOrderValue": 1
            },
…
]
    }
]

Get Analyze Configuration (GET)

Returns analysis configuration settings.

Route

URI	/api/v1/Analyze/Configuration
Method	GET
Result	JSON – AnalyzeConfigurationModel

Parameters

None

Example

GET http://localhost/api/v1/Analyze/Configuration
{
    "Type": "Container",
    "label": "Analyze Configuration",
    "templates": [
        {
        "key": "AnalyzeConfigurationCredential_script",
            "value": {
            "Type": "CollapsibleContainer",
                "isCollapsed": false,
                "label": "Script credentials",
                "templates": [
                    {
                "key": "AnalyzeConfigurationCredential_userid",
                        "value": {
                    "Type": "TextField",
                            "postfixText": null,
                            "dynamicQuery": null,
                            "dynamicResultWasSet": false,
                            "isRequired": false,
                            "constraints": null,
                            "summary": null,
                            "value": null,
                            "defaultValue": null,
                            "description": null,
                            "customError": null,
                            "allowApply": true,
                            "label": "Userid",
                            "isEnabled": true,
                            "isEnabledRule": null,
                            "parsedIsEnabledRule": null,
                            "customAttributes": null,
                            "isHidden": false,
                            "isVisibleRule": null,
                            "parsedIsVisibleRule": null
                        }
            },
            ...      
                ],
                "summary": null,
                "customAttributes": null,
                "isHidden": false,
                "isVisibleRule": null,
                "parsedIsVisibleRule": null
            }
    }

Get Scenario Form Template (GET)

Returns the form template for a specific scenario.

Route

URI	/api/v1/Analyze/Scenario/{id}/Form
Method	GET
Result	JSON – FormTemplateModel

Parameters

Scenario Identifier (Guid)

Example

GET http://localhost/api/v1/Analyze/Scenario/123e4567-e89b-12d3-a456-426614174000/Form
{
    "Type": "Container",
    "label": null,
    "templates": [
        {
        "key": "daterange",
            "value": {
            "Type": "DateRangePicker",
                "summary": "9/16/2025 - 12/17/2025",
                "startDate": "2025-09-16T22:00:00Z",
                "endDate": "2025-12-17T23:00:00Z",
                "isEndDateOptional": false,
                "startDateMayBeInThePast": true,
                "label": "Only orders placed within the specified date range are shown.",
                "isEnabled": true,
                "isEnabledRule": null,
                "parsedIsEnabledRule": null,
                "customAttributes": null,
                "isHidden": false,
                "isVisibleRule": null,
                "parsedIsVisibleRule": null
            }
    },
 ...
    ],
    "summary": null,
    "customAttributes": null,
    "isHidden": false,
    "isVisibleRule": null,
    "parsedIsVisibleRule": null
}

Get Scenario Form Template By Result (GET)

Returns the form template for a scenario based on a result.

Route

URI	/api/v1/Analyze/Scenario/{scenarioid}/result/{resultid}/Form
Method	GET
Result	JSON – FormTemplateModel

Parameters

• scenarioid - The scenario identifier

• resultid - The result identifier

Example

GET http://localhost/api/v1/Analyze/Scenario/123e4567-e89b-12d3-a456-426614174000/result/456e4567-e89b-12d3-a456-426614174000/Form
{
    "Type": "Container",
    "label": null,
    "templates": [
        {
        "key": "daterange",
            "value": {
            "Type": "DateRangePicker",
                "summary": "9/16/2025 - 12/17/2025",
                "startDate": "2025-09-16T22:00:00Z",
                "endDate": "2025-12-17T23:00:00Z",
                "isEndDateOptional": false,
                "startDateMayBeInThePast": true,
                "label": "Only orders placed within the specified date range are shown.",
                "isEnabled": true,
                "isEnabledRule": null,
                "parsedIsEnabledRule": null,
                "customAttributes": null,
                "isHidden": false,
                "isVisibleRule": null,
                "parsedIsVisibleRule": null
            }
    },
 ...
    ],
    "summary": null,
    "customAttributes": null,
    "isHidden": false,
    "isVisibleRule": null,
    "parsedIsVisibleRule": null
}

Get Scenario Request (GET)

Returns details of a scenario request.

Route

URI	/api/v1/Analyze/Scenario/Request/{id}
Method	GET
Result	JSON – ScenarioRequestModel

Parameters

The request identifier.

Example

GET http://localhost/api/v1/Analyze/Scenario/Request/123e4567-e89b-12d3-a456-426614174000

Get Scenario Result (GET)

Returns the result of a scenario analysis.

Route

URI	/api/v1/Analyze/Scenario/Result/{requestId}
Method	GET
Result	JSON – ScenarioResultModel

Parameters

The request identifier.

Example

GET http://localhost/api/v1/Analyze/Scenario/Result/123e4567-e89b-12d3-a456-426614174000

Get Scenario Summary (GET)

Returns summary information for a scenario.

Route

URI	/api/v1/Analyze/Scenario/{id}/Summary
Method	GET
Result	JSON – ScenarioSummaryModel

Parameters

The scenario identifier.

Example

GET http://localhost/api/v1/Analyze/Scenario/123e4567-e89b-12d3-a456-426614174000/Summary

{
  "Type": "65B0ECF7-9BA8-45CE-9D20-8CB1CADC4416",
  "title": "My staff members",
  "scenarioId": "5f0d76a6-ea1a-403d-8efe-5153314ab132",
  "text": "67",
  "systemStatus": 3,
  "diagram": null
}

Get Supported Actions for Scenario (GET)

Returns actions supported by a specific scenario.

Route

URI	/api/v1/Analyze/Scenario/{id}/SupportedActions
Method	GET
Result	JSON – Array of ActionModel

Parameters

The scenario identifier.

Example

GET http://localhost/api/v1/Analyze/Scenario/123e4567-e89b-12d3-a456-426614174000/SupportedActions

Refresh Scenario (POST)

Refreshes a scenario analysis.

Route

URI	/api/v1/Analyze/Scenario/{requestId}/Refresh
Method	POST
Result	JSON – RefreshResult

Parameters

Name	Type	Mandatory	Description
requestId	Guid	Yes	The request identifier (in URL path

Example

POST http://localhost/api/v1/Analyze/Scenario/123e4567-e89b-12d3-a456-426614174000/Refresh

Get Action Form Template (GET)

Returns the form template for a specific action.

Route

URI	/api/v1/Analyze/Action/{id}/Form
Method	GET
Result	JSON – FormTemplateModel

Parameters

Name	Type	Mandatory	Description
requestId	Guid	Yes	The request identifier (in URL path

Example

GET http://localhost/api/v1/Analyze/Action/ 0d4713ae-9460-493f-8521-55c65a7f99c6/Form
{
    "Type": "Container",
    "label": null,
    "templates": [
        {
        "key": "daterange",
            "value": {
            "Type": "DateRangePicker",
                "summary": "9/16/2025 - 12/17/2025",
                "startDate": "2025-09-16T22:00:00Z",
                "endDate": "2025-12-17T23:00:00Z",
                "isEndDateOptional": false,
                "startDateMayBeInThePast": true,
                "label": "Only orders placed within the specified date range are shown.",
                "isEnabled": true,
                "isEnabledRule": null,
                "parsedIsEnabledRule": null,
                "customAttributes": null,
                "isHidden": false,
                "isVisibleRule": null,
                "parsedIsVisibleRule": null
            }
    },
 ...
    ],
    "summary": null,
    "customAttributes": null,
    "isHidden": false,
    "isVisibleRule": null,
    "parsedIsVisibleRule": null
}

Get Action Next Form Template (GET)

Returns the next form template in a multi-step action.

Route

URI	/api/v1/Analyze/Action/{id}/NextForm
Method	GET
Result	JSON – FormTemplateModel

Parameters

Name	Type	Mandatory	Description
requestId	Guid	Yes	The request identifier (in URL path)

Example

GET http://localhost/api/v1/Analyze/Action/0d4713ae-9460-493f-8521-55c65a7f99c6/NextForm
{
    "Type": "Container",
    "label": null,
    "templates": [
        {
        "key": "daterange",
            "value": {
            "Type": "DateRangePicker",
                "summary": "9/16/2025 - 12/17/2025",
                "startDate": "2025-09-16T22:00:00Z",
                "endDate": "2025-12-17T23:00:00Z",
                "isEndDateOptional": false,
                "startDateMayBeInThePast": true,
                "label": "Only orders placed within the specified date range are shown.",
                "isEnabled": true,
                "isEnabledRule": null,
                "parsedIsEnabledRule": null,
                "customAttributes": null,
                "isHidden": false,
                "isVisibleRule": null,
                "parsedIsVisibleRule": null
            }
    },
 ...
    ],
    "summary": null,
    "customAttributes": null,
    "isHidden": false,
    "isVisibleRule": null,
    "parsedIsVisibleRule": null
}

Execute Analyze Action (POST)

Executes an analysis action.

Route

URI	/api/v1/Analyze/Action/{id}/Execute
Method	POST
Result	JSON – ActionExecutionResult

Request Payload

Action execution parameters object:

Property	Type	Mandatory	Description
ActionId	string	Yes	Action identifier
Parameters	object	Yes	Action-specific parameter values
TargetObjects	string[]	No	Target objects for the action

Response Structure

ActionExecutionResult containing execution status and results.

Example Request

POST http://localhost/api/v1/Analyze/Action/41f47b8f-1ed8-4b7a-ba65-eec6ea14fcd1/Execute
Content-Type: application/json

{
  "ActionId": "remediation_action",
  "Parameters": {
    "RemediationLevel": "Medium",
    "NotifyUsers": true
  },
  "TargetObjects": ["user1@contoso.com"]
}

Example Response

{
  "Success": true,
  "Message": "Action executed successfully",
  "Data": {
    "ItemsProcessed": 1,
    "Status": "Completed"
  },
  "Errors": []
}

Create Analyze Report (POST)

Creates a report for analysis scenarios.

Route

URI	/api/v1/Analyze/Scenario/Report
Method	POST
Result	JSON – ReportCreationResult

Request Payload

Report generation parameters object:

Property	Type	Mandatory	Description
ScenarioId	Guid	Yes	Scenario identifier to report on
ReportFormat	string	No	Format (PDF, Excel, HTML)
IncludeDetails	bool	No	Include detailed information
DateRange	object	No	Date range for the report

Response Structure

ReportCreationResult containing:

• ReportId: Guid of the generated report

• DownloadUrl: URL to download the report

• Status: Report generation status

Example Request

POST http://localhost/api/v1/Analyze/Scenario/Report
Content-Type: application/json

{
  "ScenarioId": "123e4567-e89b-12d3-a456-426614174000",
  "ReportFormat": "PDF",
  "IncludeDetails": true,
  "DateRange": {
    "StartDate": "2024-01-01",
    "EndDate": "2024-12-31"
  }
}

Example Response

{
  "ReportId": "456e4567-e89b-12d3-a456-426614174000",
  "DownloadUrl": "/api/v1/reports/456e4567-e89b-12d3-a456-426614174000",
  "Status": "Completed"
}

Get Scenario Dashboard Configurations (GET)

Returns dashboard configurations for analysis scenarios.

Route

URI	/api/v1/Analyze/Dashboard
Method	GET
Result	JSON – Array of DashboardConfigurationModel

Parameters

None

Example

GET http://localhost/api/v1/Analyze/Dashboard

Get Alert Events (GET)

Returns alert events for analysis.

Route

URI	/api/v1/Analyze/Action/GetAlertEvents
Method	GET
Result	JSON – Array of AlertEventModel

Parameters

None

Example

GET http://localhost/api/v1/Analyze/Action/GetAlertEvents
[
    {
        "EventType": {
            "Id": "8657c82f-ae3c-42db-a279-2bc46f28c984"
        },
        "ResourceType": 1,
        "DisplayName": "Account locked",
        "HasCustomizableSettings": false
    },
    {
        "EventType": {
            "Id": "d91e08d6-74de-4e40-a539-29bebd4e0e79"
        },
        "DisplayName": "Changes in directory",
        "InvestigationDepth": 0,
        "Id": "47677d25-8758-43cf-9af6-2a2b0252b9f0",
        "ResourceType": 2,
        "HasCustomizableSettings": true,
        "ObservedFileSystemChanges": 0,
        "BlacklistAccounts": [],
        "BlacklistDirectories": []
    }
]

Get File System Change Events (GET)

Returns file system change events.

Route

URI	/api/v1/Analyze/Action/GetFileSystemChange
Method	GET
Result	JSON – Array of FileSystemChangeModel

Parameters

None

Example

GET http://localhost/api/v1/Analyze/Action/GetFileSystemChange
{
    "FileChanges": [
        {
            "Code": 1,
            "Name": "File Read"
        },
        {
            "Code": 2,
            "Name": "File Written"
        },
        {
            "Code": 8,
            "Name": "File Created"
        },
        {
            "Code": 32,
            "Name": "File Moved Or Renamed"
        },
        {
            "Code": 128,
            "Name": "File Deleted"
        },
        {
            "Code": 256,
            "Name": "File Permission Acl Changed"
        }
    ],
  …
}
 

Get Timezone Info (GET)

Returns timezone information for analysis.

Route

URI	/api/v1/Analyze/Action/GetTimeZoneInfo
Method	GET
Result	JSON – Array of TimezoneModel

Parameters

None

Example

GET http://localhost/api/v1/Analyze/Action/GetTimeZoneInfo
[
    {
        "Key": "Dateline Standard Time",
        "Value": "(UTC-12:00) International Date Line West"
    },
    {
        "Key": "UTC-11",
        "Value": "(UTC-11:00) Coordinated Universal Time-11"
    },
…
]

Get Supported Culture (GET)

Returns supported cultures/languages for analysis.

Route

URI	/api/v1/Analyze/Action/GetSupportedCulture
Method	GET
Result	JSON – Array of CultureModel

Parameters

None

Example

GET http://localhost/api/v1/Analyze/Action/GetSupportedCulture
[
    {
        "Key": "en-US",
        "Value": "English"
    },
    {
        "Key": "de-DE",
        "Value": "Deutsch"
    },
    {
        "Key": "fr-FR",
        "Value": "français"
    }
]