API Reference

Methods

ADCollector

AttributeSearch

AuditorService

Authorization

Azure

AzureBackup

AzureObjects

Backup

Charts

CollectorStatusCheckConfiguration

ConfigurationString

DataPurge

Database

DatabaseConnector

DelegatedResource

DirectoryObject

Domains

Event

FileSystem

Filter

HealthCheck

IIS

Identity

License

Log

Logging

Office365

Permission

Profile

Protection

Proxy

Recovery

RemoteLoggerConfiguration

Report

ReportStyling

Role

ScheduledJob

Scheduler

Search

ServiceCommand

Setup

Smtp

System

SystemConfiguration

Tag

User

UserConfiguration

VMWare

ADCollector

Up
get /api/v{version}/collectors/activedirectory/collectors
(apiVversionCollectorsActivedirectoryCollectorsGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "domainController" : "domainController",
  "backupPassword" : "backupPassword",
  "backupCollectionInterval" : 6,
  "description" : "description",
  "dnsName" : "dnsName",
  "namingContext" : 1,
  "backupCredentials" : {
    "password" : "password",
    "username" : "username"
  },
  "backupAccountName" : "backupAccountName",
  "enabled" : true,
  "scope" : 5,
  "name" : "name",
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "customDN" : "customDN",
  "id" : 0,
  "fullBackup" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ADBackupConfiguration

Up
delete /api/v{version}/collectors/activedirectory/collectors/{id}
(apiVversionCollectorsActivedirectoryCollectorsIdDelete)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/collectors/activedirectory/collectors/{id}
(apiVversionCollectorsActivedirectoryCollectorsIdGet)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Responses

200

Success

Up
post /api/v{version}/collectors/activedirectory/collectors
(apiVversionCollectorsActivedirectoryCollectorsPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ADBackupConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
put /api/v{version}/collectors/activedirectory/collectors
(apiVversionCollectorsActivedirectoryCollectorsPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ADBackupConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
post /api/v{version}/collectors/activedirectory/collectors/search/domaincontrollers
(apiVversionCollectorsActivedirectoryCollectorsSearchDomaincontrollersPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DomainControllerSearch (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "lastActive" : "2000-01-23T04:56:07.000+00:00",
  "statusMessage" : "statusMessage",
  "enabled" : true,
  "sid" : "sid",
  "netBiosName" : "netBiosName",
  "hasAgent" : true,
  "osVersion" : "osVersion",
  "domain" : "domain",
  "name" : "name",
  "agentVersion" : "agentVersion",
  "id" : 6,
  "upgradeRequired" : true,
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DomainController

AttributeSearch

Up
get /api/v{version}/collectors/activedirectory/attributes/search/displaynames
(apiVversionCollectorsActivedirectoryAttributesSearchDisplaynamesGet)

Path parameters

version (required)
Path Parameter

Query parameters

limit (optional)
Query Parameter — default: 0 format: int32
displayname (optional)
Query Parameter

Return type

array[String]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
get /api/v{version}/collectors/activedirectory/attributes/search
(apiVversionCollectorsActivedirectoryAttributesSearchGet)

Path parameters

version (required)
Path Parameter

Query parameters

limit (optional)
Query Parameter — format: int32
name (optional)
Query Parameter
displayname (optional)
Query Parameter
isClass (optional)
Query Parameter — default: false

Return type

Example data

Content-Type: application/json
[ {
  "isClass" : true,
  "displayValue" : "displayValue",
  "linkId" : 1,
  "systemOnly" : true,
  "displayName" : "displayName",
  "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "values" : [ "", "" ],
  "name" : "name",
  "aDsType" : 6,
  "id" : 0,
  "isOID" : true,
  "syntaxOID" : "syntaxOID"
}, {
  "isClass" : true,
  "displayValue" : "displayValue",
  "linkId" : 1,
  "systemOnly" : true,
  "displayName" : "displayName",
  "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "values" : [ "", "" ],
  "name" : "name",
  "aDsType" : 6,
  "id" : 0,
  "isOID" : true,
  "syntaxOID" : "syntaxOID"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
get /api/v{version}/collectors/activedirectory/attributes/search/names
(apiVversionCollectorsActivedirectoryAttributesSearchNamesGet)

Path parameters

version (required)
Path Parameter

Query parameters

limit (optional)
Query Parameter — default: 0 format: int32
name (optional)
Query Parameter

Return type

array[String]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

AuditorService

Up
get /api/v{version}/system/config/service/all/status
(apiVversionSystemConfigServiceAllStatusGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
[ {
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serviceDisplayName" : "serviceDisplayName",
  "serviceName" : "serviceName",
  "status" : 0
}, {
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serviceDisplayName" : "serviceDisplayName",
  "serviceName" : "serviceName",
  "status" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
get /api/v{version}/system/config/service
(apiVversionSystemConfigServiceGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "serviceSocket" : {
    "encrypted" : true,
    "port" : 6,
    "serverAddress" : "serverAddress",
    "type" : 0
  },
  "userCredentials" : {
    "password" : "password",
    "username" : "username"
  },
  "isRunAsLocalSystem" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ServiceConfigurationWeb

Up
post /api/v{version}/system/config/service/{id}/restart
(apiVversionSystemConfigServiceIdRestartPost)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serviceDisplayName" : "serviceDisplayName",
  "serviceName" : "serviceName",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygnaAuditorService

Up
post /api/v{version}/system/config/service/{id}/start
(apiVversionSystemConfigServiceIdStartPost)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serviceDisplayName" : "serviceDisplayName",
  "serviceName" : "serviceName",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygnaAuditorService

Up
get /api/v{version}/system/config/service/{id}/status
(apiVversionSystemConfigServiceIdStatusGet)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serviceDisplayName" : "serviceDisplayName",
  "serviceName" : "serviceName",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygnaAuditorService

Up
post /api/v{version}/system/config/service/{id}/stop
(apiVversionSystemConfigServiceIdStopPost)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serviceDisplayName" : "serviceDisplayName",
  "serviceName" : "serviceName",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygnaAuditorService

Up
post /api/v{version}/system/config/service
(apiVversionSystemConfigServicePost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ServiceConfigurationWeb (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "serviceSocket" : {
    "encrypted" : true,
    "port" : 6,
    "serverAddress" : "serverAddress",
    "type" : 0
  },
  "userCredentials" : {
    "password" : "password",
    "username" : "username"
  },
  "isRunAsLocalSystem" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ServiceConfigurationWeb

Up
put /api/v{version}/system/config/service
(apiVversionSystemConfigServicePut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ServiceConfigurationWeb (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "serviceSocket" : {
    "encrypted" : true,
    "port" : 6,
    "serverAddress" : "serverAddress",
    "type" : 0
  },
  "userCredentials" : {
    "password" : "password",
    "username" : "username"
  },
  "isRunAsLocalSystem" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ServiceConfigurationWeb

Authorization

Up
post /api/v{version}/auth/login
(apiVversionAuthLoginPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body UserProfile (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "password" : "password",
  "displayName" : "displayName",
  "userAccount" : "userAccount",
  "userSid" : "userSid",
  "userCid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "handle" : 3,
  "userDomain" : "userDomain",
  "userGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "user" : "user",
  "config" : {
    "applicationTheme" : "applicationTheme",
    "consoleOptions" : "consoleOptions",
    "applicationSettings" : {
      "enableAutoSearch" : true,
      "reportEventLimit" : 9,
      "enableAuditPaging" : true,
      "rollbackLayout" : [ null, null ],
      "auditEventLimit" : 7,
      "auditingLayout" : [ {
        "isIntersecting" : true,
        "hover" : {
          "addAction" : 5,
          "removeAction" : 2,
          "field" : "field",
          "position" : "position"
        },
        "visible" : true,
        "sources" : [ 0, 0 ],
        "isMetaEventColumn" : true,
        "name" : "name",
        "width" : {
          "default" : 1,
          "value" : 6,
          "minimum" : 5
        },
        "header" : "header",
        "position" : "position",
        "type" : "type"
      }, {
        "isIntersecting" : true,
        "hover" : {
          "addAction" : 5,
          "removeAction" : 2,
          "field" : "field",
          "position" : "position"
        },
        "visible" : true,
        "sources" : [ 0, 0 ],
        "isMetaEventColumn" : true,
        "name" : "name",
        "width" : {
          "default" : 1,
          "value" : 6,
          "minimum" : 5
        },
        "header" : "header",
        "position" : "position",
        "type" : "type"
      } ],
      "isSideMenuExpanded" : true
    }
  },
  "groupSids" : [ "groupSids", "groupSids" ],
  "token" : "token"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success UserProfile

Up
post /api/v{version}/auth/login/refresh
(apiVversionAuthLoginRefreshPost)

Path parameters

version (required)
Path Parameter

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success String

Up
get /api/v{version}/auth/logout
(apiVversionAuthLogoutGet)

Path parameters

version (required)
Path Parameter

Return type

Boolean

Example data

Content-Type: application/json
true

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Boolean

Azure

Up
delete /api/v{version}/collectors/azure/globalRateLimiting
(apiVversionCollectorsAzureGlobalRateLimitingDelete)

Path parameters

version (required)
Path Parameter

Responses

200

Success

Up
put /api/v{version}/collectors/azure/globalRateLimiting
(apiVversionCollectorsAzureGlobalRateLimitingPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body RequestLock (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "maxLocks" : 0,
  "enabled" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success RequestLock

Up
get /api/v{version}/collectors/azure/targets
(apiVversionCollectorsAzureTargetsGet)

Path parameters

version (required)
Path Parameter

Return type

array[Target]

Example data

Content-Type: application/json
[ {
  "lastActive" : "2000-01-23T04:56:07.000+00:00",
  "displayName" : "displayName",
  "lastCollection" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "tenantCode" : "tenantCode",
  "config" : {
    "parallelResourceResolutionRequests" : 2,
    "subscriptions" : [ "subscriptions", "subscriptions" ],
    "subscriptionResourceTypes" : [ "subscriptionResourceTypes", "subscriptionResourceTypes" ],
    "dataCollectionTimeout" : 1,
    "collectResourceData" : true,
    "collectAllSubscriptions" : true,
    "tenantActivityCollection" : true,
    "initialCollectionOffset" : 7,
    "activityLogCollectionSkew" : 5,
    "activityLogCollectionTimeout" : 5,
    "tenantResourceTypes" : [ "tenantResourceTypes", "tenantResourceTypes" ],
    "ignoredItems" : [ "ignoredItems", "ignoredItems" ],
    "ignoredOperations" : [ "ignoredOperations", "ignoredOperations" ],
    "ignoredStatuses" : [ "ignoredStatuses", "ignoredStatuses" ],
    "resolveConfigurationObjects" : true
  },
  "collectionInterval" : 9,
  "enabled" : true,
  "status" : 6
}, {
  "lastActive" : "2000-01-23T04:56:07.000+00:00",
  "displayName" : "displayName",
  "lastCollection" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "tenantCode" : "tenantCode",
  "config" : {
    "parallelResourceResolutionRequests" : 2,
    "subscriptions" : [ "subscriptions", "subscriptions" ],
    "subscriptionResourceTypes" : [ "subscriptionResourceTypes", "subscriptionResourceTypes" ],
    "dataCollectionTimeout" : 1,
    "collectResourceData" : true,
    "collectAllSubscriptions" : true,
    "tenantActivityCollection" : true,
    "initialCollectionOffset" : 7,
    "activityLogCollectionSkew" : 5,
    "activityLogCollectionTimeout" : 5,
    "tenantResourceTypes" : [ "tenantResourceTypes", "tenantResourceTypes" ],
    "ignoredItems" : [ "ignoredItems", "ignoredItems" ],
    "ignoredOperations" : [ "ignoredOperations", "ignoredOperations" ],
    "ignoredStatuses" : [ "ignoredStatuses", "ignoredStatuses" ],
    "resolveConfigurationObjects" : true
  },
  "collectionInterval" : 9,
  "enabled" : true,
  "status" : 6
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
delete /api/v{version}/collectors/azure/targets/{id}
(apiVversionCollectorsAzureTargetsIdDelete)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/collectors/azure/targets/{id}
(apiVversionCollectorsAzureTargetsIdGet)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "lastActive" : "2000-01-23T04:56:07.000+00:00",
  "displayName" : "displayName",
  "lastCollection" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "tenantCode" : "tenantCode",
  "config" : {
    "parallelResourceResolutionRequests" : 2,
    "subscriptions" : [ "subscriptions", "subscriptions" ],
    "subscriptionResourceTypes" : [ "subscriptionResourceTypes", "subscriptionResourceTypes" ],
    "dataCollectionTimeout" : 1,
    "collectResourceData" : true,
    "collectAllSubscriptions" : true,
    "tenantActivityCollection" : true,
    "initialCollectionOffset" : 7,
    "activityLogCollectionSkew" : 5,
    "activityLogCollectionTimeout" : 5,
    "tenantResourceTypes" : [ "tenantResourceTypes", "tenantResourceTypes" ],
    "ignoredItems" : [ "ignoredItems", "ignoredItems" ],
    "ignoredOperations" : [ "ignoredOperations", "ignoredOperations" ],
    "ignoredStatuses" : [ "ignoredStatuses", "ignoredStatuses" ],
    "resolveConfigurationObjects" : true
  },
  "collectionInterval" : 9,
  "enabled" : true,
  "status" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Target

Up
put /api/v{version}/collectors/azure/targets/{id}
(apiVversionCollectorsAzureTargetsIdPut)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body Target (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "lastActive" : "2000-01-23T04:56:07.000+00:00",
  "displayName" : "displayName",
  "lastCollection" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "tenantCode" : "tenantCode",
  "config" : {
    "parallelResourceResolutionRequests" : 2,
    "subscriptions" : [ "subscriptions", "subscriptions" ],
    "subscriptionResourceTypes" : [ "subscriptionResourceTypes", "subscriptionResourceTypes" ],
    "dataCollectionTimeout" : 1,
    "collectResourceData" : true,
    "collectAllSubscriptions" : true,
    "tenantActivityCollection" : true,
    "initialCollectionOffset" : 7,
    "activityLogCollectionSkew" : 5,
    "activityLogCollectionTimeout" : 5,
    "tenantResourceTypes" : [ "tenantResourceTypes", "tenantResourceTypes" ],
    "ignoredItems" : [ "ignoredItems", "ignoredItems" ],
    "ignoredOperations" : [ "ignoredOperations", "ignoredOperations" ],
    "ignoredStatuses" : [ "ignoredStatuses", "ignoredStatuses" ],
    "resolveConfigurationObjects" : true
  },
  "collectionInterval" : 9,
  "enabled" : true,
  "status" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Target

Up
post /api/v{version}/collectors/azure/targets
(apiVversionCollectorsAzureTargetsPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body CreateTarget (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "lastActive" : "2000-01-23T04:56:07.000+00:00",
  "displayName" : "displayName",
  "lastCollection" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "tenantCode" : "tenantCode",
  "config" : {
    "parallelResourceResolutionRequests" : 2,
    "subscriptions" : [ "subscriptions", "subscriptions" ],
    "subscriptionResourceTypes" : [ "subscriptionResourceTypes", "subscriptionResourceTypes" ],
    "dataCollectionTimeout" : 1,
    "collectResourceData" : true,
    "collectAllSubscriptions" : true,
    "tenantActivityCollection" : true,
    "initialCollectionOffset" : 7,
    "activityLogCollectionSkew" : 5,
    "activityLogCollectionTimeout" : 5,
    "tenantResourceTypes" : [ "tenantResourceTypes", "tenantResourceTypes" ],
    "ignoredItems" : [ "ignoredItems", "ignoredItems" ],
    "ignoredOperations" : [ "ignoredOperations", "ignoredOperations" ],
    "ignoredStatuses" : [ "ignoredStatuses", "ignoredStatuses" ],
    "resolveConfigurationObjects" : true
  },
  "collectionInterval" : 9,
  "enabled" : true,
  "status" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Target

AzureBackup

Up
get /api/v{version}/collectors/azure/snapshots
Retrieve Azure Recovery object snapshots (apiVversionCollectorsAzureSnapshotsGet)

Path parameters

version (required)
Path Parameter

Query parameters

guid (optional)
Query Parameter — Object GUID to use for filtering snapshots format: uuid

Return type

array[AzureSnapshot]

Example data

Content-Type: application/json
[ {
  "snapshotBinary" : "",
  "backupId" : 6,
  "id" : 0,
  "objectId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "snapshot" : "snapshot"
}, {
  "snapshotBinary" : "",
  "backupId" : 6,
  "id" : 0,
  "objectId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "snapshot" : "snapshot"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

A list of matching object snapshots

410

No matching object snapshots were found

Up
get /api/v{version}/collectors/azure/snapshots/{snapshotId}
Retrieve a single Azure Recovery object snapshot (apiVversionCollectorsAzureSnapshotsSnapshotIdGet)

Path parameters

snapshotId (required)
Path Parameter — Snapshot ID format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "snapshotBinary" : "",
  "backupId" : 6,
  "id" : 0,
  "objectId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "snapshot" : "snapshot"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

A single Azure Recovery object snapshot AzureSnapshot

410

Snapshot was not found

AzureObjects

Up
get /api/v{version}/collectors/azure/objects/{guid}
Retrieve a single Azure Recovery object (apiVversionCollectorsAzureObjectsGuidGet)

Path parameters

guid (required)
Path Parameter — Azure object GUID format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "deletedOn" : "2000-01-23T04:56:07.000+00:00",
  "tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : "type",
  "createdOn" : "2000-01-23T04:56:07.000+00:00",
  "userPrincipalName" : "userPrincipalName"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

A single Azure Recovery object Object

410

Object was not found

Backup

Up
get /api/v{version}/collectors/activedirectory/backups/{backupId}
(apiVversionCollectorsActivedirectoryBackupsBackupIdGet)

Path parameters

backupId (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "objectCount" : 6,
  "id" : 0,
  "source" : "source",
  "when" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CollectorBackup

Up
get /api/v{version}/collectors/activedirectory/backups/{backupId}/snapshots
(apiVversionCollectorsActivedirectoryBackupsBackupIdSnapshotsGet)

Path parameters

backupId (required)
Path Parameter — format: int32
version (required)
Path Parameter

Query parameters

objectGuid (optional)
Query Parameter — format: uuid
distinguishedName (optional)
Query Parameter

Return type

Example data

Content-Type: application/json
{
  "samType" : 1,
  "encodedData" : "encodedData",
  "adObject" : {
    "displayName" : "displayName",
    "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "objectClass" : "objectClass",
    "distinguishedName" : "distinguishedName",
    "objectSid" : "objectSid",
    "id" : 5
  },
  "domain" : "domain",
  "encodedAttributeCount" : 6,
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "eventTime" : "2000-01-23T04:56:07.000+00:00",
  "storageType" : 5,
  "attributes" : [ {
    "displayValue" : "displayValue",
    "name" : "name",
    "value" : ""
  }, {
    "displayValue" : "displayValue",
    "name" : "name",
    "value" : ""
  } ],
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ObjectSnapshot

Up
get /api/v{version}/collectors/activedirectory/backups/{backupId}/snapshots/{snapshotId}
(apiVversionCollectorsActivedirectoryBackupsBackupIdSnapshotsSnapshotIdGet)

Path parameters

backupId (required)
Path Parameter — format: int32
snapshotId (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "samType" : 1,
  "encodedData" : "encodedData",
  "adObject" : {
    "displayName" : "displayName",
    "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "objectClass" : "objectClass",
    "distinguishedName" : "distinguishedName",
    "objectSid" : "objectSid",
    "id" : 5
  },
  "domain" : "domain",
  "encodedAttributeCount" : 6,
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "eventTime" : "2000-01-23T04:56:07.000+00:00",
  "storageType" : 5,
  "attributes" : [ {
    "displayValue" : "displayValue",
    "name" : "name",
    "value" : ""
  }, {
    "displayValue" : "displayValue",
    "name" : "name",
    "value" : ""
  } ],
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ObjectSnapshot

Up
get /api/v{version}/collectors/activedirectory/backups
(apiVversionCollectorsActivedirectoryBackupsGet)

Path parameters

version (required)
Path Parameter

Query parameters

objectGuid (optional)
Query Parameter — format: uuid
objectId (optional)
Query Parameter — format: int32
distinguishedName (optional)
Query Parameter
limit (optional)
Query Parameter — default: 0 format: int32
maxDate (optional)
Query Parameter — format: date-time

Return type

Example data

Content-Type: application/json
[ {
  "objectCount" : 6,
  "id" : 0,
  "source" : "source",
  "when" : "2000-01-23T04:56:07.000+00:00"
}, {
  "objectCount" : 6,
  "id" : 0,
  "source" : "source",
  "when" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
get /api/v{version}/collectors/activedirectory/backups/snapshots
(apiVversionCollectorsActivedirectoryBackupsSnapshotsGet)

Path parameters

version (required)
Path Parameter

Query parameters

objectGuid (optional)
Query Parameter — format: uuid
objectId (optional)
Query Parameter — format: int32
limit (optional)
Query Parameter — default: 0 format: int32
maxDate (optional)
Query Parameter — format: date-time
includeObjectInfo (optional)
Query Parameter — default: false

Return type

Example data

Content-Type: application/json
[ {
  "samType" : 1,
  "encodedData" : "encodedData",
  "adObject" : {
    "displayName" : "displayName",
    "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "objectClass" : "objectClass",
    "distinguishedName" : "distinguishedName",
    "objectSid" : "objectSid",
    "id" : 5
  },
  "domain" : "domain",
  "encodedAttributeCount" : 6,
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "eventTime" : "2000-01-23T04:56:07.000+00:00",
  "storageType" : 5,
  "attributes" : [ {
    "displayValue" : "displayValue",
    "name" : "name",
    "value" : ""
  }, {
    "displayValue" : "displayValue",
    "name" : "name",
    "value" : ""
  } ],
  "id" : 0
}, {
  "samType" : 1,
  "encodedData" : "encodedData",
  "adObject" : {
    "displayName" : "displayName",
    "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "objectClass" : "objectClass",
    "distinguishedName" : "distinguishedName",
    "objectSid" : "objectSid",
    "id" : 5
  },
  "domain" : "domain",
  "encodedAttributeCount" : 6,
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "eventTime" : "2000-01-23T04:56:07.000+00:00",
  "storageType" : 5,
  "attributes" : [ {
    "displayValue" : "displayValue",
    "name" : "name",
    "value" : ""
  }, {
    "displayValue" : "displayValue",
    "name" : "name",
    "value" : ""
  } ],
  "id" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
get /api/v{version}/collectors/activedirectory/backups/snapshots/gpodiff
(apiVversionCollectorsActivedirectoryBackupsSnapshotsGpodiffGet)

Path parameters

version (required)
Path Parameter

Query parameters

backupGuidLeft (optional)
Query Parameter — format: uuid
backupGuidRight (optional)
Query Parameter — format: uuid

Return type

array[GpoChange]

Example data

Content-Type: application/json
[ {
  "explain" : "explain",
  "newValue" : "newValue",
  "name" : "name",
  "attributeName" : "attributeName",
  "state" : "state",
  "oldValue" : "oldValue",
  "category" : "category",
  "supported" : "supported"
}, {
  "explain" : "explain",
  "newValue" : "newValue",
  "name" : "name",
  "attributeName" : "attributeName",
  "state" : "state",
  "oldValue" : "oldValue",
  "category" : "category",
  "supported" : "supported"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
get /api/v{version}/collectors/activedirectory/backups/snapshots/objects/time
(apiVversionCollectorsActivedirectoryBackupsSnapshotsObjectsTimeGet)

Path parameters

version (required)
Path Parameter

Query parameters

objectGuid (optional)
Query Parameter — format: uuid
time (optional)
Query Parameter — format: date-time
utc (optional)
Query Parameter — default: false

Return type

Example data

Content-Type: application/json
{
  "samType" : 1,
  "encodedData" : "encodedData",
  "adObject" : {
    "displayName" : "displayName",
    "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "objectClass" : "objectClass",
    "distinguishedName" : "distinguishedName",
    "objectSid" : "objectSid",
    "id" : 5
  },
  "domain" : "domain",
  "encodedAttributeCount" : 6,
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "eventTime" : "2000-01-23T04:56:07.000+00:00",
  "storageType" : 5,
  "attributes" : [ {
    "displayValue" : "displayValue",
    "name" : "name",
    "value" : ""
  }, {
    "displayValue" : "displayValue",
    "name" : "name",
    "value" : ""
  } ],
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ObjectSnapshot

Up
get /api/v{version}/collectors/activedirectory/backups/snapshots/{snapshotId}
(apiVversionCollectorsActivedirectoryBackupsSnapshotsSnapshotIdGet)

Path parameters

snapshotId (required)
Path Parameter — format: int32
version (required)
Path Parameter

Query parameters

storageType (optional)
Query Parameter — 0 = Unknown, 1 = Active Directory, 2 = Group Policy Container, 3 = Max Value

Return type

Example data

Content-Type: application/json
{
  "samType" : 1,
  "encodedData" : "encodedData",
  "adObject" : {
    "displayName" : "displayName",
    "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "objectClass" : "objectClass",
    "distinguishedName" : "distinguishedName",
    "objectSid" : "objectSid",
    "id" : 5
  },
  "domain" : "domain",
  "encodedAttributeCount" : 6,
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "eventTime" : "2000-01-23T04:56:07.000+00:00",
  "storageType" : 5,
  "attributes" : [ {
    "displayValue" : "displayValue",
    "name" : "name",
    "value" : ""
  }, {
    "displayValue" : "displayValue",
    "name" : "name",
    "value" : ""
  } ],
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ObjectSnapshot

Charts

Up
get /api/v{version}/charts/builtin/{type}
(apiVversionChartsBuiltinTypeGet)

Path parameters

type (required)
Path Parameter — 0 = Undefined, 1 = Events by Source, 2 = Top Users, 3 = Top Events, 4 = Events collected per day, 5 = Events per Minute, 6 = Top events per field
version (required)
Path Parameter

Query parameters

offset (optional)
Query Parameter — format: int32

Return type

Example data

Content-Type: application/json
{
  "instanceId" : 0,
  "data" : "",
  "subTitleFormat" : "subTitleFormat",
  "name" : "name",
  "chartType" : "chartType",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "parameters" : [ {
    "hidden" : true,
    "defaultValue" : "defaultValue",
    "name" : "name",
    "description" : "description",
    "type" : "type",
    "value" : "value"
  }, {
    "hidden" : true,
    "defaultValue" : "defaultValue",
    "name" : "name",
    "description" : "description",
    "type" : "type",
    "value" : "value"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Chart

CollectorStatusCheckConfiguration

Up
get /api/v{version}/system/config/collectorStatusCheck
(apiVversionSystemConfigCollectorStatusCheckGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "excludedCollectors" : [ {
    "configurationId" : 1,
    "type" : "type"
  }, {
    "configurationId" : 1,
    "type" : "type"
  } ],
  "interval" : 6,
  "excludedStatuses" : [ "excludedStatuses", "excludedStatuses" ],
  "state" : 5,
  "version" : 5,
  "directive" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CollectorStatusCheckConfiguration

Up
put /api/v{version}/system/config/collectorStatusCheck
(apiVversionSystemConfigCollectorStatusCheckPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "excludedCollectors" : [ {
    "configurationId" : 1,
    "type" : "type"
  }, {
    "configurationId" : 1,
    "type" : "type"
  } ],
  "interval" : 6,
  "excludedStatuses" : [ "excludedStatuses", "excludedStatuses" ],
  "state" : 5,
  "version" : 5,
  "directive" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CollectorStatusCheckConfiguration

ConfigurationString

Up
post /api/v{version}/system/config/databases
(apiVversionSystemConfigDatabasesPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ConnectionString (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "databases" : [ "databases", "databases" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DatabaseList

DataPurge

Up
get /api/v{version}/datapurge/default
(apiVversionDatapurgeDefaultGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "nextRunOn" : "2000-01-23T04:56:07.000+00:00",
  "timingInfo" : {
    "misfireRule" : 1,
    "type" : 6,
    "priority" : 5,
    "effectiveDates" : {
      "endAt" : "2000-01-23T04:56:07.000+00:00",
      "startAt" : "2000-01-23T04:56:07.000+00:00"
    }
  },
  "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
  "isEnabled" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "state" : 5,
  "type" : 0,
  "jobInfo" : { },
  "lastRunOn" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ScheduledJobWeb

Up
delete /api/v{version}/datapurge
(apiVversionDatapurgeDelete)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/datapurge
(apiVversionDatapurgeGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "nextRunOn" : "2000-01-23T04:56:07.000+00:00",
  "timingInfo" : {
    "misfireRule" : 1,
    "type" : 6,
    "priority" : 5,
    "effectiveDates" : {
      "endAt" : "2000-01-23T04:56:07.000+00:00",
      "startAt" : "2000-01-23T04:56:07.000+00:00"
    }
  },
  "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
  "isEnabled" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "state" : 5,
  "type" : 0,
  "jobInfo" : { },
  "lastRunOn" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ScheduledJobWeb

Up
post /api/v{version}/datapurge
(apiVversionDatapurgePost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ScheduledJobWeb (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "nextRunOn" : "2000-01-23T04:56:07.000+00:00",
  "timingInfo" : {
    "misfireRule" : 1,
    "type" : 6,
    "priority" : 5,
    "effectiveDates" : {
      "endAt" : "2000-01-23T04:56:07.000+00:00",
      "startAt" : "2000-01-23T04:56:07.000+00:00"
    }
  },
  "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
  "isEnabled" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "state" : 5,
  "type" : 0,
  "jobInfo" : { },
  "lastRunOn" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ScheduledJobWeb

Up
put /api/v{version}/datapurge
(apiVversionDatapurgePut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ScheduledJobWeb (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "nextRunOn" : "2000-01-23T04:56:07.000+00:00",
  "timingInfo" : {
    "misfireRule" : 1,
    "type" : 6,
    "priority" : 5,
    "effectiveDates" : {
      "endAt" : "2000-01-23T04:56:07.000+00:00",
      "startAt" : "2000-01-23T04:56:07.000+00:00"
    }
  },
  "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
  "isEnabled" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "state" : 5,
  "type" : 0,
  "jobInfo" : { },
  "lastRunOn" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ScheduledJobWeb

Database

Up
post /api/v{version}/setup/database/catalog
(apiVversionSetupDatabaseCatalogPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DatabaseSetup (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "connectionString" : {
    "initialCatalog" : "initialCatalog",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "useWindowsAuth" : true,
    "connectRetryCount" : 6,
    "connectRetryInterval" : 1,
    "dataSource" : "dataSource",
    "connectionTimeout" : 0
  },
  "versionComparison" : {
    "requiredVersion" : {
      "appliedTime" : "2000-01-23T04:56:07.000+00:00",
      "build" : "build",
      "sqlSchema" : "sqlSchema"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DatabaseInfo

Up
put /api/v{version}/setup/database/catalog
(apiVversionSetupDatabaseCatalogPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DatabaseSetup (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "connectionString" : {
    "initialCatalog" : "initialCatalog",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "useWindowsAuth" : true,
    "connectRetryCount" : 6,
    "connectRetryInterval" : 1,
    "dataSource" : "dataSource",
    "connectionTimeout" : 0
  },
  "versionComparison" : {
    "requiredVersion" : {
      "appliedTime" : "2000-01-23T04:56:07.000+00:00",
      "build" : "build",
      "sqlSchema" : "sqlSchema"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DatabaseInfo

Up
get /api/v{version}/setup/database/connection
(apiVversionSetupDatabaseConnectionGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "initialCatalog" : "initialCatalog",
  "credentials" : {
    "password" : "password",
    "username" : "username"
  },
  "useWindowsAuth" : true,
  "connectRetryCount" : 6,
  "connectRetryInterval" : 1,
  "dataSource" : "dataSource",
  "connectionTimeout" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ConnectionString

Up
post /api/v{version}/setup/database/connection
(apiVversionSetupDatabaseConnectionPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DatabaseSetup (optional)
Body Parameter

Responses

200

Success

Up
post /api/v{version}/setup/database/connection/test
(apiVversionSetupDatabaseConnectionTestPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DatabaseSetup (optional)
Body Parameter

Responses

200

Success

Up
post /api/v{version}/setup/database/search/catalogs
(apiVversionSetupDatabaseSearchCatalogsPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ConnectionString (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "databases" : [ "databases", "databases" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DatabaseList

Up
get /api/v{version}/setup/database/search/servers
(apiVversionSetupDatabaseSearchServersGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "servers" : [ "servers", "servers" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ServerList

Up
post /api/v{version}/setup/database/version
(apiVversionSetupDatabaseVersionPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ConnectionString (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "requiredVersion" : {
    "appliedTime" : "2000-01-23T04:56:07.000+00:00",
    "build" : "build",
    "sqlSchema" : "sqlSchema"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DatabaseVersionCompare

DatabaseConnector

Up
post /api/v{version}/database/connectors/catalogs
(apiVversionDatabaseConnectorsCatalogsPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "databases" : [ "databases", "databases" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DatabaseList

Up
get /api/v{version}/database/connectors
(apiVversionDatabaseConnectorsGet)

Path parameters

version (required)
Path Parameter

Query parameters

isCoreConnectionToBeIncluded (optional)
Query Parameter — default: true

Return type

Example data

Content-Type: application/json
[ {
  "connectionString" : "connectionString",
  "isReadOnly" : true,
  "delegatedResources" : [ {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  }, {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  } ],
  "configuration" : {
    "initialCatalog" : "initialCatalog",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "useWindowsAuth" : true,
    "connectRetryCount" : 6,
    "connectRetryInterval" : 1,
    "dataSource" : "dataSource",
    "connectionTimeout" : 0
  },
  "isEnabled" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "designation" : 6,
  "type" : 0
}, {
  "connectionString" : "connectionString",
  "isReadOnly" : true,
  "delegatedResources" : [ {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  }, {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  } ],
  "configuration" : {
    "initialCatalog" : "initialCatalog",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "useWindowsAuth" : true,
    "connectRetryCount" : 6,
    "connectRetryInterval" : 1,
    "dataSource" : "dataSource",
    "connectionTimeout" : 0
  },
  "isEnabled" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "designation" : 6,
  "type" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
delete /api/v{version}/database/connectors/{id}
(apiVversionDatabaseConnectorsIdDelete)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/database/connectors/{id}
(apiVversionDatabaseConnectorsIdGet)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "connectionString" : "connectionString",
  "isReadOnly" : true,
  "delegatedResources" : [ {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  }, {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  } ],
  "configuration" : {
    "initialCatalog" : "initialCatalog",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "useWindowsAuth" : true,
    "connectRetryCount" : 6,
    "connectRetryInterval" : 1,
    "dataSource" : "dataSource",
    "connectionTimeout" : 0
  },
  "isEnabled" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "designation" : 6,
  "type" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DelegatedDatabaseConnector

Up
put /api/v{version}/database/connectors/{id}
(apiVversionDatabaseConnectorsIdPut)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "connectionString" : "connectionString",
  "isReadOnly" : true,
  "delegatedResources" : [ {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  }, {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  } ],
  "configuration" : {
    "initialCatalog" : "initialCatalog",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "useWindowsAuth" : true,
    "connectRetryCount" : 6,
    "connectRetryInterval" : 1,
    "dataSource" : "dataSource",
    "connectionTimeout" : 0
  },
  "isEnabled" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "designation" : 6,
  "type" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DelegatedDatabaseConnector

Up
post /api/v{version}/database/connectors/migrate
(apiVversionDatabaseConnectorsMigratePost)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "connectionString" : "connectionString",
  "isReadOnly" : true,
  "delegatedResources" : [ {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  }, {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  } ],
  "configuration" : {
    "initialCatalog" : "initialCatalog",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "useWindowsAuth" : true,
    "connectRetryCount" : 6,
    "connectRetryInterval" : 1,
    "dataSource" : "dataSource",
    "connectionTimeout" : 0
  },
  "isEnabled" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "designation" : 6,
  "type" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DelegatedDatabaseConnector

Up
post /api/v{version}/database/connectors
(apiVversionDatabaseConnectorsPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "connectionString" : "connectionString",
  "isReadOnly" : true,
  "delegatedResources" : [ {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  }, {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  } ],
  "configuration" : {
    "initialCatalog" : "initialCatalog",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "useWindowsAuth" : true,
    "connectRetryCount" : 6,
    "connectRetryInterval" : 1,
    "dataSource" : "dataSource",
    "connectionTimeout" : 0
  },
  "isEnabled" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "designation" : 6,
  "type" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DelegatedDatabaseConnector

Up
post /api/v{version}/database/connectors/validate
(apiVversionDatabaseConnectorsValidatePost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

DelegatedResource

Up
get /api/v{version}/delegatedresources
(apiVversionDelegatedresourcesGet)

Path parameters

version (required)
Path Parameter

Query parameters

type (optional)
Query Parameter — 0 = Undefined, 1 = Report, 2 = Report Tag, 3 = Report Type, 4 = Scheduled Job, 5 = Scheduled Job Tag, 6 = Scheduled Job Type, 7 = Database Connector
resourceId (optional)
Query Parameter

Return type

Example data

Content-Type: application/json
[ {
  "resourceId" : "resourceId",
  "id" : 1,
  "accounts" : [ {
    "isReadOnly" : true,
    "displayName" : "displayName",
    "domain" : "domain",
    "objectClass" : 5,
    "dn" : "dn",
    "sid" : "sid"
  }, {
    "isReadOnly" : true,
    "displayName" : "displayName",
    "domain" : "domain",
    "objectClass" : 5,
    "dn" : "dn",
    "sid" : "sid"
  } ],
  "type" : 5
}, {
  "resourceId" : "resourceId",
  "id" : 1,
  "accounts" : [ {
    "isReadOnly" : true,
    "displayName" : "displayName",
    "domain" : "domain",
    "objectClass" : 5,
    "dn" : "dn",
    "sid" : "sid"
  }, {
    "isReadOnly" : true,
    "displayName" : "displayName",
    "domain" : "domain",
    "objectClass" : 5,
    "dn" : "dn",
    "sid" : "sid"
  } ],
  "type" : 5
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
delete /api/v{version}/delegatedresources/{id}
(apiVversionDelegatedresourcesIdDelete)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/delegatedresources/{id}
(apiVversionDelegatedresourcesIdGet)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "resourceId" : "resourceId",
  "id" : 1,
  "accounts" : [ {
    "isReadOnly" : true,
    "displayName" : "displayName",
    "domain" : "domain",
    "objectClass" : 5,
    "dn" : "dn",
    "sid" : "sid"
  }, {
    "isReadOnly" : true,
    "displayName" : "displayName",
    "domain" : "domain",
    "objectClass" : 5,
    "dn" : "dn",
    "sid" : "sid"
  } ],
  "type" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DelegatedResourceX

Up
put /api/v{version}/delegatedresources/{id}
(apiVversionDelegatedresourcesIdPut)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DelegatedResourceX (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "resourceId" : "resourceId",
  "id" : 1,
  "accounts" : [ {
    "isReadOnly" : true,
    "displayName" : "displayName",
    "domain" : "domain",
    "objectClass" : 5,
    "dn" : "dn",
    "sid" : "sid"
  }, {
    "isReadOnly" : true,
    "displayName" : "displayName",
    "domain" : "domain",
    "objectClass" : 5,
    "dn" : "dn",
    "sid" : "sid"
  } ],
  "type" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DelegatedResourceX

Up
post /api/v{version}/delegatedresources
(apiVversionDelegatedresourcesPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DelegatedResourceX (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "resourceId" : "resourceId",
  "id" : 1,
  "accounts" : [ {
    "isReadOnly" : true,
    "displayName" : "displayName",
    "domain" : "domain",
    "objectClass" : 5,
    "dn" : "dn",
    "sid" : "sid"
  }, {
    "isReadOnly" : true,
    "displayName" : "displayName",
    "domain" : "domain",
    "objectClass" : 5,
    "dn" : "dn",
    "sid" : "sid"
  } ],
  "type" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DelegatedResourceX

DirectoryObject

Up
get /api/v{version}/collectors/activedirectory/objects/attributes
(apiVversionCollectorsActivedirectoryObjectsAttributesGet)

Path parameters

version (required)
Path Parameter

Query parameters

domain (optional)
Query Parameter
objectGuid (optional)
Query Parameter — format: uuid

Return type

Example data

Content-Type: application/json
{
  "name" : "name",
  "value" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ActiveDirectoryAttributeData

Up
get /api/v{version}/collectors/activedirectory/objects/browse
(apiVversionCollectorsActivedirectoryObjectsBrowseGet)

Path parameters

version (required)
Path Parameter

Query parameters

type (optional)
Query Parameter
domain (optional)
Query Parameter — default: 1 format: int32
domainName (optional)
Query Parameter
limit (optional)
Query Parameter — default: 0 format: int32
objectDN (optional)
Query Parameter — default: *
objectGuid (optional)
Query Parameter — format: uuid
namingContext (optional)
Query Parameter — 0 = Default, 1 = Configuration, 2 = Schema, 3 = RootDSE, 4 = Custom
advanced (optional)
Query Parameter — default: false

Return type

Example data

Content-Type: application/json
{
  "msdsPrincipalName" : "msdsPrincipalName",
  "presentationName" : "presentationName",
  "displayName" : "displayName",
  "accountExpires" : 1,
  "objectClass" : "objectClass",
  "samAccountName" : "samAccountName",
  "dnsName" : "dnsName",
  "description" : "description",
  "dn" : "dn",
  "cn" : "cn",
  "ldapName" : "ldapName",
  "managerEmail" : "managerEmail",
  "rawValues" : {
    "key" : [ "", "" ]
  },
  "domain" : "domain",
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "objectSid" : "objectSid",
  "attributes" : [ {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  }, {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  } ],
  "userPrincipalName" : "userPrincipalName",
  "userAccountControl" : 0,
  "pwdLastSet" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ActiveDirectoryObject

Up
get /api/v{version}/collectors/activedirectory/objects
(apiVversionCollectorsActivedirectoryObjectsGet)

Path parameters

version (required)
Path Parameter

Query parameters

search (optional)
Query Parameter
limit (optional)
Query Parameter — default: 50 format: int32
objectClass (optional)
Query Parameter — default: *
objectGuid (optional)
Query Parameter — format: uuid
deletedFlag (optional)
Query Parameter — default: 0 format: int32

Return type

Example data

Content-Type: application/json
{
  "msdsPrincipalName" : "msdsPrincipalName",
  "presentationName" : "presentationName",
  "displayName" : "displayName",
  "accountExpires" : 1,
  "objectClass" : "objectClass",
  "samAccountName" : "samAccountName",
  "dnsName" : "dnsName",
  "description" : "description",
  "dn" : "dn",
  "cn" : "cn",
  "ldapName" : "ldapName",
  "managerEmail" : "managerEmail",
  "rawValues" : {
    "key" : [ "", "" ]
  },
  "domain" : "domain",
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "objectSid" : "objectSid",
  "attributes" : [ {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  }, {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  } ],
  "userPrincipalName" : "userPrincipalName",
  "userAccountControl" : 0,
  "pwdLastSet" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ActiveDirectoryObject

Up
get /api/v{version}/collectors/activedirectory/objects/members
(apiVversionCollectorsActivedirectoryObjectsMembersGet)

Path parameters

version (required)
Path Parameter

Query parameters

domain (optional)
Query Parameter
objectGuid (optional)
Query Parameter — format: uuid
expanded (optional)
Query Parameter — default: false

Return type

Example data

Content-Type: application/json
{
  "msdsPrincipalName" : "msdsPrincipalName",
  "presentationName" : "presentationName",
  "displayName" : "displayName",
  "accountExpires" : 1,
  "objectClass" : "objectClass",
  "samAccountName" : "samAccountName",
  "dnsName" : "dnsName",
  "description" : "description",
  "dn" : "dn",
  "cn" : "cn",
  "ldapName" : "ldapName",
  "managerEmail" : "managerEmail",
  "rawValues" : {
    "key" : [ "", "" ]
  },
  "domain" : "domain",
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "objectSid" : "objectSid",
  "attributes" : [ {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  }, {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  } ],
  "userPrincipalName" : "userPrincipalName",
  "userAccountControl" : 0,
  "pwdLastSet" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ActiveDirectoryObject

Up
get /api/v{version}/collectors/activedirectory/objects/membership
(apiVversionCollectorsActivedirectoryObjectsMembershipGet)

Path parameters

version (required)
Path Parameter

Query parameters

domain (optional)
Query Parameter
objectGuid (optional)
Query Parameter — format: uuid
expanded (optional)
Query Parameter — default: false

Return type

Example data

Content-Type: application/json
{
  "msdsPrincipalName" : "msdsPrincipalName",
  "presentationName" : "presentationName",
  "displayName" : "displayName",
  "accountExpires" : 1,
  "objectClass" : "objectClass",
  "samAccountName" : "samAccountName",
  "dnsName" : "dnsName",
  "description" : "description",
  "dn" : "dn",
  "cn" : "cn",
  "ldapName" : "ldapName",
  "managerEmail" : "managerEmail",
  "rawValues" : {
    "key" : [ "", "" ]
  },
  "domain" : "domain",
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "objectSid" : "objectSid",
  "attributes" : [ {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  }, {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  } ],
  "userPrincipalName" : "userPrincipalName",
  "userAccountControl" : 0,
  "pwdLastSet" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ActiveDirectoryObject

Up
get /api/v{version}/collectors/activedirectory/objects/{objectId}
(apiVversionCollectorsActivedirectoryObjectsObjectIdGet)

Path parameters

objectId (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Query parameters

distinguishedName (optional)
Query Parameter

Return type

Example data

Content-Type: application/json
{
  "msdsPrincipalName" : "msdsPrincipalName",
  "presentationName" : "presentationName",
  "displayName" : "displayName",
  "accountExpires" : 1,
  "objectClass" : "objectClass",
  "samAccountName" : "samAccountName",
  "dnsName" : "dnsName",
  "description" : "description",
  "dn" : "dn",
  "cn" : "cn",
  "ldapName" : "ldapName",
  "managerEmail" : "managerEmail",
  "rawValues" : {
    "key" : [ "", "" ]
  },
  "domain" : "domain",
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "objectSid" : "objectSid",
  "attributes" : [ {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  }, {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  } ],
  "userPrincipalName" : "userPrincipalName",
  "userAccountControl" : 0,
  "pwdLastSet" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ActiveDirectoryObject

Up
get /api/v{version}/collectors/activedirectory/objects/search
(apiVversionCollectorsActivedirectoryObjectsSearchGet)

Path parameters

version (required)
Path Parameter

Query parameters

search (optional)
Query Parameter
limit (optional)
Query Parameter — default: 50 format: int32
objectClass (optional)
Query Parameter — default: *
objectGuid (optional)
Query Parameter — format: uuid
deletedFlag (optional)
Query Parameter — default: 0 format: int32

Return type

Example data

Content-Type: application/json
{
  "msdsPrincipalName" : "msdsPrincipalName",
  "presentationName" : "presentationName",
  "displayName" : "displayName",
  "accountExpires" : 1,
  "objectClass" : "objectClass",
  "samAccountName" : "samAccountName",
  "dnsName" : "dnsName",
  "description" : "description",
  "dn" : "dn",
  "cn" : "cn",
  "ldapName" : "ldapName",
  "managerEmail" : "managerEmail",
  "rawValues" : {
    "key" : [ "", "" ]
  },
  "domain" : "domain",
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "objectSid" : "objectSid",
  "attributes" : [ {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  }, {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  } ],
  "userPrincipalName" : "userPrincipalName",
  "userAccountControl" : 0,
  "pwdLastSet" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ActiveDirectoryObject

Up
get /api/v{version}/collectors/activedirectory/objects/security
(apiVversionCollectorsActivedirectoryObjectsSecurityGet)

Path parameters

version (required)
Path Parameter

Query parameters

domain (optional)
Query Parameter
objectGuid (optional)
Query Parameter — format: uuid

Return type

Example data

Content-Type: application/json
{
  "discretionaryAccessControlList" : [ {
    "inheritedTypeGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "aceMask" : "aceMask",
    "objectAce" : true,
    "aceFlags" : "aceFlags",
    "accessMask" : 6,
    "objectTypeGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "inheritedType" : "inheritedType",
    "type" : "type",
    "account" : "account",
    "sid" : {
      "binaryLength" : 0,
      "value" : "value"
    },
    "objectType" : "objectType"
  }, {
    "inheritedTypeGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "aceMask" : "aceMask",
    "objectAce" : true,
    "aceFlags" : "aceFlags",
    "accessMask" : 6,
    "objectTypeGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "inheritedType" : "inheritedType",
    "type" : "type",
    "account" : "account",
    "sid" : {
      "binaryLength" : 0,
      "value" : "value"
    },
    "objectType" : "objectType"
  } ],
  "saclPresent" : true,
  "daclPresent" : true,
  "systemAccessControlList" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ActiveDirectorySecurityDescriptor

Up
get /api/v{version}/collectors/activedirectory/search
(apiVversionCollectorsActivedirectorySearchGet)

Path parameters

version (required)
Path Parameter

Query parameters

searchString (optional)
Query Parameter
objectType (optional)
Query Parameter — 1 = Local Users, 2 = Local Groups, 4 = Domain Users, 8 = Domain Groups, 16 = Computers, 32 = Domain Controllers, 64 = Exchange Servers, 128 = Sql Servers, 256 = Containers, 512 = Organizational Units
domainId (optional)
Query Parameter — format: int32
limit (optional)
Query Parameter — default: 50 format: int32

Return type

Example data

Content-Type: application/json
[ {
  "msdsPrincipalName" : "msdsPrincipalName",
  "presentationName" : "presentationName",
  "displayName" : "displayName",
  "accountExpires" : 1,
  "objectClass" : "objectClass",
  "samAccountName" : "samAccountName",
  "dnsName" : "dnsName",
  "description" : "description",
  "dn" : "dn",
  "cn" : "cn",
  "ldapName" : "ldapName",
  "managerEmail" : "managerEmail",
  "rawValues" : {
    "key" : [ "", "" ]
  },
  "domain" : "domain",
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "objectSid" : "objectSid",
  "attributes" : [ {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  }, {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  } ],
  "userPrincipalName" : "userPrincipalName",
  "userAccountControl" : 0,
  "pwdLastSet" : 6
}, {
  "msdsPrincipalName" : "msdsPrincipalName",
  "presentationName" : "presentationName",
  "displayName" : "displayName",
  "accountExpires" : 1,
  "objectClass" : "objectClass",
  "samAccountName" : "samAccountName",
  "dnsName" : "dnsName",
  "description" : "description",
  "dn" : "dn",
  "cn" : "cn",
  "ldapName" : "ldapName",
  "managerEmail" : "managerEmail",
  "rawValues" : {
    "key" : [ "", "" ]
  },
  "domain" : "domain",
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "objectSid" : "objectSid",
  "attributes" : [ {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  }, {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  } ],
  "userPrincipalName" : "userPrincipalName",
  "userAccountControl" : 0,
  "pwdLastSet" : 6
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Domains

Up
post /api/v{version}/collectors/activedirectory/domains/configuration/export/{domainId}
(apiVversionCollectorsActivedirectoryDomainsConfigurationExportDomainIdPost)

Path parameters

domainId (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success byte[]

Up
post /api/v{version}/collectors/activedirectory/domains/controllers/search
(apiVversionCollectorsActivedirectoryDomainsControllersSearchPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DomainSearch (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "lastActive" : "2000-01-23T04:56:07.000+00:00",
  "statusMessage" : "statusMessage",
  "enabled" : true,
  "sid" : "sid",
  "netBiosName" : "netBiosName",
  "hasAgent" : true,
  "osVersion" : "osVersion",
  "domain" : "domain",
  "name" : "name",
  "agentVersion" : "agentVersion",
  "id" : 6,
  "upgradeRequired" : true,
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DomainController

Up
get /api/v{version}/collectors/activedirectory/domains
(apiVversionCollectorsActivedirectoryDomainsGet)

Path parameters

version (required)
Path Parameter

Query parameters

isDCListToBeIncluded (optional)
Query Parameter — default: false
hideDisabled (optional)
Query Parameter — default: true

Return type

Example data

Content-Type: application/json
{
  "accountName" : "accountName",
  "backupPassword" : "backupPassword",
  "flags" : 1,
  "dnsName" : "dnsName",
  "domainControllers" : [ {
    "lastActive" : "2000-01-23T04:56:07.000+00:00",
    "statusMessage" : "statusMessage",
    "enabled" : true,
    "sid" : "sid",
    "netBiosName" : "netBiosName",
    "hasAgent" : true,
    "osVersion" : "osVersion",
    "domain" : "domain",
    "name" : "name",
    "agentVersion" : "agentVersion",
    "id" : 6,
    "upgradeRequired" : true,
    "status" : 0
  }, {
    "lastActive" : "2000-01-23T04:56:07.000+00:00",
    "statusMessage" : "statusMessage",
    "enabled" : true,
    "sid" : "sid",
    "netBiosName" : "netBiosName",
    "hasAgent" : true,
    "osVersion" : "osVersion",
    "domain" : "domain",
    "name" : "name",
    "agentVersion" : "agentVersion",
    "id" : 6,
    "upgradeRequired" : true,
    "status" : 0
  } ],
  "backupAccountName" : "backupAccountName",
  "ncName" : "ncName",
  "enabled" : true,
  "parentDomain" : "parentDomain",
  "dcAccountName" : "dcAccountName",
  "dcPassword" : "dcPassword",
  "password" : "password",
  "statusDescription" : "statusDescription",
  "netBiosName" : "netBiosName",
  "localDcCollection" : true,
  "agentConfiguration" : {
    "processNestedGroupUserMembers" : true,
    "processNestedGroupMembers" : true,
    "suppressNestedGroupEventData" : true,
    "enableGPOBackup" : true,
    "combineEventsDelay" : 5,
    "enableMissingGPOBackup" : true,
    "ignoreLogonEvents" : true,
    "workstationResolution" : true,
    "combineEventsEnabled" : true,
    "suppressNestedGroupEventBacklinks" : true,
    "processNestedGroupUsers" : true,
    "workstationReverseLookup" : true,
    "nestedGroups" : [ {
      "msdsPrincipalName" : "msdsPrincipalName",
      "presentationName" : "presentationName",
      "displayName" : "displayName",
      "accountExpires" : 3,
      "objectClass" : "objectClass",
      "samAccountName" : "samAccountName",
      "dnsName" : "dnsName",
      "description" : "description",
      "dn" : "dn",
      "cn" : "cn",
      "ldapName" : "ldapName",
      "managerEmail" : "managerEmail",
      "domain" : "domain",
      "objectGuid" : "objectGuid",
      "name" : "name",
      "objectSid" : "objectSid",
      "attributes" : [ {
        "isClass" : true,
        "displayValue" : "displayValue",
        "linkId" : 1,
        "systemOnly" : true,
        "displayName" : "displayName",
        "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "values" : [ "", "" ],
        "name" : "name",
        "aDsType" : 6,
        "id" : 0,
        "isOID" : true,
        "syntaxOID" : "syntaxOID"
      }, {
        "isClass" : true,
        "displayValue" : "displayValue",
        "linkId" : 1,
        "systemOnly" : true,
        "displayName" : "displayName",
        "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "values" : [ "", "" ],
        "name" : "name",
        "aDsType" : 6,
        "id" : 0,
        "isOID" : true,
        "syntaxOID" : "syntaxOID"
      } ],
      "userPrincipalName" : "userPrincipalName",
      "userAccountControl" : 7,
      "pwdLastSet" : 9
    }, {
      "msdsPrincipalName" : "msdsPrincipalName",
      "presentationName" : "presentationName",
      "displayName" : "displayName",
      "accountExpires" : 3,
      "objectClass" : "objectClass",
      "samAccountName" : "samAccountName",
      "dnsName" : "dnsName",
      "description" : "description",
      "dn" : "dn",
      "cn" : "cn",
      "ldapName" : "ldapName",
      "managerEmail" : "managerEmail",
      "domain" : "domain",
      "objectGuid" : "objectGuid",
      "name" : "name",
      "objectSid" : "objectSid",
      "attributes" : [ {
        "isClass" : true,
        "displayValue" : "displayValue",
        "linkId" : 1,
        "systemOnly" : true,
        "displayName" : "displayName",
        "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "values" : [ "", "" ],
        "name" : "name",
        "aDsType" : 6,
        "id" : 0,
        "isOID" : true,
        "syntaxOID" : "syntaxOID"
      }, {
        "isClass" : true,
        "displayValue" : "displayValue",
        "linkId" : 1,
        "systemOnly" : true,
        "displayName" : "displayName",
        "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "values" : [ "", "" ],
        "name" : "name",
        "aDsType" : 6,
        "id" : 0,
        "isOID" : true,
        "syntaxOID" : "syntaxOID"
      } ],
      "userPrincipalName" : "userPrincipalName",
      "userAccountControl" : 7,
      "pwdLastSet" : 9
    } ],
    "logLevel" : 2,
    "processNestedGroups" : true,
    "excludedAttributes" : "excludedAttributes",
    "ldapTimeout" : 2
  },
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "id" : 0,
  "collectionInterval" : 6,
  "status" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DomainConfiguration

Up
delete /api/v{version}/collectors/activedirectory/domains/{id}/controllers/all
(apiVversionCollectorsActivedirectoryDomainsIdControllersAllDelete)

Path parameters

Id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
delete /api/v{version}/collectors/activedirectory/domains/{id}/controllers/{dcid}
(apiVversionCollectorsActivedirectoryDomainsIdControllersDcidDelete)

Path parameters

Id (required)
Path Parameter — format: int32
DcId (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
post /api/v{version}/collectors/activedirectory/domains/{id}/controllers/{dcid}/restart
(apiVversionCollectorsActivedirectoryDomainsIdControllersDcidRestartPost)

Path parameters

id (required)
Path Parameter — format: int32
dcId (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "lastActive" : "2000-01-23T04:56:07.000+00:00",
  "statusMessage" : "statusMessage",
  "enabled" : true,
  "sid" : "sid",
  "netBiosName" : "netBiosName",
  "hasAgent" : true,
  "osVersion" : "osVersion",
  "domain" : "domain",
  "name" : "name",
  "agentVersion" : "agentVersion",
  "id" : 6,
  "upgradeRequired" : true,
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DomainController

Up
post /api/v{version}/collectors/activedirectory/domains/{id}/controllers/{dcid}/start
(apiVversionCollectorsActivedirectoryDomainsIdControllersDcidStartPost)

Path parameters

id (required)
Path Parameter — format: int32
dcId (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "lastActive" : "2000-01-23T04:56:07.000+00:00",
  "statusMessage" : "statusMessage",
  "enabled" : true,
  "sid" : "sid",
  "netBiosName" : "netBiosName",
  "hasAgent" : true,
  "osVersion" : "osVersion",
  "domain" : "domain",
  "name" : "name",
  "agentVersion" : "agentVersion",
  "id" : 6,
  "upgradeRequired" : true,
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DomainController

Up
post /api/v{version}/collectors/activedirectory/domains/{id}/controllers/{dcid}/stop
(apiVversionCollectorsActivedirectoryDomainsIdControllersDcidStopPost)

Path parameters

id (required)
Path Parameter — format: int32
dcId (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "lastActive" : "2000-01-23T04:56:07.000+00:00",
  "statusMessage" : "statusMessage",
  "enabled" : true,
  "sid" : "sid",
  "netBiosName" : "netBiosName",
  "hasAgent" : true,
  "osVersion" : "osVersion",
  "domain" : "domain",
  "name" : "name",
  "agentVersion" : "agentVersion",
  "id" : 6,
  "upgradeRequired" : true,
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DomainController

Up
delete /api/v{version}/collectors/activedirectory/domains/{id}/controllers
(apiVversionCollectorsActivedirectoryDomainsIdControllersDelete)

Path parameters

Id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Query parameters

dcIds (optional)
Query Parameter — format: int32

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/collectors/activedirectory/domains/{id}/controllers
(apiVversionCollectorsActivedirectoryDomainsIdControllersGet)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "lastActive" : "2000-01-23T04:56:07.000+00:00",
  "statusMessage" : "statusMessage",
  "enabled" : true,
  "sid" : "sid",
  "netBiosName" : "netBiosName",
  "hasAgent" : true,
  "osVersion" : "osVersion",
  "domain" : "domain",
  "name" : "name",
  "agentVersion" : "agentVersion",
  "id" : 6,
  "upgradeRequired" : true,
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DomainController

Up
post /api/v{version}/collectors/activedirectory/domains/{id}/controllers
(apiVversionCollectorsActivedirectoryDomainsIdControllersPost)

Path parameters

Id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DomainController (optional)
Body Parameter

Query parameters

force (optional)
Query Parameter — default: false

Return type

Example data

Content-Type: application/json
{
  "lastActive" : "2000-01-23T04:56:07.000+00:00",
  "statusMessage" : "statusMessage",
  "enabled" : true,
  "sid" : "sid",
  "netBiosName" : "netBiosName",
  "hasAgent" : true,
  "osVersion" : "osVersion",
  "domain" : "domain",
  "name" : "name",
  "agentVersion" : "agentVersion",
  "id" : 6,
  "upgradeRequired" : true,
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DomainController

Up
put /api/v{version}/collectors/activedirectory/domains/{id}/controllers
(apiVversionCollectorsActivedirectoryDomainsIdControllersPut)

Path parameters

Id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DomainController (optional)
Body Parameter

Query parameters

force (optional)
Query Parameter — default: false

Return type

Example data

Content-Type: application/json
{
  "lastActive" : "2000-01-23T04:56:07.000+00:00",
  "statusMessage" : "statusMessage",
  "enabled" : true,
  "sid" : "sid",
  "netBiosName" : "netBiosName",
  "hasAgent" : true,
  "osVersion" : "osVersion",
  "domain" : "domain",
  "name" : "name",
  "agentVersion" : "agentVersion",
  "id" : 6,
  "upgradeRequired" : true,
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DomainController

Up
delete /api/v{version}/collectors/activedirectory/domains/{id}
(apiVversionCollectorsActivedirectoryDomainsIdDelete)

Path parameters

Id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/collectors/activedirectory/domains/{id}
(apiVversionCollectorsActivedirectoryDomainsIdGet)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Query parameters

isDCListToBeIncluded (optional)
Query Parameter — default: true

Return type

Example data

Content-Type: application/json
{
  "systemAttributes" : [ "systemAttributes", "systemAttributes" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ActiveDirectoryProfile

Up
put /api/v{version}/collectors/activedirectory/domains/{id}
(apiVversionCollectorsActivedirectoryDomainsIdPut)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DomainConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "accountName" : "accountName",
  "backupPassword" : "backupPassword",
  "flags" : 1,
  "dnsName" : "dnsName",
  "domainControllers" : [ {
    "lastActive" : "2000-01-23T04:56:07.000+00:00",
    "statusMessage" : "statusMessage",
    "enabled" : true,
    "sid" : "sid",
    "netBiosName" : "netBiosName",
    "hasAgent" : true,
    "osVersion" : "osVersion",
    "domain" : "domain",
    "name" : "name",
    "agentVersion" : "agentVersion",
    "id" : 6,
    "upgradeRequired" : true,
    "status" : 0
  }, {
    "lastActive" : "2000-01-23T04:56:07.000+00:00",
    "statusMessage" : "statusMessage",
    "enabled" : true,
    "sid" : "sid",
    "netBiosName" : "netBiosName",
    "hasAgent" : true,
    "osVersion" : "osVersion",
    "domain" : "domain",
    "name" : "name",
    "agentVersion" : "agentVersion",
    "id" : 6,
    "upgradeRequired" : true,
    "status" : 0
  } ],
  "backupAccountName" : "backupAccountName",
  "ncName" : "ncName",
  "enabled" : true,
  "parentDomain" : "parentDomain",
  "dcAccountName" : "dcAccountName",
  "dcPassword" : "dcPassword",
  "password" : "password",
  "statusDescription" : "statusDescription",
  "netBiosName" : "netBiosName",
  "localDcCollection" : true,
  "agentConfiguration" : {
    "processNestedGroupUserMembers" : true,
    "processNestedGroupMembers" : true,
    "suppressNestedGroupEventData" : true,
    "enableGPOBackup" : true,
    "combineEventsDelay" : 5,
    "enableMissingGPOBackup" : true,
    "ignoreLogonEvents" : true,
    "workstationResolution" : true,
    "combineEventsEnabled" : true,
    "suppressNestedGroupEventBacklinks" : true,
    "processNestedGroupUsers" : true,
    "workstationReverseLookup" : true,
    "nestedGroups" : [ {
      "msdsPrincipalName" : "msdsPrincipalName",
      "presentationName" : "presentationName",
      "displayName" : "displayName",
      "accountExpires" : 3,
      "objectClass" : "objectClass",
      "samAccountName" : "samAccountName",
      "dnsName" : "dnsName",
      "description" : "description",
      "dn" : "dn",
      "cn" : "cn",
      "ldapName" : "ldapName",
      "managerEmail" : "managerEmail",
      "domain" : "domain",
      "objectGuid" : "objectGuid",
      "name" : "name",
      "objectSid" : "objectSid",
      "attributes" : [ {
        "isClass" : true,
        "displayValue" : "displayValue",
        "linkId" : 1,
        "systemOnly" : true,
        "displayName" : "displayName",
        "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "values" : [ "", "" ],
        "name" : "name",
        "aDsType" : 6,
        "id" : 0,
        "isOID" : true,
        "syntaxOID" : "syntaxOID"
      }, {
        "isClass" : true,
        "displayValue" : "displayValue",
        "linkId" : 1,
        "systemOnly" : true,
        "displayName" : "displayName",
        "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "values" : [ "", "" ],
        "name" : "name",
        "aDsType" : 6,
        "id" : 0,
        "isOID" : true,
        "syntaxOID" : "syntaxOID"
      } ],
      "userPrincipalName" : "userPrincipalName",
      "userAccountControl" : 7,
      "pwdLastSet" : 9
    }, {
      "msdsPrincipalName" : "msdsPrincipalName",
      "presentationName" : "presentationName",
      "displayName" : "displayName",
      "accountExpires" : 3,
      "objectClass" : "objectClass",
      "samAccountName" : "samAccountName",
      "dnsName" : "dnsName",
      "description" : "description",
      "dn" : "dn",
      "cn" : "cn",
      "ldapName" : "ldapName",
      "managerEmail" : "managerEmail",
      "domain" : "domain",
      "objectGuid" : "objectGuid",
      "name" : "name",
      "objectSid" : "objectSid",
      "attributes" : [ {
        "isClass" : true,
        "displayValue" : "displayValue",
        "linkId" : 1,
        "systemOnly" : true,
        "displayName" : "displayName",
        "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "values" : [ "", "" ],
        "name" : "name",
        "aDsType" : 6,
        "id" : 0,
        "isOID" : true,
        "syntaxOID" : "syntaxOID"
      }, {
        "isClass" : true,
        "displayValue" : "displayValue",
        "linkId" : 1,
        "systemOnly" : true,
        "displayName" : "displayName",
        "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "values" : [ "", "" ],
        "name" : "name",
        "aDsType" : 6,
        "id" : 0,
        "isOID" : true,
        "syntaxOID" : "syntaxOID"
      } ],
      "userPrincipalName" : "userPrincipalName",
      "userAccountControl" : 7,
      "pwdLastSet" : 9
    } ],
    "logLevel" : 2,
    "processNestedGroups" : true,
    "excludedAttributes" : "excludedAttributes",
    "ldapTimeout" : 2
  },
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "id" : 0,
  "collectionInterval" : 6,
  "status" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DomainConfiguration

Up
post /api/v{version}/collectors/activedirectory/domains
(apiVversionCollectorsActivedirectoryDomainsPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DomainConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "accountName" : "accountName",
  "backupPassword" : "backupPassword",
  "flags" : 1,
  "dnsName" : "dnsName",
  "domainControllers" : [ {
    "lastActive" : "2000-01-23T04:56:07.000+00:00",
    "statusMessage" : "statusMessage",
    "enabled" : true,
    "sid" : "sid",
    "netBiosName" : "netBiosName",
    "hasAgent" : true,
    "osVersion" : "osVersion",
    "domain" : "domain",
    "name" : "name",
    "agentVersion" : "agentVersion",
    "id" : 6,
    "upgradeRequired" : true,
    "status" : 0
  }, {
    "lastActive" : "2000-01-23T04:56:07.000+00:00",
    "statusMessage" : "statusMessage",
    "enabled" : true,
    "sid" : "sid",
    "netBiosName" : "netBiosName",
    "hasAgent" : true,
    "osVersion" : "osVersion",
    "domain" : "domain",
    "name" : "name",
    "agentVersion" : "agentVersion",
    "id" : 6,
    "upgradeRequired" : true,
    "status" : 0
  } ],
  "backupAccountName" : "backupAccountName",
  "ncName" : "ncName",
  "enabled" : true,
  "parentDomain" : "parentDomain",
  "dcAccountName" : "dcAccountName",
  "dcPassword" : "dcPassword",
  "password" : "password",
  "statusDescription" : "statusDescription",
  "netBiosName" : "netBiosName",
  "localDcCollection" : true,
  "agentConfiguration" : {
    "processNestedGroupUserMembers" : true,
    "processNestedGroupMembers" : true,
    "suppressNestedGroupEventData" : true,
    "enableGPOBackup" : true,
    "combineEventsDelay" : 5,
    "enableMissingGPOBackup" : true,
    "ignoreLogonEvents" : true,
    "workstationResolution" : true,
    "combineEventsEnabled" : true,
    "suppressNestedGroupEventBacklinks" : true,
    "processNestedGroupUsers" : true,
    "workstationReverseLookup" : true,
    "nestedGroups" : [ {
      "msdsPrincipalName" : "msdsPrincipalName",
      "presentationName" : "presentationName",
      "displayName" : "displayName",
      "accountExpires" : 3,
      "objectClass" : "objectClass",
      "samAccountName" : "samAccountName",
      "dnsName" : "dnsName",
      "description" : "description",
      "dn" : "dn",
      "cn" : "cn",
      "ldapName" : "ldapName",
      "managerEmail" : "managerEmail",
      "domain" : "domain",
      "objectGuid" : "objectGuid",
      "name" : "name",
      "objectSid" : "objectSid",
      "attributes" : [ {
        "isClass" : true,
        "displayValue" : "displayValue",
        "linkId" : 1,
        "systemOnly" : true,
        "displayName" : "displayName",
        "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "values" : [ "", "" ],
        "name" : "name",
        "aDsType" : 6,
        "id" : 0,
        "isOID" : true,
        "syntaxOID" : "syntaxOID"
      }, {
        "isClass" : true,
        "displayValue" : "displayValue",
        "linkId" : 1,
        "systemOnly" : true,
        "displayName" : "displayName",
        "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "values" : [ "", "" ],
        "name" : "name",
        "aDsType" : 6,
        "id" : 0,
        "isOID" : true,
        "syntaxOID" : "syntaxOID"
      } ],
      "userPrincipalName" : "userPrincipalName",
      "userAccountControl" : 7,
      "pwdLastSet" : 9
    }, {
      "msdsPrincipalName" : "msdsPrincipalName",
      "presentationName" : "presentationName",
      "displayName" : "displayName",
      "accountExpires" : 3,
      "objectClass" : "objectClass",
      "samAccountName" : "samAccountName",
      "dnsName" : "dnsName",
      "description" : "description",
      "dn" : "dn",
      "cn" : "cn",
      "ldapName" : "ldapName",
      "managerEmail" : "managerEmail",
      "domain" : "domain",
      "objectGuid" : "objectGuid",
      "name" : "name",
      "objectSid" : "objectSid",
      "attributes" : [ {
        "isClass" : true,
        "displayValue" : "displayValue",
        "linkId" : 1,
        "systemOnly" : true,
        "displayName" : "displayName",
        "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "values" : [ "", "" ],
        "name" : "name",
        "aDsType" : 6,
        "id" : 0,
        "isOID" : true,
        "syntaxOID" : "syntaxOID"
      }, {
        "isClass" : true,
        "displayValue" : "displayValue",
        "linkId" : 1,
        "systemOnly" : true,
        "displayName" : "displayName",
        "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "values" : [ "", "" ],
        "name" : "name",
        "aDsType" : 6,
        "id" : 0,
        "isOID" : true,
        "syntaxOID" : "syntaxOID"
      } ],
      "userPrincipalName" : "userPrincipalName",
      "userAccountControl" : 7,
      "pwdLastSet" : 9
    } ],
    "logLevel" : 2,
    "processNestedGroups" : true,
    "excludedAttributes" : "excludedAttributes",
    "ldapTimeout" : 2
  },
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "id" : 0,
  "collectionInterval" : 6,
  "status" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DomainConfiguration

Up
post /api/v{version}/collectors/activedirectory/domains/search
(apiVversionCollectorsActivedirectoryDomainsSearchPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DomainSearch (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
[ {
  "netBiosName" : "netBiosName",
  "objectGuid" : "objectGuid",
  "dnsName" : "dnsName",
  "id" : 0,
  "ncName" : "ncName"
}, {
  "netBiosName" : "netBiosName",
  "objectGuid" : "objectGuid",
  "dnsName" : "dnsName",
  "id" : 0,
  "ncName" : "ncName"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Event

Up
get /api/v{version}/events/{id}
Retrieve an event (apiVversionEventsIdGet)
Locates a specific event by its ID and retrieves details.

Path parameters

id (required)
Path Parameter — The ID of an event. format: int32
version (required)
Path Parameter

Query parameters

type (required)
Query Parameter — The data source ID.<br><br>0 = Unknown, 1 = Active Directory, 2 = File System, 3 = Azure AD, 4 = Azure AD Sign-In, 5 = Exchange Online, 6 = SharePoint Online, 7 = VMWare, 8 = Active Directory Rollback, 9 = Microsoft Teams, 10 = Cygna Auditor, 11 = OneDrive, 12 = Azure, 14 = Security &amp; Compliance Center, 101 = Active Directory (Blackbird)
database (required)
Query Parameter — The database ID. format: uuid

Return type

Example data

Content-Type: application/json
{
  "organizationId" : 1,
  "displayMessage" : "displayMessage",
  "userCategory" : 5,
  "success" : true,
  "eventTime" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "source" : 6,
  "statusMessage" : "statusMessage"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success AuditEventDetailBase

400

Bad Request. The event ID is not a positive integer or the type is not a valid data source ID.

401

Unauthorized. The request does not contain a valid authorization header and session-id header, or the user is not authorized to read audit events.

410

The requested event was not found.

500

An unexpected error occurred.

Up
post /api/v{version}/events
List events (apiVversionEventsPost)
Searches and retrieves audit events based on search parameters.

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body EventsRequest (optional)
Body Parameter

Query parameters

limit (optional)
Query Parameter — The maximum number of events to retrieve. format: int32
useCoreDatabase (optional)
Query Parameter — The database to search through. default: false

Return type

array[AuditEvent]

Example data

Content-Type: application/json
[ {
  "teamName" : "teamName",
  "vmHost" : "vmHost",
  "resourceGroup" : "resourceGroup",
  "sourceFileName" : "sourceFileName",
  "databaseName" : "databaseName",
  "eventCategory" : "eventCategory",
  "samAccountName" : "samAccountName",
  "when" : "2000-01-23T04:56:07.000+00:00",
  "vmCategory" : "vmCategory",
  "teamMember" : "teamMember",
  "path" : "path",
  "vmType" : "vmType",
  "valueAdded" : "valueAdded",
  "crossMailboxOperations" : true,
  "workstationId" : 5,
  "valueAddedDisplay" : "valueAddedDisplay",
  "eventName" : "eventName",
  "id" : 0,
  "tenant" : "tenant",
  "identityName" : "identityName",
  "attributeValue" : "attributeValue",
  "level" : "level",
  "module" : 6,
  "attributePreviousValue" : "attributePreviousValue",
  "mailboxFolder" : "mailboxFolder",
  "objectClass" : "objectClass",
  "workstation" : "workstation",
  "opn" : 9,
  "external" : true,
  "success" : 1,
  "vm" : "vm",
  "status" : "status",
  "valueRemoved" : "valueRemoved",
  "server" : "server",
  "itemType" : 2,
  "subscription" : "subscription",
  "nativeEventId" : 5,
  "fromAgent" : true,
  "client" : "client",
  "attribute" : "attribute",
  "databaseId" : "databaseId",
  "isRisky" : true,
  "mailboxUPN" : "mailboxUPN",
  "dataCenter" : "dataCenter",
  "aDsType" : 7,
  "workload" : "workload",
  "objectDN" : "objectDN",
  "objectName" : "objectName",
  "dataStore" : "dataStore",
  "teamRole" : "teamRole",
  "location" : "location",
  "accountSid" : "accountSid",
  "user" : "user",
  "operation" : "operation",
  "resourceType" : "resourceType"
}, {
  "teamName" : "teamName",
  "vmHost" : "vmHost",
  "resourceGroup" : "resourceGroup",
  "sourceFileName" : "sourceFileName",
  "databaseName" : "databaseName",
  "eventCategory" : "eventCategory",
  "samAccountName" : "samAccountName",
  "when" : "2000-01-23T04:56:07.000+00:00",
  "vmCategory" : "vmCategory",
  "teamMember" : "teamMember",
  "path" : "path",
  "vmType" : "vmType",
  "valueAdded" : "valueAdded",
  "crossMailboxOperations" : true,
  "workstationId" : 5,
  "valueAddedDisplay" : "valueAddedDisplay",
  "eventName" : "eventName",
  "id" : 0,
  "tenant" : "tenant",
  "identityName" : "identityName",
  "attributeValue" : "attributeValue",
  "level" : "level",
  "module" : 6,
  "attributePreviousValue" : "attributePreviousValue",
  "mailboxFolder" : "mailboxFolder",
  "objectClass" : "objectClass",
  "workstation" : "workstation",
  "opn" : 9,
  "external" : true,
  "success" : 1,
  "vm" : "vm",
  "status" : "status",
  "valueRemoved" : "valueRemoved",
  "server" : "server",
  "itemType" : 2,
  "subscription" : "subscription",
  "nativeEventId" : 5,
  "fromAgent" : true,
  "client" : "client",
  "attribute" : "attribute",
  "databaseId" : "databaseId",
  "isRisky" : true,
  "mailboxUPN" : "mailboxUPN",
  "dataCenter" : "dataCenter",
  "aDsType" : 7,
  "workload" : "workload",
  "objectDN" : "objectDN",
  "objectName" : "objectName",
  "dataStore" : "dataStore",
  "teamRole" : "teamRole",
  "location" : "location",
  "accountSid" : "accountSid",
  "user" : "user",
  "operation" : "operation",
  "resourceType" : "resourceType"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

FileSystem

Up
put /api/v{version}/collectors/filesystem/delete/all
(apiVversionCollectorsFilesystemDeleteAllPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body FileSystemConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "serverName" : "serverName",
  "workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serverId" : 6,
  "version" : "version",
  "serverDnsName" : "serverDnsName",
  "serverSid" : "serverSid",
  "alertCount" : 5,
  "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
  "lastCollection" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "isDriver" : true,
  "collectionInterval" : 5,
  "upgradeRequired" : true,
  "status" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success FileServer

Up
put /api/v{version}/collectors/filesystem/delete
(apiVversionCollectorsFilesystemDeletePut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body FileSystemConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "serverName" : "serverName",
  "workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serverId" : 6,
  "version" : "version",
  "serverDnsName" : "serverDnsName",
  "serverSid" : "serverSid",
  "alertCount" : 5,
  "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
  "lastCollection" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "isDriver" : true,
  "collectionInterval" : 5,
  "upgradeRequired" : true,
  "status" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success FileServer

Up
get /api/v{version}/collectors/filesystem
(apiVversionCollectorsFilesystemGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "serverName" : "serverName",
  "workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serverId" : 6,
  "version" : "version",
  "serverDnsName" : "serverDnsName",
  "serverSid" : "serverSid",
  "alertCount" : 5,
  "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
  "lastCollection" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "isDriver" : true,
  "collectionInterval" : 5,
  "upgradeRequired" : true,
  "status" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success FileServer

Up
get /api/v{version}/collectors/filesystem/{id}
(apiVversionCollectorsFilesystemIdGet)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "serverName" : "serverName",
  "workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serverId" : 6,
  "version" : "version",
  "serverDnsName" : "serverDnsName",
  "serverSid" : "serverSid",
  "alertCount" : 5,
  "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
  "lastCollection" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "isDriver" : true,
  "collectionInterval" : 5,
  "upgradeRequired" : true,
  "status" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success FileServer

Up
post /api/v{version}/collectors/filesystem
(apiVversionCollectorsFilesystemPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body FileSystemConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "serverName" : "serverName",
  "workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serverId" : 6,
  "version" : "version",
  "serverDnsName" : "serverDnsName",
  "serverSid" : "serverSid",
  "alertCount" : 5,
  "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
  "lastCollection" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "isDriver" : true,
  "collectionInterval" : 5,
  "upgradeRequired" : true,
  "status" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success FileServer

Up
put /api/v{version}/collectors/filesystem
(apiVversionCollectorsFilesystemPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body FileSystemConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "serverName" : "serverName",
  "workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serverId" : 6,
  "version" : "version",
  "serverDnsName" : "serverDnsName",
  "serverSid" : "serverSid",
  "alertCount" : 5,
  "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
  "lastCollection" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "isDriver" : true,
  "collectionInterval" : 5,
  "upgradeRequired" : true,
  "status" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success FileServer

Up
put /api/v{version}/collectors/filesystem/restart
(apiVversionCollectorsFilesystemRestartPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body FileSystemConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "serverName" : "serverName",
  "workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serverId" : 6,
  "version" : "version",
  "serverDnsName" : "serverDnsName",
  "serverSid" : "serverSid",
  "alertCount" : 5,
  "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
  "lastCollection" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "isDriver" : true,
  "collectionInterval" : 5,
  "upgradeRequired" : true,
  "status" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success FileServer

Up
post /api/v{version}/collectors/filesystem/search
(apiVversionCollectorsFilesystemSearchPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DomainSearch (optional)
Body Parameter

Return type

array[FileServer]

Example data

Content-Type: application/json
[ {
  "serverName" : "serverName",
  "workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serverId" : 6,
  "version" : "version",
  "serverDnsName" : "serverDnsName",
  "serverSid" : "serverSid",
  "alertCount" : 5,
  "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
  "lastCollection" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "isDriver" : true,
  "collectionInterval" : 5,
  "upgradeRequired" : true,
  "status" : 1
}, {
  "serverName" : "serverName",
  "workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serverId" : 6,
  "version" : "version",
  "serverDnsName" : "serverDnsName",
  "serverSid" : "serverSid",
  "alertCount" : 5,
  "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
  "lastCollection" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "isDriver" : true,
  "collectionInterval" : 5,
  "upgradeRequired" : true,
  "status" : 1
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
put /api/v{version}/collectors/filesystem/start
(apiVversionCollectorsFilesystemStartPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body FileSystemConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "serverName" : "serverName",
  "workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serverId" : 6,
  "version" : "version",
  "serverDnsName" : "serverDnsName",
  "serverSid" : "serverSid",
  "alertCount" : 5,
  "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
  "lastCollection" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "isDriver" : true,
  "collectionInterval" : 5,
  "upgradeRequired" : true,
  "status" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success FileServer

Up
put /api/v{version}/collectors/filesystem/stop
(apiVversionCollectorsFilesystemStopPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body FileSystemConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "serverName" : "serverName",
  "workItemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serverId" : 6,
  "version" : "version",
  "serverDnsName" : "serverDnsName",
  "serverSid" : "serverSid",
  "alertCount" : 5,
  "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
  "lastCollection" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "isDriver" : true,
  "collectionInterval" : 5,
  "upgradeRequired" : true,
  "status" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success FileServer

Filter

Up
get /api/v{version}/collectors/filesystem/filters
(apiVversionCollectorsFilesystemFiltersGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isAlert" : true,
  "reportType" : "reportType",
  "baseQuery" : "baseQuery",
  "sortAscending" : true,
  "clauses" : [ {
    "comparison" : "comparison",
    "field" : "field",
    "values" : [ {
      "value2" : "value2",
      "value1" : "value1"
    }, {
      "value2" : "value2",
      "value1" : "value1"
    } ],
    "type" : "type"
  }, {
    "comparison" : "comparison",
    "field" : "field",
    "values" : [ {
      "value2" : "value2",
      "value1" : "value1"
    }, {
      "value2" : "value2",
      "value1" : "value1"
    } ],
    "type" : "type"
  } ],
  "maxRecordCount" : 0,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "actions" : [ {
    "data" : "data",
    "type" : "type"
  }, {
    "data" : "data",
    "type" : "type"
  } ],
  "enabled" : true,
  "tags" : "tags"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success FilterReport

Up
delete /api/v{version}/collectors/filesystem/filters/{id}
(apiVversionCollectorsFilesystemFiltersIdDelete)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
0

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygStatus

Up
get /api/v{version}/collectors/filesystem/filters/{id}
(apiVversionCollectorsFilesystemFiltersIdGet)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Responses

200

Success

Up
put /api/v{version}/collectors/filesystem/filters/{id}
(apiVversionCollectorsFilesystemFiltersIdPut)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body FilterReport (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
0

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygStatus

Up
post /api/v{version}/collectors/filesystem/filters
(apiVversionCollectorsFilesystemFiltersPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body FilterReport (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
0

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygStatus

Up
post /api/v{version}/collectors/filesystem/filters/shares
(apiVversionCollectorsFilesystemFiltersSharesPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body string (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
0

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygStatus

HealthCheck

Up
post /api/v{version}/healthcheck/all
(apiVversionHealthcheckAllPost)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "name" : "name",
  "description" : "description",
  "statusDetail" : "statusDetail",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success HealthCheck

Up
post /api/v{version}/healthcheck/{id}
(apiVversionHealthcheckIdPost)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "name" : "name",
  "description" : "description",
  "statusDetail" : "statusDetail",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success HealthCheck

Up
post /api/v{version}/healthcheck/ping
(apiVversionHealthcheckPingPost)

Path parameters

version (required)
Path Parameter

Responses

200

Success

IIS

Up
get /api/v{version}/setup/iis/applicationpools/current
(apiVversionSetupIisApplicationpoolsCurrentGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "managedPipelineMode" : 0,
  "identity" : {
    "identityType" : 1,
    "credentials" : {
      "password" : "password",
      "username" : "username"
    }
  },
  "name" : "name",
  "state" : 6,
  "managedRuntimeVersion" : "managedRuntimeVersion"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ApplicationPool

Up
put /api/v{version}/setup/iis/applicationpools/current/identity
(apiVversionSetupIisApplicationpoolsCurrentIdentityPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ApplicationPoolIdentity (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "identityType" : 1,
  "credentials" : {
    "password" : "password",
    "username" : "username"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ApplicationPoolIdentity

Up
post /api/v{version}/setup/iis/applicationpools/current
(apiVversionSetupIisApplicationpoolsCurrentPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ApplicationPool (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "managedPipelineMode" : 0,
  "identity" : {
    "identityType" : 1,
    "credentials" : {
      "password" : "password",
      "username" : "username"
    }
  },
  "name" : "name",
  "state" : 6,
  "managedRuntimeVersion" : "managedRuntimeVersion"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ApplicationPool

Up
put /api/v{version}/setup/iis/applicationpools/current
(apiVversionSetupIisApplicationpoolsCurrentPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ApplicationPool (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "managedPipelineMode" : 0,
  "identity" : {
    "identityType" : 1,
    "credentials" : {
      "password" : "password",
      "username" : "username"
    }
  },
  "name" : "name",
  "state" : 6,
  "managedRuntimeVersion" : "managedRuntimeVersion"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ApplicationPool

Up
post /api/v{version}/setup/iis/applicationpools/current/recycle
(apiVversionSetupIisApplicationpoolsCurrentRecyclePost)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
0

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygStatus

Up
get /api/v{version}/setup/iis/applicationpools
(apiVversionSetupIisApplicationpoolsGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "managedPipelineMode" : 0,
  "identity" : {
    "identityType" : 1,
    "credentials" : {
      "password" : "password",
      "username" : "username"
    }
  },
  "name" : "name",
  "state" : 6,
  "managedRuntimeVersion" : "managedRuntimeVersion"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ApplicationPool

Identity

Up
delete /api/v{version}/identity/all
Delete identities (apiVversionIdentityAllDelete)
Revokes all identity settings. The accounts will no longer be associated with each other and will be treated as separate accounts.

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/identity
List identities (apiVversionIdentityGet)
Retrieves a list of available Cygna identities. An identity enables you to manage several accounts of the same person as one. For example, on-premises Active Directory account and Azure AD account.

Path parameters

version (required)
Path Parameter

Query parameters

searchText (optional)
Query Parameter — Provide a Cygna identity name to search for it.

Return type

array[Identity]

Example data

Content-Type: application/json
[ {
  "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
  "name" : "name",
  "description" : "description",
  "id" : 0,
  "accounts" : [ {
    "accountId" : 5,
    "accountName" : "accountName",
    "identityId" : 1,
    "displayName" : "displayName",
    "securityIdentifier" : "securityIdentifier",
    "id" : 6,
    "source" : 5,
    "state" : 2
  }, {
    "accountId" : 5,
    "accountName" : "accountName",
    "identityId" : 1,
    "displayName" : "displayName",
    "securityIdentifier" : "securityIdentifier",
    "id" : 6,
    "source" : 5,
    "state" : 2
  } ]
}, {
  "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
  "name" : "name",
  "description" : "description",
  "id" : 0,
  "accounts" : [ {
    "accountId" : 5,
    "accountName" : "accountName",
    "identityId" : 1,
    "displayName" : "displayName",
    "securityIdentifier" : "securityIdentifier",
    "id" : 6,
    "source" : 5,
    "state" : 2
  }, {
    "accountId" : 5,
    "accountName" : "accountName",
    "identityId" : 1,
    "displayName" : "displayName",
    "securityIdentifier" : "securityIdentifier",
    "id" : 6,
    "source" : 5,
    "state" : 2
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
delete /api/v{version}/identity/{id}
Delete an identity (apiVversionIdentityIdDelete)
Locates a Cygna identity by its ID and deletes it. Provide an ID in the path.

Path parameters

id (required)
Path Parameter — Cygna identity ID format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/identity/{id}
Retrieve an identity (apiVversionIdentityIdGet)
Locates a Cygna identity by its ID and retrieves its details. Provide an ID in the path.

Path parameters

id (required)
Path Parameter — Cygna identity ID format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
  "name" : "name",
  "description" : "description",
  "id" : 0,
  "accounts" : [ {
    "accountId" : 5,
    "accountName" : "accountName",
    "identityId" : 1,
    "displayName" : "displayName",
    "securityIdentifier" : "securityIdentifier",
    "id" : 6,
    "source" : 5,
    "state" : 2
  }, {
    "accountId" : 5,
    "accountName" : "accountName",
    "identityId" : 1,
    "displayName" : "displayName",
    "securityIdentifier" : "securityIdentifier",
    "id" : 6,
    "source" : 5,
    "state" : 2
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Identity

Up
put /api/v{version}/identity/{id}
Update an identity (apiVversionIdentityIdPut)
Locates a Cygna identity by its ID and modifies it. Provide an ID in the path.

Path parameters

id (required)
Path Parameter — Cygna identity ID format: int32
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body Identity (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
  "name" : "name",
  "description" : "description",
  "id" : 0,
  "accounts" : [ {
    "accountId" : 5,
    "accountName" : "accountName",
    "identityId" : 1,
    "displayName" : "displayName",
    "securityIdentifier" : "securityIdentifier",
    "id" : 6,
    "source" : 5,
    "state" : 2
  }, {
    "accountId" : 5,
    "accountName" : "accountName",
    "identityId" : 1,
    "displayName" : "displayName",
    "securityIdentifier" : "securityIdentifier",
    "id" : 6,
    "source" : 5,
    "state" : 2
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Identity

Up
delete /api/v{version}/identity/{identity}/accounts/{id}
Remove an account from identity (apiVversionIdentityIdentityAccountsIdDelete)
Locates an account by its ID and removes mapping with a Cygna identity. The account will no longer be associated with this identity. Provide identity and id in the path.

Path parameters

id (required)
Path Parameter — User account ID format: int32
version (required)
Path Parameter
identity (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
post /api/v{version}/identity
Create an identity (apiVversionIdentityPost)
Adds a new custom identity. An identity enables you to combine several accounts of the same person and manage as one. For example, on-premises Active Directory account and Azure AD account.

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body Identity (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
  "name" : "name",
  "description" : "description",
  "id" : 0,
  "accounts" : [ {
    "accountId" : 5,
    "accountName" : "accountName",
    "identityId" : 1,
    "displayName" : "displayName",
    "securityIdentifier" : "securityIdentifier",
    "id" : 6,
    "source" : 5,
    "state" : 2
  }, {
    "accountId" : 5,
    "accountName" : "accountName",
    "identityId" : 1,
    "displayName" : "displayName",
    "securityIdentifier" : "securityIdentifier",
    "id" : 6,
    "source" : 5,
    "state" : 2
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Identity

License

Up
delete /api/v{version}/system/config/license
(apiVversionSystemConfigLicenseDelete)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
0

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygStatus

Up
get /api/v{version}/system/config/license
(apiVversionSystemConfigLicenseGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "generatedOn" : "2000-01-23T04:56:07.000+00:00",
  "configuration" : {
    "xml" : "xml",
    "companyName" : "companyName"
  },
  "maintenanceExpiry" : "2000-01-23T04:56:07.000+00:00",
  "company" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "version" : 1,
  "modules" : [ {
    "licenseType" : 6,
    "endDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "count" : 0,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "licenseType" : 6,
    "endDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "count" : 0,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success License

Up
post /api/v{version}/system/config/license
(apiVversionSystemConfigLicensePost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body string (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "generatedOn" : "2000-01-23T04:56:07.000+00:00",
  "configuration" : {
    "xml" : "xml",
    "companyName" : "companyName"
  },
  "maintenanceExpiry" : "2000-01-23T04:56:07.000+00:00",
  "company" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "version" : 1,
  "modules" : [ {
    "licenseType" : 6,
    "endDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "count" : 0,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "licenseType" : 6,
    "endDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "count" : 0,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success License

Up
get /api/v{version}/system/config/license/status
(apiVversionSystemConfigLicenseStatusGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isConfigured" : true,
  "item" : 0,
  "displayName" : "displayName"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ConfigurationStatus

Up
post /api/v{version}/system/config/license/verify
(apiVversionSystemConfigLicenseVerifyPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body string (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "generatedOn" : "2000-01-23T04:56:07.000+00:00",
  "configuration" : {
    "xml" : "xml",
    "companyName" : "companyName"
  },
  "maintenanceExpiry" : "2000-01-23T04:56:07.000+00:00",
  "company" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "version" : 1,
  "modules" : [ {
    "licenseType" : 6,
    "endDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "count" : 0,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "licenseType" : 6,
    "endDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "count" : 0,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success License

Log

Up
get /api/v{version}/system/log/config
(apiVversionSystemLogConfigGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "level" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success LogConfiguration

Up
post /api/v{version}/system/log
(apiVversionSystemLogPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body LogMessage (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Logging

Up
delete /api/v{version}/system/config/logging
(apiVversionSystemConfigLoggingDelete)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/system/config/logging
(apiVversionSystemConfigLoggingGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isStatusEventsLoggingEnabled" : true,
  "isApiLoggingEnabled" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success LoggingConfiguration

Up
post /api/v{version}/system/config/logging
(apiVversionSystemConfigLoggingPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body LoggingConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "isStatusEventsLoggingEnabled" : true,
  "isApiLoggingEnabled" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success LoggingConfiguration

Up
put /api/v{version}/system/config/logging
(apiVversionSystemConfigLoggingPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body LoggingConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "isStatusEventsLoggingEnabled" : true,
  "isApiLoggingEnabled" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success LoggingConfiguration

Office365

Up
put /api/v{version}/collectors/o365/refreshLicense
(apiVversionCollectorsO365RefreshLicensePut)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/collectors/o365/teams/channels
Search for MS Teams channels that have IDs in the supplied list. (apiVversionCollectorsO365TeamsChannelsGet)
Return a lists of channel objects (from Microsoft Teams) based on the search criteria.

Path parameters

version (required)
Path Parameter

Query parameters

channelIds (optional)
Query Parameter — A list of integer channel IDs. format: int32

Return type

array[TeamsChannel]

Example data

Content-Type: application/json
[ {
  "teamName" : "teamName",
  "mailboxUpn" : "mailboxUpn",
  "teamGuid" : "teamGuid",
  "channelName" : "channelName",
  "channelType" : "channelType",
  "id" : 0,
  "channelGuid" : "channelGuid"
}, {
  "teamName" : "teamName",
  "mailboxUpn" : "mailboxUpn",
  "teamGuid" : "teamGuid",
  "channelName" : "channelName",
  "channelType" : "channelType",
  "id" : 0,
  "channelGuid" : "channelGuid"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
get /api/v{version}/collectors/o365/teams/{searchString}/channels
Search for MS Teams channels that match the search string by team name. (apiVversionCollectorsO365TeamsSearchStringChannelsGet)
Return a lists of channel objects (from Microsoft Teams) based on the search criteria.

Path parameters

searchString (required)
Path Parameter — A partial team name.
version (required)
Path Parameter

Query parameters

includeChannelsWithoutEmail (optional)
Query Parameter — Whether or not to include teams channels without a group email address in the results. default: true

Return type

array[TeamsChannel]

Example data

Content-Type: application/json
[ {
  "teamName" : "teamName",
  "mailboxUpn" : "mailboxUpn",
  "teamGuid" : "teamGuid",
  "channelName" : "channelName",
  "channelType" : "channelType",
  "id" : 0,
  "channelGuid" : "channelGuid"
}, {
  "teamName" : "teamName",
  "mailboxUpn" : "mailboxUpn",
  "teamGuid" : "teamGuid",
  "channelName" : "channelName",
  "channelType" : "channelType",
  "id" : 0,
  "channelGuid" : "channelGuid"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
get /api/v{version}/collectors/o365/tenants
(apiVversionCollectorsO365TenantsGet)

Path parameters

version (required)
Path Parameter

Return type

array[Tenant]

Example data

Content-Type: application/json
[ {
  "displayName" : "displayName",
  "tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "interval" : 6,
  "id" : 0,
  "tenantCode" : "tenantCode",
  "enabled" : true
}, {
  "displayName" : "displayName",
  "tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "interval" : 6,
  "id" : 0,
  "tenantCode" : "tenantCode",
  "enabled" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
delete /api/v{version}/collectors/o365/tenants/{id}
(apiVversionCollectorsO365TenantsIdDelete)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/collectors/o365/tenants/{id}
(apiVversionCollectorsO365TenantsIdGet)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "displayName" : "displayName",
  "tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "interval" : 6,
  "id" : 0,
  "tenantCode" : "tenantCode",
  "enabled" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Tenant

Up
put /api/v{version}/collectors/o365/tenants/{id}
(apiVversionCollectorsO365TenantsIdPut)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body Tenant (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "displayName" : "displayName",
  "tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "interval" : 6,
  "id" : 0,
  "tenantCode" : "tenantCode",
  "enabled" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Tenant

Up
post /api/v{version}/collectors/o365/tenants
(apiVversionCollectorsO365TenantsPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body TenantState (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "displayName" : "displayName",
  "tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "interval" : 6,
  "id" : 0,
  "tenantCode" : "tenantCode",
  "enabled" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Tenant

Up
get /api/v{version}/collectors/o365/tenants/precursor
(apiVversionCollectorsO365TenantsPrecursorGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "authorizationUrl" : "authorizationUrl",
  "state" : {
    "state" : "state"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success TenantPrecursor

Up
get /api/v{version}/collectors/o365/verify
(apiVversionCollectorsO365VerifyGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Permission

Up
get /api/v{version}/delegation/permissions
List permissions (apiVversionDelegationPermissionsGet)
Retrieves all available permissions.

Path parameters

version (required)
Path Parameter

Return type

array[Permission]

Example data

Content-Type: application/json
[ {
  "code" : 0,
  "visible" : true,
  "configuration" : "configuration",
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "category" : "category",
  "shortName" : "shortName",
  "type" : "type",
  "displayPermission" : "displayPermission"
}, {
  "code" : 0,
  "visible" : true,
  "configuration" : "configuration",
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "category" : "category",
  "shortName" : "shortName",
  "type" : "type",
  "displayPermission" : "displayPermission"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Profile

Up
get /api/v{version}/collectors/activedirectory/profile
(apiVversionCollectorsActivedirectoryProfileGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "systemAttributes" : [ "systemAttributes", "systemAttributes" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ActiveDirectoryProfile

Protection

Up
delete /api/v{version}/protector/domain/{domainId}/policies
(apiVversionProtectorDomainDomainIdPoliciesDelete)

Path parameters

domainId (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/protector/domain/{domainId}/policies
(apiVversionProtectorDomainDomainIdPoliciesGet)

Path parameters

domainId (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
[ {
  "rule" : {
    "builtIn" : true,
    "name" : "name",
    "description" : "description",
    "id" : 5,
    "defaultAllow" : true,
    "filters" : [ {
      "objectClasses" : [ "objectClasses", "objectClasses" ],
      "objects" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      } ],
      "eventMask" : 7,
      "attributes" : [ "attributes", "attributes" ],
      "id" : 2,
      "accounts" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      } ]
    }, {
      "objectClasses" : [ "objectClasses", "objectClasses" ],
      "objects" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      } ],
      "eventMask" : 7,
      "attributes" : [ "attributes", "attributes" ],
      "id" : 2,
      "accounts" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      } ]
    } ]
  },
  "id" : 0,
  "ruleId" : 1,
  "domainId" : 6,
  "enabled" : true,
  "actionMask" : 5
}, {
  "rule" : {
    "builtIn" : true,
    "name" : "name",
    "description" : "description",
    "id" : 5,
    "defaultAllow" : true,
    "filters" : [ {
      "objectClasses" : [ "objectClasses", "objectClasses" ],
      "objects" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      } ],
      "eventMask" : 7,
      "attributes" : [ "attributes", "attributes" ],
      "id" : 2,
      "accounts" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      } ]
    }, {
      "objectClasses" : [ "objectClasses", "objectClasses" ],
      "objects" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      } ],
      "eventMask" : 7,
      "attributes" : [ "attributes", "attributes" ],
      "id" : 2,
      "accounts" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      } ]
    } ]
  },
  "id" : 0,
  "ruleId" : 1,
  "domainId" : 6,
  "enabled" : true,
  "actionMask" : 5
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
post /api/v{version}/protector/domain/policies/export/{domainId}
(apiVversionProtectorDomainPoliciesExportDomainIdPost)

Path parameters

domainId (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success byte[]

Up
get /api/v{version}/protector/domain/policies
(apiVversionProtectorDomainPoliciesGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
[ {
  "rule" : {
    "builtIn" : true,
    "name" : "name",
    "description" : "description",
    "id" : 5,
    "defaultAllow" : true,
    "filters" : [ {
      "objectClasses" : [ "objectClasses", "objectClasses" ],
      "objects" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      } ],
      "eventMask" : 7,
      "attributes" : [ "attributes", "attributes" ],
      "id" : 2,
      "accounts" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      } ]
    }, {
      "objectClasses" : [ "objectClasses", "objectClasses" ],
      "objects" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      } ],
      "eventMask" : 7,
      "attributes" : [ "attributes", "attributes" ],
      "id" : 2,
      "accounts" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      } ]
    } ]
  },
  "id" : 0,
  "ruleId" : 1,
  "domainId" : 6,
  "enabled" : true,
  "actionMask" : 5
}, {
  "rule" : {
    "builtIn" : true,
    "name" : "name",
    "description" : "description",
    "id" : 5,
    "defaultAllow" : true,
    "filters" : [ {
      "objectClasses" : [ "objectClasses", "objectClasses" ],
      "objects" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      } ],
      "eventMask" : 7,
      "attributes" : [ "attributes", "attributes" ],
      "id" : 2,
      "accounts" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      } ]
    }, {
      "objectClasses" : [ "objectClasses", "objectClasses" ],
      "objects" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      } ],
      "eventMask" : 7,
      "attributes" : [ "attributes", "attributes" ],
      "id" : 2,
      "accounts" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      } ]
    } ]
  },
  "id" : 0,
  "ruleId" : 1,
  "domainId" : 6,
  "enabled" : true,
  "actionMask" : 5
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
delete /api/v{version}/protector/domain/policies/{policyId}
(apiVversionProtectorDomainPoliciesPolicyIdDelete)

Path parameters

policyId (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/protector/domain/policies/{policyId}
(apiVversionProtectorDomainPoliciesPolicyIdGet)

Path parameters

policyId (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
[ {
  "rule" : {
    "builtIn" : true,
    "name" : "name",
    "description" : "description",
    "id" : 5,
    "defaultAllow" : true,
    "filters" : [ {
      "objectClasses" : [ "objectClasses", "objectClasses" ],
      "objects" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      } ],
      "eventMask" : 7,
      "attributes" : [ "attributes", "attributes" ],
      "id" : 2,
      "accounts" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      } ]
    }, {
      "objectClasses" : [ "objectClasses", "objectClasses" ],
      "objects" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      } ],
      "eventMask" : 7,
      "attributes" : [ "attributes", "attributes" ],
      "id" : 2,
      "accounts" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      } ]
    } ]
  },
  "id" : 0,
  "ruleId" : 1,
  "domainId" : 6,
  "enabled" : true,
  "actionMask" : 5
}, {
  "rule" : {
    "builtIn" : true,
    "name" : "name",
    "description" : "description",
    "id" : 5,
    "defaultAllow" : true,
    "filters" : [ {
      "objectClasses" : [ "objectClasses", "objectClasses" ],
      "objects" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      } ],
      "eventMask" : 7,
      "attributes" : [ "attributes", "attributes" ],
      "id" : 2,
      "accounts" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      } ]
    }, {
      "objectClasses" : [ "objectClasses", "objectClasses" ],
      "objects" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "objectClass" : "objectClass",
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "inheritance" : 2,
        "dn" : "dn",
        "id" : 3,
        "domainId" : 4
      } ],
      "eventMask" : 7,
      "attributes" : [ "attributes", "attributes" ],
      "id" : 2,
      "accounts" : [ {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      }, {
        "excluded" : true,
        "displayName" : "displayName",
        "domain" : "domain",
        "dn" : "dn",
        "id" : 9,
        "sid" : "sid"
      } ]
    } ]
  },
  "id" : 0,
  "ruleId" : 1,
  "domainId" : 6,
  "enabled" : true,
  "actionMask" : 5
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
post /api/v{version}/protector/domain/policies
(apiVversionProtectorDomainPoliciesPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DomainProtectionPolicy (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
put /api/v{version}/protector/policies
(apiVversionProtectorPoliciesPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DomainProtectionPolicy (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/protector/rules
(apiVversionProtectorRulesGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
[ {
  "builtIn" : true,
  "name" : "name",
  "description" : "description",
  "id" : 5,
  "defaultAllow" : true,
  "filters" : [ {
    "objectClasses" : [ "objectClasses", "objectClasses" ],
    "objects" : [ {
      "excluded" : true,
      "displayName" : "displayName",
      "objectClass" : "objectClass",
      "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "inheritance" : 2,
      "dn" : "dn",
      "id" : 3,
      "domainId" : 4
    }, {
      "excluded" : true,
      "displayName" : "displayName",
      "objectClass" : "objectClass",
      "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "inheritance" : 2,
      "dn" : "dn",
      "id" : 3,
      "domainId" : 4
    } ],
    "eventMask" : 7,
    "attributes" : [ "attributes", "attributes" ],
    "id" : 2,
    "accounts" : [ {
      "excluded" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "dn" : "dn",
      "id" : 9,
      "sid" : "sid"
    }, {
      "excluded" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "dn" : "dn",
      "id" : 9,
      "sid" : "sid"
    } ]
  }, {
    "objectClasses" : [ "objectClasses", "objectClasses" ],
    "objects" : [ {
      "excluded" : true,
      "displayName" : "displayName",
      "objectClass" : "objectClass",
      "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "inheritance" : 2,
      "dn" : "dn",
      "id" : 3,
      "domainId" : 4
    }, {
      "excluded" : true,
      "displayName" : "displayName",
      "objectClass" : "objectClass",
      "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "inheritance" : 2,
      "dn" : "dn",
      "id" : 3,
      "domainId" : 4
    } ],
    "eventMask" : 7,
    "attributes" : [ "attributes", "attributes" ],
    "id" : 2,
    "accounts" : [ {
      "excluded" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "dn" : "dn",
      "id" : 9,
      "sid" : "sid"
    }, {
      "excluded" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "dn" : "dn",
      "id" : 9,
      "sid" : "sid"
    } ]
  } ]
}, {
  "builtIn" : true,
  "name" : "name",
  "description" : "description",
  "id" : 5,
  "defaultAllow" : true,
  "filters" : [ {
    "objectClasses" : [ "objectClasses", "objectClasses" ],
    "objects" : [ {
      "excluded" : true,
      "displayName" : "displayName",
      "objectClass" : "objectClass",
      "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "inheritance" : 2,
      "dn" : "dn",
      "id" : 3,
      "domainId" : 4
    }, {
      "excluded" : true,
      "displayName" : "displayName",
      "objectClass" : "objectClass",
      "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "inheritance" : 2,
      "dn" : "dn",
      "id" : 3,
      "domainId" : 4
    } ],
    "eventMask" : 7,
    "attributes" : [ "attributes", "attributes" ],
    "id" : 2,
    "accounts" : [ {
      "excluded" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "dn" : "dn",
      "id" : 9,
      "sid" : "sid"
    }, {
      "excluded" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "dn" : "dn",
      "id" : 9,
      "sid" : "sid"
    } ]
  }, {
    "objectClasses" : [ "objectClasses", "objectClasses" ],
    "objects" : [ {
      "excluded" : true,
      "displayName" : "displayName",
      "objectClass" : "objectClass",
      "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "inheritance" : 2,
      "dn" : "dn",
      "id" : 3,
      "domainId" : 4
    }, {
      "excluded" : true,
      "displayName" : "displayName",
      "objectClass" : "objectClass",
      "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "inheritance" : 2,
      "dn" : "dn",
      "id" : 3,
      "domainId" : 4
    } ],
    "eventMask" : 7,
    "attributes" : [ "attributes", "attributes" ],
    "id" : 2,
    "accounts" : [ {
      "excluded" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "dn" : "dn",
      "id" : 9,
      "sid" : "sid"
    }, {
      "excluded" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "dn" : "dn",
      "id" : 9,
      "sid" : "sid"
    } ]
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
post /api/v{version}/protector/rules
(apiVversionProtectorRulesPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ProtectionRule (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
put /api/v{version}/protector/rules
(apiVversionProtectorRulesPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ProtectionRule (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
delete /api/v{version}/protector/rules/{ruleId}
(apiVversionProtectorRulesRuleIdDelete)

Path parameters

ruleId (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/protector/rules/{ruleId}
(apiVversionProtectorRulesRuleIdGet)

Path parameters

ruleId (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "builtIn" : true,
  "name" : "name",
  "description" : "description",
  "id" : 5,
  "defaultAllow" : true,
  "filters" : [ {
    "objectClasses" : [ "objectClasses", "objectClasses" ],
    "objects" : [ {
      "excluded" : true,
      "displayName" : "displayName",
      "objectClass" : "objectClass",
      "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "inheritance" : 2,
      "dn" : "dn",
      "id" : 3,
      "domainId" : 4
    }, {
      "excluded" : true,
      "displayName" : "displayName",
      "objectClass" : "objectClass",
      "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "inheritance" : 2,
      "dn" : "dn",
      "id" : 3,
      "domainId" : 4
    } ],
    "eventMask" : 7,
    "attributes" : [ "attributes", "attributes" ],
    "id" : 2,
    "accounts" : [ {
      "excluded" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "dn" : "dn",
      "id" : 9,
      "sid" : "sid"
    }, {
      "excluded" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "dn" : "dn",
      "id" : 9,
      "sid" : "sid"
    } ]
  }, {
    "objectClasses" : [ "objectClasses", "objectClasses" ],
    "objects" : [ {
      "excluded" : true,
      "displayName" : "displayName",
      "objectClass" : "objectClass",
      "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "inheritance" : 2,
      "dn" : "dn",
      "id" : 3,
      "domainId" : 4
    }, {
      "excluded" : true,
      "displayName" : "displayName",
      "objectClass" : "objectClass",
      "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "inheritance" : 2,
      "dn" : "dn",
      "id" : 3,
      "domainId" : 4
    } ],
    "eventMask" : 7,
    "attributes" : [ "attributes", "attributes" ],
    "id" : 2,
    "accounts" : [ {
      "excluded" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "dn" : "dn",
      "id" : 9,
      "sid" : "sid"
    }, {
      "excluded" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "dn" : "dn",
      "id" : 9,
      "sid" : "sid"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ProtectionRule

Proxy

Up
post /api/v{version}/system/config/proxy/delete
(apiVversionSystemConfigProxyDeletePost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body AccountCredentials (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/system/config/proxy
(apiVversionSystemConfigProxyGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "server" : "server",
  "isProxyToBeUsed" : true,
  "port" : 0,
  "userCredentials" : {
    "password" : "password",
    "username" : "username"
  },
  "isSpecificUserToBeUsed" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ProxyConfigurationWeb

Up
post /api/v{version}/system/config/proxy
(apiVversionSystemConfigProxyPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ProxyConfigurationWeb (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "server" : "server",
  "isProxyToBeUsed" : true,
  "port" : 0,
  "userCredentials" : {
    "password" : "password",
    "username" : "username"
  },
  "isSpecificUserToBeUsed" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ProxyConfigurationWeb

Up
put /api/v{version}/system/config/proxy
(apiVversionSystemConfigProxyPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ProxyConfigurationWeb (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "server" : "server",
  "isProxyToBeUsed" : true,
  "port" : 0,
  "userCredentials" : {
    "password" : "password",
    "username" : "username"
  },
  "isSpecificUserToBeUsed" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ProxyConfigurationWeb

Up
get /api/v{version}/system/config/proxy/status
(apiVversionSystemConfigProxyStatusGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isConfigured" : true,
  "item" : 0,
  "displayName" : "displayName"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ConfigurationStatus

Up
post /api/v{version}/system/config/proxy/test
(apiVversionSystemConfigProxyTestPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ProxyConfigurationWeb (optional)
Body Parameter

Query parameters

url (optional)
Query Parameter — format: uri

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
post /api/v{version}/system/config/proxy/verify
(apiVversionSystemConfigProxyVerifyPost)

Path parameters

version (required)
Path Parameter

Query parameters

url (optional)
Query Parameter — format: uri

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Recovery

Up
get /api/v{version}/collectors/activedirectory/recovery
(apiVversionCollectorsActivedirectoryRecoveryGet)

Path parameters

version (required)
Path Parameter

Query parameters

domain (optional)
Query Parameter — format: int32
type (optional)
Query Parameter
days (optional)
Query Parameter — default: 0 format: int32
limit (optional)
Query Parameter — default: 0 format: int32

Return type

Example data

Content-Type: application/json
{
  "presentationName" : "presentationName",
  "displayName" : "displayName",
  "accountExpires" : 1,
  "deletedOn" : "2000-01-23T04:56:07.000+00:00",
  "samAccountName" : "samAccountName",
  "dnsName" : "dnsName",
  "description" : "description",
  "distinguishedName" : "distinguishedName",
  "dn" : "dn",
  "lastKnownParent" : "lastKnownParent",
  "timeLeftBeforePurge" : "timeLeftBeforePurge",
  "ldapName" : "ldapName",
  "managerEmail" : "managerEmail",
  "hasInferiors" : true,
  "userPrincipalName" : "userPrincipalName",
  "userAccountControl" : 0,
  "msdsPrincipalName" : "msdsPrincipalName",
  "objectClass" : "objectClass",
  "cn" : "cn",
  "rawValues" : {
    "key" : [ "", "" ]
  },
  "showInAdvancedViewOnly" : true,
  "domain" : "domain",
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "objectSid" : "objectSid",
  "attributes" : [ {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  }, {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  } ],
  "pwdLastSet" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DeletedObject

Up
post /api/v{version}/collectors/activedirectory/recovery/password
(apiVversionCollectorsActivedirectoryRecoveryPasswordPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body RecoveryRequest (optional)
Body Parameter

Return type

Boolean

Example data

Content-Type: application/json
true

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Boolean

Up
post /api/v{version}/collectors/activedirectory/recovery
(apiVversionCollectorsActivedirectoryRecoveryPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body RecoveryRequest (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "exception" : {
    "helpLink" : "helpLink",
    "data" : {
      "key" : ""
    },
    "targetSite" : {
      "isStatic" : true,
      "metadataToken" : 2,
      "isAssembly" : true,
      "isCollectible" : true,
      "isHideBySig" : true,
      "isSecurityTransparent" : true,
      "isPrivate" : true,
      "isSecuritySafeCritical" : true,
      "isPublic" : true,
      "isGenericMethod" : true,
      "isFinal" : true,
      "containsGenericParameters" : true,
      "declaringType" : {
        "isSealed" : true,
        "genericParameterPosition" : 1,
        "isAnsiClass" : true,
        "metadataToken" : 6,
        "isContextful" : true,
        "isLayoutSequential" : true,
        "isCollectible" : true,
        "isNestedFamANDAssem" : true,
        "isExplicitLayout" : true,
        "isTypeDefinition" : true,
        "isSecuritySafeCritical" : true,
        "isGenericTypeDefinition" : true,
        "isNestedPrivate" : true,
        "isVariableBoundArray" : true,
        "isInterface" : true,
        "isNestedPublic" : true,
        "isUnicodeClass" : true,
        "isNestedAssembly" : true,
        "isAutoLayout" : true,
        "isPointer" : true,
        "isSpecialName" : true,
        "isVisible" : true,
        "isSecurityCritical" : true,
        "isNotPublic" : true,
        "isNestedFamORAssem" : true,
        "isMarshalByRef" : true,
        "isGenericParameter" : true,
        "isByRef" : true,
        "name" : "name",
        "isSerializable" : true,
        "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "isArray" : true,
        "isPrimitive" : true,
        "customAttributes" : [ {
          "namedArguments" : [ {
            "isField" : true,
            "memberName" : "memberName"
          }, {
            "isField" : true,
            "memberName" : "memberName"
          } ],
          "constructor" : {
            "isStatic" : true,
            "metadataToken" : 3,
            "isAssembly" : true,
            "isCollectible" : true,
            "isHideBySig" : true,
            "isSecurityTransparent" : true,
            "isPrivate" : true,
            "isSecuritySafeCritical" : true,
            "isPublic" : true,
            "isGenericMethod" : true,
            "isFinal" : true,
            "containsGenericParameters" : true,
            "isGenericMethodDefinition" : true,
            "module" : {
              "metadataToken" : 6,
              "mdStreamVersion" : 8,
              "scopeName" : "scopeName",
              "assembly" : {
                "isDynamic" : true,
                "codeBase" : "codeBase",
                "isCollectible" : true,
                "escapedCodeBase" : "escapedCodeBase",
                "fullName" : "fullName",
                "reflectionOnly" : true,
                "modules" : [ null, null ],
                "hostContext" : 9,
                "definedTypes" : [ {
                  "isSealed" : true,
                  "genericParameterPosition" : 5,
                  "isAnsiClass" : true,
                  "metadataToken" : 1,
                  "isContextful" : true,
                  "isLayoutSequential" : true,
                  "isCollectible" : true,
                  "isNestedFamANDAssem" : true,
                  "isExplicitLayout" : true,
                  "isTypeDefinition" : true,
                  "isSecuritySafeCritical" : true,
                  "declaredConstructors" : [ null, null ],
                  "isGenericTypeDefinition" : true,
                  "declaredFields" : [ {
                    "isStatic" : true,
                    "metadataToken" : 1,
                    "isAssembly" : true,
                    "isCollectible" : true,
                    "isSecurityTransparent" : true,
                    "isPrivate" : true,
                    "isNotSerialized" : true,
                    "isSecuritySafeCritical" : true,
                    "fieldHandle" : { },
                    "isInitOnly" : true,
                    "isPublic" : true,
                    "isFamilyOrAssembly" : true,
                    "isSpecialName" : true,
                    "isFamily" : true,
                    "isSecurityCritical" : true,
                    "isPinvokeImpl" : true,
                    "isLiteral" : true,
                    "isFamilyAndAssembly" : true,
                    "name" : "name",
                    "attributes" : 4,
                    "customAttributes" : [ null, null ]
                  }, {
                    "isStatic" : true,
                    "metadataToken" : 1,
                    "isAssembly" : true,
                    "isCollectible" : true,
                    "isSecurityTransparent" : true,
                    "isPrivate" : true,
                    "isNotSerialized" : true,
                    "isSecuritySafeCritical" : true,
                    "fieldHandle" : { },
                    "isInitOnly" : true,
                    "isPublic" : true,
                    "isFamilyOrAssembly" : true,
                    "isSpecialName" : true,
                    "isFamily" : true,
                    "isSecurityCritical" : true,
                    "isPinvokeImpl" : true,
                    "isLiteral" : true,
                    "isFamilyAndAssembly" : true,
                    "name" : "name",
                    "attributes" : 4,
                    "customAttributes" : [ null, null ]
                  } ],
                  "declaredMembers" : [ null, null ],
                  "isNestedPrivate" : true,
                  "isVariableBoundArray" : true,
                  "isInterface" : true,
                  "isNestedPublic" : true,
                  "isUnicodeClass" : true,
                  "isNestedAssembly" : true,
                  "isAutoLayout" : true,
                  "isPointer" : true,
                  "isSpecialName" : true,
                  "isVisible" : true,
                  "isSecurityCritical" : true,
                  "isNotPublic" : true,
                  "isNestedFamORAssem" : true,
                  "isMarshalByRef" : true,
                  "isGenericParameter" : true,
                  "isByRef" : true,
                  "genericTypeParameters" : [ null, null ],
                  "name" : "name",
                  "isSerializable" : true,
                  "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                  "isArray" : true,
                  "declaredNestedTypes" : [ null, null ],
                  "isPrimitive" : true,
                  "customAttributes" : [ null, null ],
                  "isCOMObject" : true,
                  "isGenericTypeParameter" : true,
                  "isGenericMethodParameter" : true,
                  "isSecurityTransparent" : true,
                  "declaredMethods" : [ null, null ],
                  "genericParameterAttributes" : 5,
                  "isAutoClass" : true,
                  "assemblyQualifiedName" : "assemblyQualifiedName",
                  "isValueType" : true,
                  "isGenericType" : true,
                  "isPublic" : true,
                  "containsGenericParameters" : true,
                  "isByRefLike" : true,
                  "isClass" : true,
                  "isImport" : true,
                  "typeHandle" : {
                    "value" : { }
                  },
                  "declaredProperties" : [ {
                    "metadataToken" : 5,
                    "canRead" : true,
                    "isCollectible" : true,
                    "canWrite" : true,
                    "isSpecialName" : true,
                    "name" : "name",
                    "attributes" : 9,
                    "customAttributes" : [ null, null ]
                  }, {
                    "metadataToken" : 5,
                    "canRead" : true,
                    "isCollectible" : true,
                    "canWrite" : true,
                    "isSpecialName" : true,
                    "name" : "name",
                    "attributes" : 9,
                    "customAttributes" : [ null, null ]
                  } ],
                  "isNested" : true,
                  "fullName" : "fullName",
                  "isEnum" : true,
                  "isAbstract" : true,
                  "isSignatureType" : true,
                  "declaredEvents" : [ {
                    "metadataToken" : 9,
                    "isCollectible" : true,
                    "isSpecialName" : true,
                    "name" : "name",
                    "attributes" : 3,
                    "isMulticast" : true,
                    "customAttributes" : [ null, null ],
                    "addMethod" : {
                      "isStatic" : true,
                      "methodHandle" : { },
                      "returnTypeCustomAttributes" : { },
                      "metadataToken" : 2,
                      "callingConvention" : 1,
                      "isAssembly" : true,
                      "returnParameter" : {
                        "hasDefaultValue" : true,
                        "metadataToken" : 7,
                        "defaultValue" : "",
                        "isOptional" : true,
                        "rawDefaultValue" : "",
                        "isRetval" : true,
                        "member" : {
                          "metadataToken" : 1,
                          "isCollectible" : true,
                          "name" : "name",
                          "customAttributes" : [ null, null ]
                        },
                        "name" : "name",
                        "isLcid" : true,
                        "isOut" : true,
                        "attributes" : 1,
                        "position" : 6,
                        "isIn" : true,
                        "customAttributes" : [ null, null ]
                      },
                      "isCollectible" : true,
                      "isHideBySig" : true,
                      "isSecurityTransparent" : true,
                      "isPrivate" : true,
                      "isSecuritySafeCritical" : true,
                      "methodImplementationFlags" : 7,
                      "isPublic" : true,
                      "isGenericMethod" : true,
                      "isFinal" : true,
                      "containsGenericParameters" : true,
                      "isGenericMethodDefinition" : true,
                      "isFamilyOrAssembly" : true,
                      "isSpecialName" : true,
                      "isFamily" : true,
                      "isSecurityCritical" : true,
                      "isAbstract" : true,
                      "isConstructedGenericMethod" : true,
                      "isConstructor" : true,
                      "isFamilyAndAssembly" : true,
                      "name" : "name",
                      "attributes" : 4,
                      "isVirtual" : true,
                      "customAttributes" : [ null, null ]
                    }
                  }, {
                    "metadataToken" : 9,
                    "isCollectible" : true,
                    "isSpecialName" : true,
                    "name" : "name",
                    "attributes" : 3,
                    "isMulticast" : true,
                    "customAttributes" : [ null, null ],
                    "addMethod" : {
                      "isStatic" : true,
                      "methodHandle" : { },
                      "returnTypeCustomAttributes" : { },
                      "metadataToken" : 2,
                      "callingConvention" : 1,
                      "isAssembly" : true,
                      "returnParameter" : {
                        "hasDefaultValue" : true,
                        "metadataToken" : 7,
                        "defaultValue" : "",
                        "isOptional" : true,
                        "rawDefaultValue" : "",
                        "isRetval" : true,
                        "member" : {
                          "metadataToken" : 1,
                          "isCollectible" : true,
                          "name" : "name",
                          "customAttributes" : [ null, null ]
                        },
                        "name" : "name",
                        "isLcid" : true,
                        "isOut" : true,
                        "attributes" : 1,
                        "position" : 6,
                        "isIn" : true,
                        "customAttributes" : [ null, null ]
                      },
                      "isCollectible" : true,
                      "isHideBySig" : true,
                      "isSecurityTransparent" : true,
                      "isPrivate" : true,
                      "isSecuritySafeCritical" : true,
                      "methodImplementationFlags" : 7,
                      "isPublic" : true,
                      "isGenericMethod" : true,
                      "isFinal" : true,
                      "containsGenericParameters" : true,
                      "isGenericMethodDefinition" : true,
                      "isFamilyOrAssembly" : true,
                      "isSpecialName" : true,
                      "isFamily" : true,
                      "isSecurityCritical" : true,
                      "isAbstract" : true,
                      "isConstructedGenericMethod" : true,
                      "isConstructor" : true,
                      "isFamilyAndAssembly" : true,
                      "name" : "name",
                      "attributes" : 4,
                      "isVirtual" : true,
                      "customAttributes" : [ null, null ]
                    }
                  } ],
                  "implementedInterfaces" : [ null, null ],
                  "isSZArray" : true,
                  "isNestedFamily" : true,
                  "structLayoutAttribute" : {
                    "typeId" : "",
                    "value" : 7
                  },
                  "namespace" : "namespace",
                  "genericTypeArguments" : [ null, null ],
                  "isConstructedGenericType" : true,
                  "attributes" : 2,
                  "hasElementType" : true
                }, {
                  "isSealed" : true,
                  "genericParameterPosition" : 5,
                  "isAnsiClass" : true,
                  "metadataToken" : 1,
                  "isContextful" : true,
                  "isLayoutSequential" : true,
                  "isCollectible" : true,
                  "isNestedFamANDAssem" : true,
                  "isExplicitLayout" : true,
                  "isTypeDefinition" : true,
                  "isSecuritySafeCritical" : true,
                  "declaredConstructors" : [ null, null ],
                  "isGenericTypeDefinition" : true,
                  "declaredFields" : [ {
                    "isStatic" : true,
                    "metadataToken" : 1,
                    "isAssembly" : true,
                    "isCollectible" : true,
                    "isSecurityTransparent" : true,
                    "isPrivate" : true,
                    "isNotSerialized" : true,
                    "isSecuritySafeCritical" : true,
                    "fieldHandle" : { },
                    "isInitOnly" : true,
                    "isPublic" : true,
                    "isFamilyOrAssembly" : true,
                    "isSpecialName" : true,
                    "isFamily" : true,
                    "isSecurityCritical" : true,
                    "isPinvokeImpl" : true,
                    "isLiteral" : true,
                    "isFamilyAndAssembly" : true,
                    "name" : "name",
                    "attributes" : 4,
                    "customAttributes" : [ null, null ]
                  }, {
                    "isStatic" : true,
                    "metadataToken" : 1,
                    "isAssembly" : true,
                    "isCollectible" : true,
                    "isSecurityTransparent" : true,
                    "isPrivate" : true,
                    "isNotSerialized" : true,
                    "isSecuritySafeCritical" : true,
                    "fieldHandle" : { },
                    "isInitOnly" : true,
                    "isPublic" : true,
                    "isFamilyOrAssembly" : true,
                    "isSpecialName" : true,
                    "isFamily" : true,
                    "isSecurityCritical" : true,
                    "isPinvokeImpl" : true,
                    "isLiteral" : true,
                    "isFamilyAndAssembly" : true,
                    "name" : "name",
                    "attributes" : 4,
                    "customAttributes" : [ null, null ]
                  } ],
                  "declaredMembers" : [ null, null ],
                  "isNestedPrivate" : true,
                  "isVariableBoundArray" : true,
                  "isInterface" : true,
                  "isNestedPublic" : true,
                  "isUnicodeClass" : true,
                  "isNestedAssembly" : true,
                  "isAutoLayout" : true,
                  "isPointer" : true,
                  "isSpecialName" : true,
                  "isVisible" : true,
                  "isSecurityCritical" : true,
                  "isNotPublic" : true,
                  "isNestedFamORAssem" : true,
                  "isMarshalByRef" : true,
                  "isGenericParameter" : true,
                  "isByRef" : true,
                  "genericTypeParameters" : [ null, null ],
                  "name" : "name",
                  "isSerializable" : true,
                  "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                  "isArray" : true,
                  "declaredNestedTypes" : [ null, null ],
                  "isPrimitive" : true,
                  "customAttributes" : [ null, null ],
                  "isCOMObject" : true,
                  "isGenericTypeParameter" : true,
                  "isGenericMethodParameter" : true,
                  "isSecurityTransparent" : true,
                  "declaredMethods" : [ null, null ],
                  "genericParameterAttributes" : 5,
                  "isAutoClass" : true,
                  "assemblyQualifiedName" : "assemblyQualifiedName",
                  "isValueType" : true,
                  "isGenericType" : true,
                  "isPublic" : true,
                  "containsGenericParameters" : true,
                  "isByRefLike" : true,
                  "isClass" : true,
                  "isImport" : true,
                  "typeHandle" : {
                    "value" : { }
                  },
                  "declaredProperties" : [ {
                    "metadataToken" : 5,
                    "canRead" : true,
                    "isCollectible" : true,
                    "canWrite" : true,
                    "isSpecialName" : true,
                    "name" : "name",
                    "attributes" : 9,
                    "customAttributes" : [ null, null ]
                  }, {
                    "metadataToken" : 5,
                    "canRead" : true,
                    "isCollectible" : true,
                    "canWrite" : true,
                    "isSpecialName" : true,
                    "name" : "name",
                    "attributes" : 9,
                    "customAttributes" : [ null, null ]
                  } ],
                  "isNested" : true,
                  "fullName" : "fullName",
                  "isEnum" : true,
                  "isAbstract" : true,
                  "isSignatureType" : true,
                  "declaredEvents" : [ {
                    "metadataToken" : 9,
                    "isCollectible" : true,
                    "isSpecialName" : true,
                    "name" : "name",
                    "attributes" : 3,
                    "isMulticast" : true,
                    "customAttributes" : [ null, null ],
                    "addMethod" : {
                      "isStatic" : true,
                      "methodHandle" : { },
                      "returnTypeCustomAttributes" : { },
                      "metadataToken" : 2,
                      "callingConvention" : 1,
                      "isAssembly" : true,
                      "returnParameter" : {
                        "hasDefaultValue" : true,
                        "metadataToken" : 7,
                        "defaultValue" : "",
                        "isOptional" : true,
                        "rawDefaultValue" : "",
                        "isRetval" : true,
                        "member" : {
                          "metadataToken" : 1,
                          "isCollectible" : true,
                          "name" : "name",
                          "customAttributes" : [ null, null ]
                        },
                        "name" : "name",
                        "isLcid" : true,
                        "isOut" : true,
                        "attributes" : 1,
                        "position" : 6,
                        "isIn" : true,
                        "customAttributes" : [ null, null ]
                      },
                      "isCollectible" : true,
                      "isHideBySig" : true,
                      "isSecurityTransparent" : true,
                      "isPrivate" : true,
                      "isSecuritySafeCritical" : true,
                      "methodImplementationFlags" : 7,
                      "isPublic" : true,
                      "isGenericMethod" : true,
                      "isFinal" : true,
                      "containsGenericParameters" : true,
                      "isGenericMethodDefinition" : true,
                      "isFamilyOrAssembly" : true,
                      "isSpecialName" : true,
                      "isFamily" : true,
                      "isSecurityCritical" : true,
                      "isAbstract" : true,
                      "isConstructedGenericMethod" : true,
                      "isConstructor" : true,
                      "isFamilyAndAssembly" : true,
                      "name" : "name",
                      "attributes" : 4,
                      "isVirtual" : true,
                      "customAttributes" : [ null, null ]
                    }
                  }, {
                    "metadataToken" : 9,
                    "isCollectible" : true,
                    "isSpecialName" : true,
                    "name" : "name",
                    "attributes" : 3,
                    "isMulticast" : true,
                    "customAttributes" : [ null, null ],
                    "addMethod" : {
                      "isStatic" : true,
                      "methodHandle" : { },
                      "returnTypeCustomAttributes" : { },
                      "metadataToken" : 2,
                      "callingConvention" : 1,
                      "isAssembly" : true,
                      "returnParameter" : {
                        "hasDefaultValue" : true,
                        "metadataToken" : 7,
                        "defaultValue" : "",
                        "isOptional" : true,
                        "rawDefaultValue" : "",
                        "isRetval" : true,
                        "member" : {
                          "metadataToken" : 1,
                          "isCollectible" : true,
                          "name" : "name",
                          "customAttributes" : [ null, null ]
                        },
                        "name" : "name",
                        "isLcid" : true,
                        "isOut" : true,
                        "attributes" : 1,
                        "position" : 6,
                        "isIn" : true,
                        "customAttributes" : [ null, null ]
                      },
                      "isCollectible" : true,
                      "isHideBySig" : true,
                      "isSecurityTransparent" : true,
                      "isPrivate" : true,
                      "isSecuritySafeCritical" : true,
                      "methodImplementationFlags" : 7,
                      "isPublic" : true,
                      "isGenericMethod" : true,
                      "isFinal" : true,
                      "containsGenericParameters" : true,
                      "isGenericMethodDefinition" : true,
                      "isFamilyOrAssembly" : true,
                      "isSpecialName" : true,
                      "isFamily" : true,
                      "isSecurityCritical" : true,
                      "isAbstract" : true,
                      "isConstructedGenericMethod" : true,
                      "isConstructor" : true,
                      "isFamilyAndAssembly" : true,
                      "name" : "name",
                      "attributes" : 4,
                      "isVirtual" : true,
                      "customAttributes" : [ null, null ]
                    }
                  } ],
                  "implementedInterfaces" : [ null, null ],
                  "isSZArray" : true,
                  "isNestedFamily" : true,
                  "structLayoutAttribute" : {
                    "typeId" : "",
                    "value" : 7
                  },
                  "namespace" : "namespace",
                  "genericTypeArguments" : [ null, null ],
                  "isConstructedGenericType" : true,
                  "attributes" : 2,
                  "hasElementType" : true
                } ],
                "exportedTypes" : [ null, null ],
                "isFullyTrusted" : true,
                "location" : "location",
                "globalAssemblyCache" : true,
                "imageRuntimeVersion" : "imageRuntimeVersion",
                "securityRuleSet" : 6,
                "customAttributes" : [ null, null ]
              },
              "name" : "name",
              "moduleVersionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
              "moduleHandle" : {
                "mdStreamVersion" : 9
              },
              "fullyQualifiedName" : "fullyQualifiedName",
              "customAttributes" : [ null, null ]
            },
            "isFamilyOrAssembly" : true,
            "isSpecialName" : true,
            "isFamily" : true,
            "isSecurityCritical" : true,
            "isAbstract" : true,
            "isConstructedGenericMethod" : true,
            "isConstructor" : true,
            "isFamilyAndAssembly" : true,
            "name" : "name",
            "isVirtual" : true,
            "customAttributes" : [ null, null ]
          },
          "constructorArguments" : [ {
            "value" : ""
          }, {
            "value" : ""
          } ]
        }, {
          "namedArguments" : [ {
            "isField" : true,
            "memberName" : "memberName"
          }, {
            "isField" : true,
            "memberName" : "memberName"
          } ],
          "constructor" : {
            "isStatic" : true,
            "metadataToken" : 3,
            "isAssembly" : true,
            "isCollectible" : true,
            "isHideBySig" : true,
            "isSecurityTransparent" : true,
            "isPrivate" : true,
            "isSecuritySafeCritical" : true,
            "isPublic" : true,
            "isGenericMethod" : true,
            "isFinal" : true,
            "containsGenericParameters" : true,
            "isGenericMethodDefinition" : true,
            "module" : {
              "metadataToken" : 6,
              "mdStreamVersion" : 8,
              "scopeName" : "scopeName",
              "assembly" : {
                "isDynamic" : true,
                "codeBase" : "codeBase",
                "isCollectible" : true,
                "escapedCodeBase" : "escapedCodeBase",
                "fullName" : "fullName",
                "reflectionOnly" : true,
                "modules" : [ null, null ],
                "hostContext" : 9,
                "definedTypes" : [ {
                  "isSealed" : true,
                  "genericParameterPosition" : 5,
                  "isAnsiClass" : true,
                  "metadataToken" : 1,
                  "isContextful" : true,
                  "isLayoutSequential" : true,
                  "isCollectible" : true,
                  "isNestedFamANDAssem" : true,
                  "isExplicitLayout" : true,
                  "isTypeDefinition" : true,
                  "isSecuritySafeCritical" : true,
                  "declaredConstructors" : [ null, null ],
                  "isGenericTypeDefinition" : true,
                  "declaredFields" : [ {
                    "isStatic" : true,
                    "metadataToken" : 1,
                    "isAssembly" : true,
                    "isCollectible" : true,
                    "isSecurityTransparent" : true,
                    "isPrivate" : true,
                    "isNotSerialized" : true,
                    "isSecuritySafeCritical" : true,
                    "fieldHandle" : { },
                    "isInitOnly" : true,
                    "isPublic" : true,
                    "isFamilyOrAssembly" : true,
                    "isSpecialName" : true,
                    "isFamily" : true,
                    "isSecurityCritical" : true,
                    "isPinvokeImpl" : true,
                    "isLiteral" : true,
                    "isFamilyAndAssembly" : true,
                    "name" : "name",
                    "attributes" : 4,
                    "customAttributes" : [ null, null ]
                  }, {
                    "isStatic" : true,
                    "metadataToken" : 1,
                    "isAssembly" : true,
                    "isCollectible" : true,
                    "isSecurityTransparent" : true,
                    "isPrivate" : true,
                    "isNotSerialized" : true,
                    "isSecuritySafeCritical" : true,
                    "fieldHandle" : { },
                    "isInitOnly" : true,
                    "isPublic" : true,
                    "isFamilyOrAssembly" : true,
                    "isSpecialName" : true,
                    "isFamily" : true,
                    "isSecurityCritical" : true,
                    "isPinvokeImpl" : true,
                    "isLiteral" : true,
                    "isFamilyAndAssembly" : true,
                    "name" : "name",
                    "attributes" : 4,
                    "customAttributes" : [ null, null ]
                  } ],
                  "declaredMembers" : [ null, null ],
                  "isNestedPrivate" : true,
                  "isVariableBoundArray" : true,
                  "isInterface" : true,
                  "isNestedPublic" : true,
                  "isUnicodeClass" : true,
                  "isNestedAssembly" : true,
                  "isAutoLayout" : true,
                  "isPointer" : true,
                  "isSpecialName" : true,
                  "isVisible" : true,
                  "isSecurityCritical" : true,
                  "isNotPublic" : true,
                  "isNestedFamORAssem" : true,
                  "isMarshalByRef" : true,
                  "isGenericParameter" : true,
                  "isByRef" : true,
                  "genericTypeParameters" : [ null, null ],
                  "name" : "name",
                  "isSerializable" : true,
                  "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                  "isArray" : true,
                  "declaredNestedTypes" : [ null, null ],
                  "isPrimitive" : true,
                  "customAttributes" : [ null, null ],
                  "isCOMObject" : true,
                  "isGenericTypeParameter" : true,
                  "isGenericMethodParameter" : true,
                  "isSecurityTransparent" : true,
                  "declaredMethods" : [ null, null ],
                  "genericParameterAttributes" : 5,
                  "isAutoClass" : true,
                  "assemblyQualifiedName" : "assemblyQualifiedName",
                  "isValueType" : true,
                  "isGenericType" : true,
                  "isPublic" : true,
                  "containsGenericParameters" : true,
                  "isByRefLike" : true,
                  "isClass" : true,
                  "isImport" : true,
                  "typeHandle" : {
                    "value" : { }
                  },
                  "declaredProperties" : [ {
                    "metadataToken" : 5,
                    "canRead" : true,
                    "isCollectible" : true,
                    "canWrite" : true,
                    "isSpecialName" : true,
                    "name" : "name",
                    "attributes" : 9,
                    "customAttributes" : [ null, null ]
                  }, {
                    "metadataToken" : 5,
                    "canRead" : true,
                    "isCollectible" : true,
                    "canWrite" : true,
                    "isSpecialName" : true,
                    "name" : "name",
                    "attributes" : 9,
                    "customAttributes" : [ null, null ]
                  } ],
                  "isNested" : true,
                  "fullName" : "fullName",
                  "isEnum" : true,
                  "isAbstract" : true,
                  "isSignatureType" : true,
                  "declaredEvents" : [ {
                    "metadataToken" : 9,
                    "isCollectible" : true,
                    "isSpecialName" : true,
                    "name" : "name",
                    "attributes" : 3,
                    "isMulticast" : true,
                    "customAttributes" : [ null, null ],
                    "addMethod" : {
                      "isStatic" : true,
                      "methodHandle" : { },
                      "returnTypeCustomAttributes" : { },
                      "metadataToken" : 2,
                      "callingConvention" : 1,
                      "isAssembly" : true,
                      "returnParameter" : {
                        "hasDefaultValue" : true,
                        "metadataToken" : 7,
                        "defaultValue" : "",
                        "isOptional" : true,
                        "rawDefaultValue" : "",
                        "isRetval" : true,
                        "member" : {
                          "metadataToken" : 1,
                          "isCollectible" : true,
                          "name" : "name",
                          "customAttributes" : [ null, null ]
                        },
                        "name" : "name",
                        "isLcid" : true,
                        "isOut" : true,
                        "attributes" : 1,
                        "position" : 6,
                        "isIn" : true,
                        "customAttributes" : [ null, null ]
                      },
                      "isCollectible" : true,
                      "isHideBySig" : true,
                      "isSecurityTransparent" : true,
                      "isPrivate" : true,
                      "isSecuritySafeCritical" : true,
                      "methodImplementationFlags" : 7,
                      "isPublic" : true,
                      "isGenericMethod" : true,
                      "isFinal" : true,
                      "containsGenericParameters" : true,
                      "isGenericMethodDefinition" : true,
                      "isFamilyOrAssembly" : true,
                      "isSpecialName" : true,
                      "isFamily" : true,
                      "isSecurityCritical" : true,
                      "isAbstract" : true,
                      "isConstructedGenericMethod" : true,
                      "isConstructor" : true,
                      "isFamilyAndAssembly" : true,
                      "name" : "name",
                      "attributes" : 4,
                      "isVirtual" : true,
                      "customAttributes" : [ null, null ]
                    }
                  }, {
                    "metadataToken" : 9,
                    "isCollectible" : true,
                    "isSpecialName" : true,
                    "name" : "name",
                    "attributes" : 3,
                    "isMulticast" : true,
                    "customAttributes" : [ null, null ],
                    "addMethod" : {
                      "isStatic" : true,
                      "methodHandle" : { },
                      "returnTypeCustomAttributes" : { },
                      "metadataToken" : 2,
                      "callingConvention" : 1,
                      "isAssembly" : true,
                      "returnParameter" : {
                        "hasDefaultValue" : true,
                        "metadataToken" : 7,
                        "defaultValue" : "",
                        "isOptional" : true,
                        "rawDefaultValue" : "",
                        "isRetval" : true,
                        "member" : {
                          "metadataToken" : 1,
                          "isCollectible" : true,
                          "name" : "name",
                          "customAttributes" : [ null, null ]
                        },
                        "name" : "name",
                        "isLcid" : true,
                        "isOut" : true,
                        "attributes" : 1,
                        "position" : 6,
                        "isIn" : true,
                        "customAttributes" : [ null, null ]
                      },
                      "isCollectible" : true,
                      "isHideBySig" : true,
                      "isSecurityTransparent" : true,
                      "isPrivate" : true,
                      "isSecuritySafeCritical" : true,
                      "methodImplementationFlags" : 7,
                      "isPublic" : true,
                      "isGenericMethod" : true,
                      "isFinal" : true,
                      "containsGenericParameters" : true,
                      "isGenericMethodDefinition" : true,
                      "isFamilyOrAssembly" : true,
                      "isSpecialName" : true,
                      "isFamily" : true,
                      "isSecurityCritical" : true,
                      "isAbstract" : true,
                      "isConstructedGenericMethod" : true,
                      "isConstructor" : true,
                      "isFamilyAndAssembly" : true,
                      "name" : "name",
                      "attributes" : 4,
                      "isVirtual" : true,
                      "customAttributes" : [ null, null ]
                    }
                  } ],
                  "implementedInterfaces" : [ null, null ],
                  "isSZArray" : true,
                  "isNestedFamily" : true,
                  "structLayoutAttribute" : {
                    "typeId" : "",
                    "value" : 7
                  },
                  "namespace" : "namespace",
                  "genericTypeArguments" : [ null, null ],
                  "isConstructedGenericType" : true,
                  "attributes" : 2,
                  "hasElementType" : true
                }, {
                  "isSealed" : true,
                  "genericParameterPosition" : 5,
                  "isAnsiClass" : true,
                  "metadataToken" : 1,
                  "isContextful" : true,
                  "isLayoutSequential" : true,
                  "isCollectible" : true,
                  "isNestedFamANDAssem" : true,
                  "isExplicitLayout" : true,
                  "isTypeDefinition" : true,
                  "isSecuritySafeCritical" : true,
                  "declaredConstructors" : [ null, null ],
                  "isGenericTypeDefinition" : true,
                  "declaredFields" : [ {
                    "isStatic" : true,
                    "metadataToken" : 1,
                    "isAssembly" : true,
                    "isCollectible" : true,
                    "isSecurityTransparent" : true,
                    "isPrivate" : true,
                    "isNotSerialized" : true,
                    "isSecuritySafeCritical" : true,
                    "fieldHandle" : { },
                    "isInitOnly" : true,
                    "isPublic" : true,
                    "isFamilyOrAssembly" : true,
                    "isSpecialName" : true,
                    "isFamily" : true,
                    "isSecurityCritical" : true,
                    "isPinvokeImpl" : true,
                    "isLiteral" : true,
                    "isFamilyAndAssembly" : true,
                    "name" : "name",
                    "attributes" : 4,
                    "customAttributes" : [ null, null ]
                  }, {
                    "isStatic" : true,
                    "metadataToken" : 1,
                    "isAssembly" : true,
                    "isCollectible" : true,
                    "isSecurityTransparent" : true,
                    "isPrivate" : true,
                    "isNotSerialized" : true,
                    "isSecuritySafeCritical" : true,
                    "fieldHandle" : { },
                    "isInitOnly" : true,
                    "isPublic" : true,
                    "isFamilyOrAssembly" : true,
                    "isSpecialName" : true,
                    "isFamily" : true,
                    "isSecurityCritical" : true,
                    "isPinvokeImpl" : true,
                    "isLiteral" : true,
                    "isFamilyAndAssembly" : true,
                    "name" : "name",
                    "attributes" : 4,
                    "customAttributes" : [ null, null ]
                  } ],
                  "declaredMembers" : [ null, null ],
                  "isNestedPrivate" : true,
                  "isVariableBoundArray" : true,
                  "isInterface" : true,
                  "isNestedPublic" : true,
                  "isUnicodeClass" : true,
                  "isNestedAssembly" : true,
                  "isAutoLayout" : true,
                  "isPointer" : true,
                  "isSpecialName" : true,
                  "isVisible" : true,
                  "isSecurityCritical" : true,
                  "isNotPublic" : true,
                  "isNestedFamORAssem" : true,
                  "isMarshalByRef" : true,
                  "isGenericParameter" : true,
                  "isByRef" : true,
                  "genericTypeParameters" : [ null, null ],
                  "name" : "name",
                  "isSerializable" : true,
                  "guid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                  "isArray" : true,
                  "declaredNestedTypes" : [ null, null ],
                  "isPrimitive" : true,
                  "customAttributes" : [ null, null ],
                  "isCOMObject" : true,
                  "isGenericTypeParameter" : true,
                  "isGenericMethodParameter" : true,
                  "isSecurityTransparent" : true,
                  "declaredMethods" : [ null, null ],
                  "genericParameterAttributes" : 5,
                  "isAutoClass" : true,
                  "assemblyQualifiedName" : "assemblyQualifiedName",
                  "isValueType" : true,
                  "isGenericType" : true,
                  "isPublic" : true,
                  "containsGenericParameters" : true,
                  "isByRefLike" : true,
                  "isClass" : true,
                  "isImport" : true,
                  "typeHandle" : {
                    "value" : { }
                  },
                  "declaredProperties" : [ {
                    "metadataToken" : 5,
                    "canRead" : true,
                    "isCollectible" : true,
                    "canWrite" : true,
                    "isSpecialName" : true,
                    "name" : "name",
                    "attributes" : 9,
                    "customAttributes" : [ null, null ]
                  }, {
                    "metadataToken" : 5,
                    "canRead" : true,
                    "isCollectible" : true,
                    "canWrite" : true,
                    "isSpecialName" : true,
                    "name" : "name",
                    "attributes" : 9,
                    "customAttributes" : [ null, null ]
                  } ],
                  "isNested" : true,
                  "fullName" : "fullName",
                  "isEnum" : true,
                  "isAbstract" : true,
                  "isSignatureType" : true,
                  "declaredEvents" : [ {
                    "metadataToken" : 9,
                    "isCollectible" : true,
                    "isSpecialName" : true,
                    "name" : "name",
                    "attributes" : 3,
                    "isMulticast" : true,
                    "customAttributes" : [ null, null ],
                    "addMethod" : {
                      "isStatic" : true,
                      "methodHandle" : { },
                      "returnTypeCustomAttributes" : { },
                      "metadataToken" : 2,
                      "callingConvention" : 1,
                      "isAssembly" : true,
                      "returnParameter" : {
                        "hasDefaultValue" : true,
                        "metadataToken" : 7,
                        "defaultValue" : "",
                        "isOptional" : true,
                        "rawDefaultValue" : "",
                        "isRetval" : true,
                        "member" : {
                          "metadataToken" : 1,
                          "isCollectible" : true,
                          "name" : "name",
                          "customAttributes" : [ null, null ]
                        },
                        "name" : "name",
                        "isLcid" : true,
                        "isOut" : true,
                        "attributes" : 1,
                        "position" : 6,
                        "isIn" : true,
                        "customAttributes" : [ null, null ]
                      },
                      "isCollectible" : true,
                      "isHideBySig" : true,
                      "isSecurityTransparent" : true,
                      "isPrivate" : true,
                      "isSecuritySafeCritical" : true,
                      "methodImplementationFlags" : 7,
                      "isPublic" : true,
                      "isGenericMethod" : true,
                      "isFinal" : true,
                      "containsGenericParameters" : true,
                      "isGenericMethodDefinition" : true,
                      "isFamilyOrAssembly" : true,
                      "isSpecialName" : true,
                      "isFamily" : true,
                      "isSecurityCritical" : true,
                      "isAbstract" : true,
                      "isConstructedGenericMethod" : true,
                      "isConstructor" : true,
                      "isFamilyAndAssembly" : true,
                      "name" : "name",
                      "attributes" : 4,
                      "isVirtual" : true,
                      "customAttributes" : [ null, null ]
                    }
                  }, {
                    "metadataToken" : 9,
                    "isCollectible" : true,
                    "isSpecialName" : true,
                    "name" : "name",
                    "attributes" : 3,
                    "isMulticast" : true,
                    "customAttributes" : [ null, null ],
                    "addMethod" : {
                      "isStatic" : true,
                      "methodHandle" : { },
                      "returnTypeCustomAttributes" : { },
                      "metadataToken" : 2,
                      "callingConvention" : 1,
                      "isAssembly" : true,
                      "returnParameter" : {
                        "hasDefaultValue" : true,
                        "metadataToken" : 7,
                        "defaultValue" : "",
                        "isOptional" : true,
                        "rawDefaultValue" : "",
                        "isRetval" : true,
                        "member" : {
                          "metadataToken" : 1,
                          "isCollectible" : true,
                          "name" : "name",
                          "customAttributes" : [ null, null ]
                        },
                        "name" : "name",
                        "isLcid" : true,
                        "isOut" : true,
                        "attributes" : 1,
                        "position" : 6,
                        "isIn" : true,
                        "customAttributes" : [ null, null ]
                      },
                      "isCollectible" : true,
                      "isHideBySig" : true,
                      "isSecurityTransparent" : true,
                      "isPrivate" : true,
                      "isSecuritySafeCritical" : true,
                      "methodImplementationFlags" : 7,
                      "isPublic" : true,
                      "isGenericMethod" : true,
                      "isFinal" : true,
                      "containsGenericParameters" : true,
                      "isGenericMethodDefinition" : true,
                      "isFamilyOrAssembly" : true,
                      "isSpecialName" : true,
                      "isFamily" : true,
                      "isSecurityCritical" : true,
                      "isAbstract" : true,
                      "isConstructedGenericMethod" : true,
                      "isConstructor" : true,
                      "isFamilyAndAssembly" : true,
                      "name" : "name",
                      "attributes" : 4,
                      "isVirtual" : true,
                      "customAttributes" : [ null, null ]
                    }
                  } ],
                  "implementedInterfaces" : [ null, null ],
                  "isSZArray" : true,
                  "isNestedFamily" : true,
                  "structLayoutAttribute" : {
                    "typeId" : "",
                    "value" : 7
                  },
                  "namespace" : "namespace",
                  "genericTypeArguments" : [ null, null ],
                  "isConstructedGenericType" : true,
                  "attributes" : 2,
                  "hasElementType" : true
                } ],
                "exportedTypes" : [ null, null ],
                "isFullyTrusted" : true,
                "location" : "location",
                "globalAssemblyCache" : true,
                "imageRuntimeVersion" : "imageRuntimeVersion",
                "securityRuleSet" : 6,
                "customAttributes" : [ null, null ]
              },
              "name" : "name",
              "moduleVersionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
              "moduleHandle" : {
                "mdStreamVersion" : 9
              },
              "fullyQualifiedName" : "fullyQualifiedName",
              "customAttributes" : [ null, null ]
            },
            "isFamilyOrAssembly" : true,
            "isSpecialName" : true,
            "isFamily" : true,
            "isSecurityCritical" : true,
            "isAbstract" : true,
            "isConstructedGenericMethod" : true,
            "isConstructor" : true,
            "isFamilyAndAssembly" : true,
            "name" : "name",
            "isVirtual" : true,
            "customAttributes" : [ null, null ]
          },
          "constructorArguments" : [ {
            "value" : ""
          }, {
            "value" : ""
          } ]
        } ],
        "isCOMObject" : true,
        "isGenericTypeParameter" : true,
        "isGenericMethodParameter" : true,
        "isSecurityTransparent" : true,
        "isAutoClass" : true,
        "assemblyQualifiedName" : "assemblyQualifiedName",
        "isValueType" : true,
        "isGenericType" : true,
        "isPublic" : true,
        "containsGenericParameters" : true,
        "isByRefLike" : true,
        "isClass" : true,
        "isImport" : true,
        "isNested" : true,
        "fullName" : "fullName",
        "isEnum" : true,
        "isAbstract" : true,
        "isSignatureType" : true,
        "isSZArray" : true,
        "isNestedFamily" : true,
        "namespace" : "namespace",
        "genericTypeArguments" : [ null, null ],
        "isConstructedGenericType" : true,
        "hasElementType" : true
      },
      "isGenericMethodDefinition" : true,
      "isFamilyOrAssembly" : true,
      "isSpecialName" : true,
      "isFamily" : true,
      "isSecurityCritical" : true,
      "isAbstract" : true,
      "isConstructedGenericMethod" : true,
      "isConstructor" : true,
      "isFamilyAndAssembly" : true,
      "name" : "name",
      "memberType" : 6,
      "isVirtual" : true,
      "customAttributes" : [ null, null ]
    },
    "stackTrace" : "stackTrace",
    "source" : "source",
    "message" : "message",
    "hResult" : 6
  },
  "item" : true,
  "auditDetails" : "auditDetails",
  "isException" : true,
  "count" : 6,
  "message" : "message",
  "items" : [ true, true ],
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success BooleanCygTResultBase

RemoteLoggerConfiguration

Up
delete /api/v{version}/system/config/remotelogger
(apiVversionSystemConfigRemoteloggerDelete)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/system/config/remotelogger
(apiVversionSystemConfigRemoteloggerGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "configInfo" : { },
  "type" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success RemoteLoggerConfigurationX

Up
post /api/v{version}/system/config/remotelogger
(apiVversionSystemConfigRemoteloggerPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "configInfo" : { },
  "type" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success RemoteLoggerConfigurationX

Up
put /api/v{version}/system/config/remotelogger
(apiVversionSystemConfigRemoteloggerPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

Body Parameter

Return type

Example data

Content-Type: application/json
{
  "configInfo" : { },
  "type" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success RemoteLoggerConfigurationX

Report

Up
get /api/v{version}/reports/EventColumnsAlpha
(apiVversionReportsEventColumnsAlphaGet)

Path parameters

version (required)
Path Parameter

Query parameters

sources (optional)
Query Parameter — format: int32

Return type

map[String, array[AuditEventColumn]]

Example data

Content-Type: application/json
{
  "key" : [ {
    "isIntersecting" : true,
    "hover" : {
      "addAction" : 5,
      "removeAction" : 2,
      "field" : "field",
      "position" : "position"
    },
    "visible" : true,
    "sources" : [ 0, 0 ],
    "isMetaEventColumn" : true,
    "name" : "name",
    "width" : {
      "default" : 1,
      "value" : 6,
      "minimum" : 5
    },
    "header" : "header",
    "position" : "position",
    "type" : "type"
  }, {
    "isIntersecting" : true,
    "hover" : {
      "addAction" : 5,
      "removeAction" : 2,
      "field" : "field",
      "position" : "position"
    },
    "visible" : true,
    "sources" : [ 0, 0 ],
    "isMetaEventColumn" : true,
    "name" : "name",
    "width" : {
      "default" : 1,
      "value" : 6,
      "minimum" : 5
    },
    "header" : "header",
    "position" : "position",
    "type" : "type"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
get /api/v{version}/reports/EventColumns
(apiVversionReportsEventColumnsGet)

Path parameters

version (required)
Path Parameter

Query parameters

sources (optional)
Query Parameter — format: int32

Return type

map[String, array[AuditEventColumn]]

Example data

Content-Type: application/json
{
  "key" : [ {
    "isIntersecting" : true,
    "hover" : {
      "addAction" : 5,
      "removeAction" : 2,
      "field" : "field",
      "position" : "position"
    },
    "visible" : true,
    "sources" : [ 0, 0 ],
    "isMetaEventColumn" : true,
    "name" : "name",
    "width" : {
      "default" : 1,
      "value" : 6,
      "minimum" : 5
    },
    "header" : "header",
    "position" : "position",
    "type" : "type"
  }, {
    "isIntersecting" : true,
    "hover" : {
      "addAction" : 5,
      "removeAction" : 2,
      "field" : "field",
      "position" : "position"
    },
    "visible" : true,
    "sources" : [ 0, 0 ],
    "isMetaEventColumn" : true,
    "name" : "name",
    "width" : {
      "default" : 1,
      "value" : 6,
      "minimum" : 5
    },
    "header" : "header",
    "position" : "position",
    "type" : "type"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
post /api/v{version}/reports/export
(apiVversionReportsExportPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ReportRunnerJobInfo (optional)
Body Parameter

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success byte[]

Up
get /api/v{version}/reports
(apiVversionReportsGet)

Path parameters

version (required)
Path Parameter

Query parameters

tags (optional)
Query Parameter
tagIds (optional)
Query Parameter — format: uuid

Return type

array[ReportWeb]

Example data

Content-Type: application/json
[ {
  "filter" : [ {
    "childClauses" : [ null, null ],
    "fieldName" : "fieldName",
    "comparison" : 6,
    "values" : [ {
      "value2" : "value2",
      "value" : "value"
    }, {
      "value2" : "value2",
      "value" : "value"
    } ],
    "type" : 0
  }, {
    "childClauses" : [ null, null ],
    "fieldName" : "fieldName",
    "comparison" : 6,
    "values" : [ {
      "value2" : "value2",
      "value" : "value"
    }, {
      "value2" : "value2",
      "value" : "value"
    } ],
    "type" : 0
  } ],
  "access" : {
    "createdByUserId" : "createdByUserId",
    "createdByUserName" : "createdByUserName",
    "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
    "reportId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "modifiedByUserName" : "modifiedByUserName",
    "id" : 5,
    "isPrivate" : true,
    "createdOn" : "2000-01-23T04:56:07.000+00:00",
    "modifiedByUserId" : "modifiedByUserId",
    "createdByUserType" : 5
  },
  "delegatedResources" : [ {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  }, {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  } ],
  "isReadOnly" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : "type",
  "actions" : [ {
    "configuration" : "configuration",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "isEnabled" : true,
    "type" : "type"
  }, {
    "configuration" : "configuration",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "isEnabled" : true,
    "type" : "type"
  } ],
  "eventColumns" : [ {
    "isIntersecting" : true,
    "hover" : {
      "addAction" : 5,
      "removeAction" : 2,
      "field" : "field",
      "position" : "position"
    },
    "visible" : true,
    "sources" : [ 0, 0 ],
    "isMetaEventColumn" : true,
    "name" : "name",
    "width" : {
      "default" : 1,
      "value" : 6,
      "minimum" : 5
    },
    "header" : "header",
    "position" : "position",
    "type" : "type"
  }, {
    "isIntersecting" : true,
    "hover" : {
      "addAction" : 5,
      "removeAction" : 2,
      "field" : "field",
      "position" : "position"
    },
    "visible" : true,
    "sources" : [ 0, 0 ],
    "isMetaEventColumn" : true,
    "name" : "name",
    "width" : {
      "default" : 1,
      "value" : 6,
      "minimum" : 5
    },
    "header" : "header",
    "position" : "position",
    "type" : "type"
  } ],
  "tags" : [ {
    "origin" : 1,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "origin" : 1,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}, {
  "filter" : [ {
    "childClauses" : [ null, null ],
    "fieldName" : "fieldName",
    "comparison" : 6,
    "values" : [ {
      "value2" : "value2",
      "value" : "value"
    }, {
      "value2" : "value2",
      "value" : "value"
    } ],
    "type" : 0
  }, {
    "childClauses" : [ null, null ],
    "fieldName" : "fieldName",
    "comparison" : 6,
    "values" : [ {
      "value2" : "value2",
      "value" : "value"
    }, {
      "value2" : "value2",
      "value" : "value"
    } ],
    "type" : 0
  } ],
  "access" : {
    "createdByUserId" : "createdByUserId",
    "createdByUserName" : "createdByUserName",
    "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
    "reportId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "modifiedByUserName" : "modifiedByUserName",
    "id" : 5,
    "isPrivate" : true,
    "createdOn" : "2000-01-23T04:56:07.000+00:00",
    "modifiedByUserId" : "modifiedByUserId",
    "createdByUserType" : 5
  },
  "delegatedResources" : [ {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  }, {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  } ],
  "isReadOnly" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : "type",
  "actions" : [ {
    "configuration" : "configuration",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "isEnabled" : true,
    "type" : "type"
  }, {
    "configuration" : "configuration",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "isEnabled" : true,
    "type" : "type"
  } ],
  "eventColumns" : [ {
    "isIntersecting" : true,
    "hover" : {
      "addAction" : 5,
      "removeAction" : 2,
      "field" : "field",
      "position" : "position"
    },
    "visible" : true,
    "sources" : [ 0, 0 ],
    "isMetaEventColumn" : true,
    "name" : "name",
    "width" : {
      "default" : 1,
      "value" : 6,
      "minimum" : 5
    },
    "header" : "header",
    "position" : "position",
    "type" : "type"
  }, {
    "isIntersecting" : true,
    "hover" : {
      "addAction" : 5,
      "removeAction" : 2,
      "field" : "field",
      "position" : "position"
    },
    "visible" : true,
    "sources" : [ 0, 0 ],
    "isMetaEventColumn" : true,
    "name" : "name",
    "width" : {
      "default" : 1,
      "value" : 6,
      "minimum" : 5
    },
    "header" : "header",
    "position" : "position",
    "type" : "type"
  } ],
  "tags" : [ {
    "origin" : 1,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "origin" : 1,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
delete /api/v{version}/reports/{id}
(apiVversionReportsIdDelete)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/reports/{id}
(apiVversionReportsIdGet)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "filter" : [ {
    "childClauses" : [ null, null ],
    "fieldName" : "fieldName",
    "comparison" : 6,
    "values" : [ {
      "value2" : "value2",
      "value" : "value"
    }, {
      "value2" : "value2",
      "value" : "value"
    } ],
    "type" : 0
  }, {
    "childClauses" : [ null, null ],
    "fieldName" : "fieldName",
    "comparison" : 6,
    "values" : [ {
      "value2" : "value2",
      "value" : "value"
    }, {
      "value2" : "value2",
      "value" : "value"
    } ],
    "type" : 0
  } ],
  "access" : {
    "createdByUserId" : "createdByUserId",
    "createdByUserName" : "createdByUserName",
    "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
    "reportId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "modifiedByUserName" : "modifiedByUserName",
    "id" : 5,
    "isPrivate" : true,
    "createdOn" : "2000-01-23T04:56:07.000+00:00",
    "modifiedByUserId" : "modifiedByUserId",
    "createdByUserType" : 5
  },
  "delegatedResources" : [ {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  }, {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  } ],
  "isReadOnly" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : "type",
  "actions" : [ {
    "configuration" : "configuration",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "isEnabled" : true,
    "type" : "type"
  }, {
    "configuration" : "configuration",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "isEnabled" : true,
    "type" : "type"
  } ],
  "eventColumns" : [ {
    "isIntersecting" : true,
    "hover" : {
      "addAction" : 5,
      "removeAction" : 2,
      "field" : "field",
      "position" : "position"
    },
    "visible" : true,
    "sources" : [ 0, 0 ],
    "isMetaEventColumn" : true,
    "name" : "name",
    "width" : {
      "default" : 1,
      "value" : 6,
      "minimum" : 5
    },
    "header" : "header",
    "position" : "position",
    "type" : "type"
  }, {
    "isIntersecting" : true,
    "hover" : {
      "addAction" : 5,
      "removeAction" : 2,
      "field" : "field",
      "position" : "position"
    },
    "visible" : true,
    "sources" : [ 0, 0 ],
    "isMetaEventColumn" : true,
    "name" : "name",
    "width" : {
      "default" : 1,
      "value" : 6,
      "minimum" : 5
    },
    "header" : "header",
    "position" : "position",
    "type" : "type"
  } ],
  "tags" : [ {
    "origin" : 1,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "origin" : 1,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ReportWeb

Up
put /api/v{version}/reports/{id}
(apiVversionReportsIdPut)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ReportWeb (optional)
Body Parameter

Query parameters

isPrivate (optional)
Query Parameter — default: false
isOwnerToBeReset (optional)
Query Parameter — default: false

Return type

Example data

Content-Type: application/json
{
  "filter" : [ {
    "childClauses" : [ null, null ],
    "fieldName" : "fieldName",
    "comparison" : 6,
    "values" : [ {
      "value2" : "value2",
      "value" : "value"
    }, {
      "value2" : "value2",
      "value" : "value"
    } ],
    "type" : 0
  }, {
    "childClauses" : [ null, null ],
    "fieldName" : "fieldName",
    "comparison" : 6,
    "values" : [ {
      "value2" : "value2",
      "value" : "value"
    }, {
      "value2" : "value2",
      "value" : "value"
    } ],
    "type" : 0
  } ],
  "access" : {
    "createdByUserId" : "createdByUserId",
    "createdByUserName" : "createdByUserName",
    "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
    "reportId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "modifiedByUserName" : "modifiedByUserName",
    "id" : 5,
    "isPrivate" : true,
    "createdOn" : "2000-01-23T04:56:07.000+00:00",
    "modifiedByUserId" : "modifiedByUserId",
    "createdByUserType" : 5
  },
  "delegatedResources" : [ {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  }, {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  } ],
  "isReadOnly" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : "type",
  "actions" : [ {
    "configuration" : "configuration",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "isEnabled" : true,
    "type" : "type"
  }, {
    "configuration" : "configuration",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "isEnabled" : true,
    "type" : "type"
  } ],
  "eventColumns" : [ {
    "isIntersecting" : true,
    "hover" : {
      "addAction" : 5,
      "removeAction" : 2,
      "field" : "field",
      "position" : "position"
    },
    "visible" : true,
    "sources" : [ 0, 0 ],
    "isMetaEventColumn" : true,
    "name" : "name",
    "width" : {
      "default" : 1,
      "value" : 6,
      "minimum" : 5
    },
    "header" : "header",
    "position" : "position",
    "type" : "type"
  }, {
    "isIntersecting" : true,
    "hover" : {
      "addAction" : 5,
      "removeAction" : 2,
      "field" : "field",
      "position" : "position"
    },
    "visible" : true,
    "sources" : [ 0, 0 ],
    "isMetaEventColumn" : true,
    "name" : "name",
    "width" : {
      "default" : 1,
      "value" : 6,
      "minimum" : 5
    },
    "header" : "header",
    "position" : "position",
    "type" : "type"
  } ],
  "tags" : [ {
    "origin" : 1,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "origin" : 1,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ReportWeb

Up
post /api/v{version}/reports/{id}/tags
(apiVversionReportsIdTagsPost)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body Tag (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "filter" : [ {
    "childClauses" : [ null, null ],
    "fieldName" : "fieldName",
    "comparison" : 6,
    "values" : [ {
      "value2" : "value2",
      "value" : "value"
    }, {
      "value2" : "value2",
      "value" : "value"
    } ],
    "type" : 0
  }, {
    "childClauses" : [ null, null ],
    "fieldName" : "fieldName",
    "comparison" : 6,
    "values" : [ {
      "value2" : "value2",
      "value" : "value"
    }, {
      "value2" : "value2",
      "value" : "value"
    } ],
    "type" : 0
  } ],
  "access" : {
    "createdByUserId" : "createdByUserId",
    "createdByUserName" : "createdByUserName",
    "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
    "reportId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "modifiedByUserName" : "modifiedByUserName",
    "id" : 5,
    "isPrivate" : true,
    "createdOn" : "2000-01-23T04:56:07.000+00:00",
    "modifiedByUserId" : "modifiedByUserId",
    "createdByUserType" : 5
  },
  "delegatedResources" : [ {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  }, {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  } ],
  "isReadOnly" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : "type",
  "actions" : [ {
    "configuration" : "configuration",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "isEnabled" : true,
    "type" : "type"
  }, {
    "configuration" : "configuration",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "isEnabled" : true,
    "type" : "type"
  } ],
  "eventColumns" : [ {
    "isIntersecting" : true,
    "hover" : {
      "addAction" : 5,
      "removeAction" : 2,
      "field" : "field",
      "position" : "position"
    },
    "visible" : true,
    "sources" : [ 0, 0 ],
    "isMetaEventColumn" : true,
    "name" : "name",
    "width" : {
      "default" : 1,
      "value" : 6,
      "minimum" : 5
    },
    "header" : "header",
    "position" : "position",
    "type" : "type"
  }, {
    "isIntersecting" : true,
    "hover" : {
      "addAction" : 5,
      "removeAction" : 2,
      "field" : "field",
      "position" : "position"
    },
    "visible" : true,
    "sources" : [ 0, 0 ],
    "isMetaEventColumn" : true,
    "name" : "name",
    "width" : {
      "default" : 1,
      "value" : 6,
      "minimum" : 5
    },
    "header" : "header",
    "position" : "position",
    "type" : "type"
  } ],
  "tags" : [ {
    "origin" : 1,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "origin" : 1,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ReportWeb

Up
post /api/v{version}/reports
(apiVversionReportsPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ReportWeb (optional)
Body Parameter

Query parameters

isPrivate (optional)
Query Parameter — default: false

Return type

Example data

Content-Type: application/json
{
  "filter" : [ {
    "childClauses" : [ null, null ],
    "fieldName" : "fieldName",
    "comparison" : 6,
    "values" : [ {
      "value2" : "value2",
      "value" : "value"
    }, {
      "value2" : "value2",
      "value" : "value"
    } ],
    "type" : 0
  }, {
    "childClauses" : [ null, null ],
    "fieldName" : "fieldName",
    "comparison" : 6,
    "values" : [ {
      "value2" : "value2",
      "value" : "value"
    }, {
      "value2" : "value2",
      "value" : "value"
    } ],
    "type" : 0
  } ],
  "access" : {
    "createdByUserId" : "createdByUserId",
    "createdByUserName" : "createdByUserName",
    "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
    "reportId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "modifiedByUserName" : "modifiedByUserName",
    "id" : 5,
    "isPrivate" : true,
    "createdOn" : "2000-01-23T04:56:07.000+00:00",
    "modifiedByUserId" : "modifiedByUserId",
    "createdByUserType" : 5
  },
  "delegatedResources" : [ {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  }, {
    "resourceId" : "resourceId",
    "id" : 1,
    "accounts" : [ {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    }, {
      "isReadOnly" : true,
      "displayName" : "displayName",
      "domain" : "domain",
      "objectClass" : 5,
      "dn" : "dn",
      "sid" : "sid"
    } ],
    "type" : 5
  } ],
  "isReadOnly" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : "type",
  "actions" : [ {
    "configuration" : "configuration",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "isEnabled" : true,
    "type" : "type"
  }, {
    "configuration" : "configuration",
    "credentials" : {
      "password" : "password",
      "username" : "username"
    },
    "isEnabled" : true,
    "type" : "type"
  } ],
  "eventColumns" : [ {
    "isIntersecting" : true,
    "hover" : {
      "addAction" : 5,
      "removeAction" : 2,
      "field" : "field",
      "position" : "position"
    },
    "visible" : true,
    "sources" : [ 0, 0 ],
    "isMetaEventColumn" : true,
    "name" : "name",
    "width" : {
      "default" : 1,
      "value" : 6,
      "minimum" : 5
    },
    "header" : "header",
    "position" : "position",
    "type" : "type"
  }, {
    "isIntersecting" : true,
    "hover" : {
      "addAction" : 5,
      "removeAction" : 2,
      "field" : "field",
      "position" : "position"
    },
    "visible" : true,
    "sources" : [ 0, 0 ],
    "isMetaEventColumn" : true,
    "name" : "name",
    "width" : {
      "default" : 1,
      "value" : 6,
      "minimum" : 5
    },
    "header" : "header",
    "position" : "position",
    "type" : "type"
  } ],
  "tags" : [ {
    "origin" : 1,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "origin" : 1,
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ReportWeb

ReportStyling

Up
get /api/v{version}/reportstylings
(apiVversionReportstylingsGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
[ {
  "isItalic" : true,
  "mappings" : {
    "key" : 0
  },
  "textColour" : "textColour",
  "isBold" : true,
  "elementName" : "elementName"
}, {
  "isItalic" : true,
  "mappings" : {
    "key" : 0
  },
  "textColour" : "textColour",
  "isBold" : true,
  "elementName" : "elementName"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
post /api/v{version}/reportstylings
(apiVversionReportstylingsPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ReportStylingX (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
[ {
  "isItalic" : true,
  "mappings" : {
    "key" : 0
  },
  "textColour" : "textColour",
  "isBold" : true,
  "elementName" : "elementName"
}, {
  "isItalic" : true,
  "mappings" : {
    "key" : 0
  },
  "textColour" : "textColour",
  "isBold" : true,
  "elementName" : "elementName"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Role

Up
get /api/v{version}/delegation/roles/accounts
List role assignments (apiVversionDelegationRolesAccountsGet)
Retrieves roles and users these roles are assigned to.

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "roleId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "id" : 0,
  "scopes" : [ {
    "accountRoleId" : 5,
    "displayName" : "displayName",
    "id" : 1,
    "configurationObject" : "configurationObject",
    "type" : 5
  }, {
    "accountRoleId" : 5,
    "displayName" : "displayName",
    "id" : 1,
    "configurationObject" : "configurationObject",
    "type" : 5
  } ],
  "delegationAccount" : {
    "identifier" : "identifier",
    "displayName" : "displayName",
    "roles" : [ {
      "permissions" : [ {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      }, {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      } ],
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "type" : 0
    }, {
      "permissions" : [ {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      }, {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      } ],
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "type" : 0
    } ],
    "name" : "name",
    "id" : 6,
    "type" : "type",
    "enabled" : true,
    "lastLogon" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success AccountRoleWeb

Up
get /api/v{version}/delegation/roles
List roles (apiVversionDelegationRolesGet)
Retrieves a list of configured roles.

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "permissions" : [ {
    "code" : 0,
    "visible" : true,
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "category" : "category",
    "shortName" : "shortName",
    "type" : "type",
    "displayPermission" : "displayPermission"
  }, {
    "code" : 0,
    "visible" : true,
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "category" : "category",
    "shortName" : "shortName",
    "type" : "type",
    "displayPermission" : "displayPermission"
  } ],
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Role

Up
get /api/v{version}/delegation/roles/{id}/accounts/{accountId}
Retrieve account details (apiVversionDelegationRolesIdAccountsAccountIdGet)
Locates and retrieves details of a specific account that is assigned to a certain role.

Path parameters

id (required)
Path Parameter — The ID of the role format: uuid
accountId (required)
Path Parameter — The ID of the account format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "roleId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "id" : 0,
  "scopes" : [ {
    "accountRoleId" : 5,
    "displayName" : "displayName",
    "id" : 1,
    "configurationObject" : "configurationObject",
    "type" : 5
  }, {
    "accountRoleId" : 5,
    "displayName" : "displayName",
    "id" : 1,
    "configurationObject" : "configurationObject",
    "type" : 5
  } ],
  "delegationAccount" : {
    "identifier" : "identifier",
    "displayName" : "displayName",
    "roles" : [ {
      "permissions" : [ {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      }, {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      } ],
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "type" : 0
    }, {
      "permissions" : [ {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      }, {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      } ],
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "type" : 0
    } ],
    "name" : "name",
    "id" : 6,
    "type" : "type",
    "enabled" : true,
    "lastLogon" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success AccountRoleWeb

Up
put /api/v{version}/delegation/roles/{id}/accounts/{accountId}
Update a user role assignment (apiVversionDelegationRolesIdAccountsAccountIdPut)
Locates and modifies a role assignemnt for a specific user account.

Path parameters

id (required)
Path Parameter — The ID of the role format: uuid
accountId (required)
Path Parameter — The ID of the account format: int32
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body AccountRoleWeb (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "roleId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "id" : 0,
  "scopes" : [ {
    "accountRoleId" : 5,
    "displayName" : "displayName",
    "id" : 1,
    "configurationObject" : "configurationObject",
    "type" : 5
  }, {
    "accountRoleId" : 5,
    "displayName" : "displayName",
    "id" : 1,
    "configurationObject" : "configurationObject",
    "type" : 5
  } ],
  "delegationAccount" : {
    "identifier" : "identifier",
    "displayName" : "displayName",
    "roles" : [ {
      "permissions" : [ {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      }, {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      } ],
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "type" : 0
    }, {
      "permissions" : [ {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      }, {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      } ],
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "type" : 0
    } ],
    "name" : "name",
    "id" : 6,
    "type" : "type",
    "enabled" : true,
    "lastLogon" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success AccountRoleWeb

Up
get /api/v{version}/delegation/roles/{id}/accounts
List assignments for a role (apiVversionDelegationRolesIdAccountsGet)
Locates all user accounts assigned to a specific role. Provide 'roleID' as 'id' in the path.

Path parameters

id (required)
Path Parameter — The ID of the role format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "roleId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "id" : 0,
  "scopes" : [ {
    "accountRoleId" : 5,
    "displayName" : "displayName",
    "id" : 1,
    "configurationObject" : "configurationObject",
    "type" : 5
  }, {
    "accountRoleId" : 5,
    "displayName" : "displayName",
    "id" : 1,
    "configurationObject" : "configurationObject",
    "type" : 5
  } ],
  "delegationAccount" : {
    "identifier" : "identifier",
    "displayName" : "displayName",
    "roles" : [ {
      "permissions" : [ {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      }, {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      } ],
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "type" : 0
    }, {
      "permissions" : [ {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      }, {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      } ],
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "type" : 0
    } ],
    "name" : "name",
    "id" : 6,
    "type" : "type",
    "enabled" : true,
    "lastLogon" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success AccountRoleWeb

Up
post /api/v{version}/delegation/roles/{id}/accounts
Create a role assignment (apiVversionDelegationRolesIdAccountsPost)
Adds a new role assignment entry to a role.

Path parameters

id (required)
Path Parameter — The ID of the role format: uuid
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body AccountRoleWeb (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "roleId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "id" : 0,
  "scopes" : [ {
    "accountRoleId" : 5,
    "displayName" : "displayName",
    "id" : 1,
    "configurationObject" : "configurationObject",
    "type" : 5
  }, {
    "accountRoleId" : 5,
    "displayName" : "displayName",
    "id" : 1,
    "configurationObject" : "configurationObject",
    "type" : 5
  } ],
  "delegationAccount" : {
    "identifier" : "identifier",
    "displayName" : "displayName",
    "roles" : [ {
      "permissions" : [ {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      }, {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      } ],
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "type" : 0
    }, {
      "permissions" : [ {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      }, {
        "code" : 0,
        "visible" : true,
        "configuration" : "configuration",
        "name" : "name",
        "description" : "description",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "category" : "category",
        "shortName" : "shortName",
        "type" : "type",
        "displayPermission" : "displayPermission"
      } ],
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "type" : 0
    } ],
    "name" : "name",
    "id" : 6,
    "type" : "type",
    "enabled" : true,
    "lastLogon" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success AccountRoleWeb

Up
delete /api/v{version}/delegation/roles/{id}
Delete a role (apiVversionDelegationRolesIdDelete)
Locates a role by its ID and removes it.

Path parameters

id (required)
Path Parameter — The ID of the role format: uuid
version (required)
Path Parameter

Responses

200

Success

Up
get /api/v{version}/delegation/roles/{id}
Retrieve a role (apiVversionDelegationRolesIdGet)
Locates a role and retrieves its details by the role ID.

Path parameters

id (required)
Path Parameter — The ID of the role format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "permissions" : [ {
    "code" : 0,
    "visible" : true,
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "category" : "category",
    "shortName" : "shortName",
    "type" : "type",
    "displayPermission" : "displayPermission"
  }, {
    "code" : 0,
    "visible" : true,
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "category" : "category",
    "shortName" : "shortName",
    "type" : "type",
    "displayPermission" : "displayPermission"
  } ],
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Role

Up
post /api/v{version}/delegation/roles
Create a role (apiVversionDelegationRolesPost)
Adds a new role to Cygna Auditor delegation settings.

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body Role (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "permissions" : [ {
    "code" : 0,
    "visible" : true,
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "category" : "category",
    "shortName" : "shortName",
    "type" : "type",
    "displayPermission" : "displayPermission"
  }, {
    "code" : 0,
    "visible" : true,
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "category" : "category",
    "shortName" : "shortName",
    "type" : "type",
    "displayPermission" : "displayPermission"
  } ],
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Role

Up
put /api/v{version}/delegation/roles
Update a role (apiVversionDelegationRolesPut)
Modifies an existing role. For example, adds or revokes permissions, changes the role name.

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body Role (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "permissions" : [ {
    "code" : 0,
    "visible" : true,
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "category" : "category",
    "shortName" : "shortName",
    "type" : "type",
    "displayPermission" : "displayPermission"
  }, {
    "code" : 0,
    "visible" : true,
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "category" : "category",
    "shortName" : "shortName",
    "type" : "type",
    "displayPermission" : "displayPermission"
  } ],
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Role

Up
delete /api/v{version}/delegation/roles/{roleId}/accounts/{accountId}
Delete a role assignment (apiVversionDelegationRolesRoleIdAccountsAccountIdDelete)
Revokes a specific role assignment. The user will no longer have the role. Provide 'roleId' and 'accountId' in the path.

Path parameters

roleId (required)
Path Parameter — The ID of the role format: uuid
accountId (required)
Path Parameter — The ID of the account format: int32
version (required)
Path Parameter

Responses

200

Success

ScheduledJob

Up
get /api/v{version}/scheduledjobs
(apiVversionScheduledjobsGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
[ {
  "nextRunOn" : "2000-01-23T04:56:07.000+00:00",
  "timingInfo" : {
    "misfireRule" : 1,
    "type" : 6,
    "priority" : 5,
    "effectiveDates" : {
      "endAt" : "2000-01-23T04:56:07.000+00:00",
      "startAt" : "2000-01-23T04:56:07.000+00:00"
    }
  },
  "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
  "isEnabled" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "state" : 5,
  "type" : 0,
  "jobInfo" : { },
  "lastRunOn" : "2000-01-23T04:56:07.000+00:00"
}, {
  "nextRunOn" : "2000-01-23T04:56:07.000+00:00",
  "timingInfo" : {
    "misfireRule" : 1,
    "type" : 6,
    "priority" : 5,
    "effectiveDates" : {
      "endAt" : "2000-01-23T04:56:07.000+00:00",
      "startAt" : "2000-01-23T04:56:07.000+00:00"
    }
  },
  "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
  "isEnabled" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "state" : 5,
  "type" : 0,
  "jobInfo" : { },
  "lastRunOn" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
delete /api/v{version}/scheduledjobs/{id}
(apiVversionScheduledjobsIdDelete)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/scheduledjobs/{id}
(apiVversionScheduledjobsIdGet)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "nextRunOn" : "2000-01-23T04:56:07.000+00:00",
  "timingInfo" : {
    "misfireRule" : 1,
    "type" : 6,
    "priority" : 5,
    "effectiveDates" : {
      "endAt" : "2000-01-23T04:56:07.000+00:00",
      "startAt" : "2000-01-23T04:56:07.000+00:00"
    }
  },
  "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
  "isEnabled" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "state" : 5,
  "type" : 0,
  "jobInfo" : { },
  "lastRunOn" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ScheduledJobWeb

Up
put /api/v{version}/scheduledjobs/{id}
(apiVversionScheduledjobsIdPut)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ScheduledJobWeb (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "nextRunOn" : "2000-01-23T04:56:07.000+00:00",
  "timingInfo" : {
    "misfireRule" : 1,
    "type" : 6,
    "priority" : 5,
    "effectiveDates" : {
      "endAt" : "2000-01-23T04:56:07.000+00:00",
      "startAt" : "2000-01-23T04:56:07.000+00:00"
    }
  },
  "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
  "isEnabled" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "state" : 5,
  "type" : 0,
  "jobInfo" : { },
  "lastRunOn" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ScheduledJobWeb

Up
post /api/v{version}/scheduledjobs
(apiVversionScheduledjobsPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ScheduledJobWeb (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "nextRunOn" : "2000-01-23T04:56:07.000+00:00",
  "timingInfo" : {
    "misfireRule" : 1,
    "type" : 6,
    "priority" : 5,
    "effectiveDates" : {
      "endAt" : "2000-01-23T04:56:07.000+00:00",
      "startAt" : "2000-01-23T04:56:07.000+00:00"
    }
  },
  "modifiedOn" : "2000-01-23T04:56:07.000+00:00",
  "isEnabled" : true,
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "state" : 5,
  "type" : 0,
  "jobInfo" : { },
  "lastRunOn" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ScheduledJobWeb

Scheduler

Up
get /api/v{version}/system/config/scheduler
(apiVversionSystemConfigSchedulerGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "directive" : 0,
  "status" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success SchedulerConfiguration

Up
put /api/v{version}/system/config/scheduler
(apiVversionSystemConfigSchedulerPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body SchedulerConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "directive" : 0,
  "status" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success SchedulerConfiguration

Search

Up
get /api/v{version}/search
(apiVversionSearchGet)

Path parameters

version (required)
Path Parameter

Query parameters

type (optional)
Query Parameter — 0 = None, 1 = Active Directory, 2 = Azure, 3 = O365, 4 = Teams, 5 = V M Ware, 6 = AzureARM
field (optional)
Query Parameter
value (optional)
Query Parameter
limit (optional)
Query Parameter — default: 100 format: int32
option (optional)
Query Parameter — 0 = Starts With, 1 = Ends With, 2 = Contains
order (optional)
Query Parameter — 0 = Asc, 1 = Desc

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success String

ServiceCommand

Up
post /api/v{version}/servicecommand
(apiVversionServicecommandPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body ServiceCommand (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Setup

Up
post /api/v{version}/setup/finalize
(apiVversionSetupFinalizePost)

Path parameters

version (required)
Path Parameter

Responses

200

Success

Smtp

Up
delete /api/v{version}/system/config/smtp
(apiVversionSystemConfigSmtpDelete)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/system/config/smtp
(apiVversionSystemConfigSmtpGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "server" : "server",
  "port" : 0,
  "isSslToBeUsed" : true,
  "userCredentials" : {
    "password" : "password",
    "username" : "username"
  },
  "fromName" : "fromName",
  "fromAddress" : "fromAddress",
  "toAddress" : "toAddress"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success SmtpConfiguration

Up
post /api/v{version}/system/config/smtp
(apiVversionSystemConfigSmtpPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body SmtpConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "server" : "server",
  "port" : 0,
  "isSslToBeUsed" : true,
  "userCredentials" : {
    "password" : "password",
    "username" : "username"
  },
  "fromName" : "fromName",
  "fromAddress" : "fromAddress",
  "toAddress" : "toAddress"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success SmtpConfiguration

Up
put /api/v{version}/system/config/smtp
(apiVversionSystemConfigSmtpPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body SmtpConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "server" : "server",
  "port" : 0,
  "isSslToBeUsed" : true,
  "userCredentials" : {
    "password" : "password",
    "username" : "username"
  },
  "fromName" : "fromName",
  "fromAddress" : "fromAddress",
  "toAddress" : "toAddress"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success SmtpConfiguration

Up
get /api/v{version}/system/config/smtp/status
(apiVversionSystemConfigSmtpStatusGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isConfigured" : true,
  "item" : 0,
  "displayName" : "displayName"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success ConfigurationStatus

Up
post /api/v{version}/system/config/smtp/test
(apiVversionSystemConfigSmtpTestPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body SmtpConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

System

Up
get /api/v{version}/system/about
(apiVversionSystemAboutGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "databaseStatistics" : {
    "eventsPerGb" : 1,
    "totalEventCount" : 4,
    "vMwareEventCount" : 2,
    "azureLogonEventCount" : 5,
    "adEventCount" : 0,
    "securityComplianceCenterEventCount" : 2,
    "sharePointOnlineEventCount" : 7,
    "fsEventCount" : 6,
    "microsoftTeamsEventCount" : 9,
    "azureAdEventCount" : 1,
    "databaseSize" : 7,
    "azureEventCount" : 5,
    "exchangeOnlineEventCount" : 3
  },
  "about" : {
    "copyright" : "copyright",
    "company" : "company",
    "productName" : "productName"
  },
  "systemInformation" : {
    "fsDriverVersion" : "fsDriverVersion",
    "productVersion" : "productVersion",
    "databaseServer" : "databaseServer",
    "databaseName" : "databaseName",
    "processorCount" : "processorCount",
    "adDriverVersion" : "adDriverVersion",
    "maintenanceExpiry" : "maintenanceExpiry",
    "buildDate" : "buildDate",
    "operatingSystem" : "operatingSystem",
    "licensedTo" : "licensedTo",
    "machineName" : "machineName",
    "rsatExtensionVersion" : "rsatExtensionVersion"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success AboutInformation

Up
get /api/v{version}/system/status
(apiVversionSystemStatusGet)

Path parameters

version (required)
Path Parameter

Return type

array[SystemStatus]

Example data

Content-Type: application/json
[ {
  "appVersion" : "appVersion",
  "lastActiveTime" : "2000-01-23T04:56:07.000+00:00",
  "isInactive" : true,
  "errorCode" : 5,
  "type" : "type",
  "statusMessage" : "statusMessage",
  "enabled" : true,
  "isAgent" : true,
  "statusId" : 2,
  "name" : "name",
  "parentItem" : "parentItem",
  "statusCodeDisplay" : "statusCodeDisplay",
  "interval" : 5,
  "lastEventTime" : "2000-01-23T04:56:07.000+00:00",
  "statusCodeDisplayEnhanced" : "statusCodeDisplayEnhanced",
  "id" : 0,
  "configurationId" : 6,
  "applicationGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "isStale" : true,
  "statusCode" : 1
}, {
  "appVersion" : "appVersion",
  "lastActiveTime" : "2000-01-23T04:56:07.000+00:00",
  "isInactive" : true,
  "errorCode" : 5,
  "type" : "type",
  "statusMessage" : "statusMessage",
  "enabled" : true,
  "isAgent" : true,
  "statusId" : 2,
  "name" : "name",
  "parentItem" : "parentItem",
  "statusCodeDisplay" : "statusCodeDisplay",
  "interval" : 5,
  "lastEventTime" : "2000-01-23T04:56:07.000+00:00",
  "statusCodeDisplayEnhanced" : "statusCodeDisplayEnhanced",
  "id" : 0,
  "configurationId" : 6,
  "applicationGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "isStale" : true,
  "statusCode" : 1
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

SystemConfiguration

Up
delete /api/v{version}/system/config/{id}
(apiVversionSystemConfigIdDelete)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
0

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygStatus

Up
get /api/v{version}/system/config/{id}
(apiVversionSystemConfigIdGet)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success SystemConfigurationBase

Up
post /api/v{version}/system/config
(apiVversionSystemConfigPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body SystemConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success SystemConfigurationBase

Up
put /api/v{version}/system/config
(apiVversionSystemConfigPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body SystemConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success SystemConfigurationBase

Up
get /api/v{version}/system/config/status
(apiVversionSystemConfigStatusGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
[ {
  "isConfigured" : true,
  "item" : 0,
  "displayName" : "displayName"
}, {
  "isConfigured" : true,
  "item" : 0,
  "displayName" : "displayName"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
post /api/v{version}/system/config/test
(apiVversionSystemConfigTestPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body SystemConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "adminCredentials" : {
    "password" : "password",
    "username" : "username"
  },
  "data" : "data",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success SystemConfiguration

Up
post /api/v{version}/system/config/validate
(apiVversionSystemConfigValidatePost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body SystemConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "adminCredentials" : {
    "password" : "password",
    "username" : "username"
  },
  "data" : "data",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success SystemConfiguration

Tag

Up
post /api/v{version}/tags/context/{context}
(apiVversionTagsContextContextPost)

Path parameters

context (required)
Path Parameter — 0 = Reports, 1 = Alerts, 1111 = All
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body Tag (optional)
Body Parameter

Query parameters

id (required)
Query Parameter — format: uuid

Return type

Example data

Content-Type: application/json
{
  "origin" : 1,
  "name" : "name",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Tag

Up
get /api/v{version}/tags/contextual
(apiVversionTagsContextualGet)

Path parameters

version (required)
Path Parameter

Query parameters

context (optional)
Query Parameter — 0 = Reports, 1 = Alerts, 1111 = All
origin (optional)
Query Parameter — 0 = Built In, 1 = User, 1111 = All

Return type

array[ContextualTag]

Example data

Content-Type: application/json
[ {
  "origin" : 0,
  "name" : "name",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "contexts" : [ 6, 6 ]
}, {
  "origin" : 0,
  "name" : "name",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "contexts" : [ 6, 6 ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
get /api/v{version}/tags
(apiVversionTagsGet)

Path parameters

version (required)
Path Parameter

Return type

array[Tag]

Example data

Content-Type: application/json
[ {
  "origin" : 1,
  "name" : "name",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
  "origin" : 1,
  "name" : "name",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
delete /api/v{version}/tags/{id}
(apiVversionTagsIdDelete)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/tags/{id}
(apiVversionTagsIdGet)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "origin" : 1,
  "name" : "name",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Tag

Up
put /api/v{version}/tags/{id}
(apiVversionTagsIdPut)

Path parameters

id (required)
Path Parameter — format: uuid
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body Tag (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "origin" : 1,
  "name" : "name",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Tag

Up
post /api/v{version}/tags
(apiVversionTagsPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body Tag (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "origin" : 1,
  "name" : "name",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Tag

User

Up
get /api/v{version}/delegation/users
List users with roles (apiVversionDelegationUsersGet)
Retrieves a list of users and the roles they are assigned.

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "displayName" : "displayName",
  "roles" : [ {
    "permissions" : [ {
      "code" : 0,
      "visible" : true,
      "configuration" : "configuration",
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "category" : "category",
      "shortName" : "shortName",
      "type" : "type",
      "displayPermission" : "displayPermission"
    }, {
      "code" : 0,
      "visible" : true,
      "configuration" : "configuration",
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "category" : "category",
      "shortName" : "shortName",
      "type" : "type",
      "displayPermission" : "displayPermission"
    } ],
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "type" : 0
  }, {
    "permissions" : [ {
      "code" : 0,
      "visible" : true,
      "configuration" : "configuration",
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "category" : "category",
      "shortName" : "shortName",
      "type" : "type",
      "displayPermission" : "displayPermission"
    }, {
      "code" : 0,
      "visible" : true,
      "configuration" : "configuration",
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "category" : "category",
      "shortName" : "shortName",
      "type" : "type",
      "displayPermission" : "displayPermission"
    } ],
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "type" : 0
  } ],
  "name" : "name",
  "id" : 6,
  "type" : "type",
  "enabled" : true,
  "lastLogon" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DelegationAccount

Up
delete /api/v{version}/delegation/users/{id}
Delete a user (apiVversionDelegationUsersIdDelete)
Removes a user and revokes permissions.

Path parameters

id (required)
Path Parameter — The ID of the user format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "displayName" : "displayName",
  "roles" : [ {
    "permissions" : [ {
      "code" : 0,
      "visible" : true,
      "configuration" : "configuration",
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "category" : "category",
      "shortName" : "shortName",
      "type" : "type",
      "displayPermission" : "displayPermission"
    }, {
      "code" : 0,
      "visible" : true,
      "configuration" : "configuration",
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "category" : "category",
      "shortName" : "shortName",
      "type" : "type",
      "displayPermission" : "displayPermission"
    } ],
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "type" : 0
  }, {
    "permissions" : [ {
      "code" : 0,
      "visible" : true,
      "configuration" : "configuration",
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "category" : "category",
      "shortName" : "shortName",
      "type" : "type",
      "displayPermission" : "displayPermission"
    }, {
      "code" : 0,
      "visible" : true,
      "configuration" : "configuration",
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "category" : "category",
      "shortName" : "shortName",
      "type" : "type",
      "displayPermission" : "displayPermission"
    } ],
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "type" : 0
  } ],
  "name" : "name",
  "id" : 6,
  "type" : "type",
  "enabled" : true,
  "lastLogon" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DelegationAccount

Up
get /api/v{version}/delegation/users/{id}/permissions
List user permissions (apiVversionDelegationUsersIdPermissionsGet)
Locates a user and retrieves associated permissions.

Path parameters

id (required)
Path Parameter — The ID of the user format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "code" : 0,
  "visible" : true,
  "configuration" : "configuration",
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "category" : "category",
  "shortName" : "shortName",
  "type" : "type",
  "displayPermission" : "displayPermission"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Permission

Up
put /api/v{version}/delegation/users/{id}
Update a user (apiVversionDelegationUsersIdPut)
Locates a specific user and updates its delegation settings.

Path parameters

id (required)
Path Parameter — The ID of the user format: int32
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DelegationAccount (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "displayName" : "displayName",
  "roles" : [ {
    "permissions" : [ {
      "code" : 0,
      "visible" : true,
      "configuration" : "configuration",
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "category" : "category",
      "shortName" : "shortName",
      "type" : "type",
      "displayPermission" : "displayPermission"
    }, {
      "code" : 0,
      "visible" : true,
      "configuration" : "configuration",
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "category" : "category",
      "shortName" : "shortName",
      "type" : "type",
      "displayPermission" : "displayPermission"
    } ],
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "type" : 0
  }, {
    "permissions" : [ {
      "code" : 0,
      "visible" : true,
      "configuration" : "configuration",
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "category" : "category",
      "shortName" : "shortName",
      "type" : "type",
      "displayPermission" : "displayPermission"
    }, {
      "code" : 0,
      "visible" : true,
      "configuration" : "configuration",
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "category" : "category",
      "shortName" : "shortName",
      "type" : "type",
      "displayPermission" : "displayPermission"
    } ],
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "type" : 0
  } ],
  "name" : "name",
  "id" : 6,
  "type" : "type",
  "enabled" : true,
  "lastLogon" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DelegationAccount

Up
get /api/v{version}/delegation/users/{id}/roles
List user roles (apiVversionDelegationUsersIdRolesGet)
Locates a specific user and retrieves assigned roles.

Path parameters

id (required)
Path Parameter — The ID of the user format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "permissions" : [ {
    "code" : 0,
    "visible" : true,
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "category" : "category",
    "shortName" : "shortName",
    "type" : "type",
    "displayPermission" : "displayPermission"
  }, {
    "code" : 0,
    "visible" : true,
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "category" : "category",
    "shortName" : "shortName",
    "type" : "type",
    "displayPermission" : "displayPermission"
  } ],
  "name" : "name",
  "description" : "description",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success Role

Up
post /api/v{version}/delegation/users
Add a new user (apiVversionDelegationUsersPost)
Adds new user and assigns a role.

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body DelegationAccount (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "displayName" : "displayName",
  "roles" : [ {
    "permissions" : [ {
      "code" : 0,
      "visible" : true,
      "configuration" : "configuration",
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "category" : "category",
      "shortName" : "shortName",
      "type" : "type",
      "displayPermission" : "displayPermission"
    }, {
      "code" : 0,
      "visible" : true,
      "configuration" : "configuration",
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "category" : "category",
      "shortName" : "shortName",
      "type" : "type",
      "displayPermission" : "displayPermission"
    } ],
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "type" : 0
  }, {
    "permissions" : [ {
      "code" : 0,
      "visible" : true,
      "configuration" : "configuration",
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "category" : "category",
      "shortName" : "shortName",
      "type" : "type",
      "displayPermission" : "displayPermission"
    }, {
      "code" : 0,
      "visible" : true,
      "configuration" : "configuration",
      "name" : "name",
      "description" : "description",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "category" : "category",
      "shortName" : "shortName",
      "type" : "type",
      "displayPermission" : "displayPermission"
    } ],
    "name" : "name",
    "description" : "description",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "type" : 0
  } ],
  "name" : "name",
  "id" : 6,
  "type" : "type",
  "enabled" : true,
  "lastLogon" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success DelegationAccount

Up
post /api/v{version}/user/credentials/verify
(apiVversionUserCredentialsVerifyPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body AccountCredentials (optional)
Body Parameter

Query parameters

isAdminRequired (required)
Query Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/user/search/activedirectory
(apiVversionUserSearchActivedirectoryGet)

Path parameters

version (required)
Path Parameter

Query parameters

searchString (optional)
Query Parameter
objectType (optional)
Query Parameter — 1 = Local Users, 2 = Local Groups, 4 = Domain Users, 8 = Domain Groups, 16 = Computers, 32 = Domain Controllers, 64 = Exchange Servers, 128 = Sql Servers, 256 = Containers, 512 = Organizational Units
limit (optional)
Query Parameter — default: 50 format: int32

Return type

Example data

Content-Type: application/json
[ {
  "msdsPrincipalName" : "msdsPrincipalName",
  "presentationName" : "presentationName",
  "displayName" : "displayName",
  "accountExpires" : 1,
  "objectClass" : "objectClass",
  "samAccountName" : "samAccountName",
  "dnsName" : "dnsName",
  "description" : "description",
  "dn" : "dn",
  "cn" : "cn",
  "ldapName" : "ldapName",
  "managerEmail" : "managerEmail",
  "rawValues" : {
    "key" : [ "", "" ]
  },
  "domain" : "domain",
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "objectSid" : "objectSid",
  "attributes" : [ {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  }, {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  } ],
  "userPrincipalName" : "userPrincipalName",
  "userAccountControl" : 0,
  "pwdLastSet" : 6
}, {
  "msdsPrincipalName" : "msdsPrincipalName",
  "presentationName" : "presentationName",
  "displayName" : "displayName",
  "accountExpires" : 1,
  "objectClass" : "objectClass",
  "samAccountName" : "samAccountName",
  "dnsName" : "dnsName",
  "description" : "description",
  "dn" : "dn",
  "cn" : "cn",
  "ldapName" : "ldapName",
  "managerEmail" : "managerEmail",
  "rawValues" : {
    "key" : [ "", "" ]
  },
  "domain" : "domain",
  "objectGuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "objectSid" : "objectSid",
  "attributes" : [ {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  }, {
    "isClass" : true,
    "displayValue" : "displayValue",
    "linkId" : 1,
    "systemOnly" : true,
    "displayName" : "displayName",
    "schemaID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "values" : [ "", "" ],
    "name" : "name",
    "aDsType" : 6,
    "id" : 0,
    "isOID" : true,
    "syntaxOID" : "syntaxOID"
  } ],
  "userPrincipalName" : "userPrincipalName",
  "userAccountControl" : 0,
  "pwdLastSet" : 6
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
get /api/v{version}/user/search
(apiVversionUserSearchGet)

Path parameters

version (required)
Path Parameter

Query parameters

searchText (optional)
Query Parameter
maxMatches (optional)
Query Parameter — default: 100 format: int32
includeLiveSearch (optional)
Query Parameter — default: true

Return type

Example data

Content-Type: application/json
[ {
  "accountId" : 0,
  "presentationName" : "presentationName",
  "origin" : 6,
  "matchedElements" : [ {
    "name" : "name",
    "value" : "value"
  }, {
    "name" : "name",
    "value" : "value"
  } ]
}, {
  "accountId" : 0,
  "presentationName" : "presentationName",
  "origin" : 6,
  "matchedElements" : [ {
    "name" : "name",
    "value" : "value"
  }, {
    "name" : "name",
    "value" : "value"
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

UserConfiguration

Up
delete /api/v{version}/user/config
(apiVversionUserConfigDelete)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
post /api/v{version}/user/config/delete
(apiVversionUserConfigDeletePost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body AccountCredentials (optional)
Body Parameter

Query parameters

deleteUserSid (optional)
Query Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/user/config
(apiVversionUserConfigGet)

Path parameters

version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "applicationTheme" : "applicationTheme",
  "consoleOptions" : "consoleOptions",
  "applicationSettings" : {
    "enableAutoSearch" : true,
    "reportEventLimit" : 9,
    "enableAuditPaging" : true,
    "rollbackLayout" : [ null, null ],
    "auditEventLimit" : 7,
    "auditingLayout" : [ {
      "isIntersecting" : true,
      "hover" : {
        "addAction" : 5,
        "removeAction" : 2,
        "field" : "field",
        "position" : "position"
      },
      "visible" : true,
      "sources" : [ 0, 0 ],
      "isMetaEventColumn" : true,
      "name" : "name",
      "width" : {
        "default" : 1,
        "value" : 6,
        "minimum" : 5
      },
      "header" : "header",
      "position" : "position",
      "type" : "type"
    }, {
      "isIntersecting" : true,
      "hover" : {
        "addAction" : 5,
        "removeAction" : 2,
        "field" : "field",
        "position" : "position"
      },
      "visible" : true,
      "sources" : [ 0, 0 ],
      "isMetaEventColumn" : true,
      "name" : "name",
      "width" : {
        "default" : 1,
        "value" : 6,
        "minimum" : 5
      },
      "header" : "header",
      "position" : "position",
      "type" : "type"
    } ],
    "isSideMenuExpanded" : true
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success UserConfiguration

Up
post /api/v{version}/user/config
(apiVversionUserConfigPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body UserConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "applicationTheme" : "applicationTheme",
  "consoleOptions" : "consoleOptions",
  "applicationSettings" : {
    "enableAutoSearch" : true,
    "reportEventLimit" : 9,
    "enableAuditPaging" : true,
    "rollbackLayout" : [ null, null ],
    "auditEventLimit" : 7,
    "auditingLayout" : [ {
      "isIntersecting" : true,
      "hover" : {
        "addAction" : 5,
        "removeAction" : 2,
        "field" : "field",
        "position" : "position"
      },
      "visible" : true,
      "sources" : [ 0, 0 ],
      "isMetaEventColumn" : true,
      "name" : "name",
      "width" : {
        "default" : 1,
        "value" : 6,
        "minimum" : 5
      },
      "header" : "header",
      "position" : "position",
      "type" : "type"
    }, {
      "isIntersecting" : true,
      "hover" : {
        "addAction" : 5,
        "removeAction" : 2,
        "field" : "field",
        "position" : "position"
      },
      "visible" : true,
      "sources" : [ 0, 0 ],
      "isMetaEventColumn" : true,
      "name" : "name",
      "width" : {
        "default" : 1,
        "value" : 6,
        "minimum" : 5
      },
      "header" : "header",
      "position" : "position",
      "type" : "type"
    } ],
    "isSideMenuExpanded" : true
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success UserConfiguration

Up
put /api/v{version}/user/config
(apiVversionUserConfigPut)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body UserConfiguration (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "applicationTheme" : "applicationTheme",
  "consoleOptions" : "consoleOptions",
  "applicationSettings" : {
    "enableAutoSearch" : true,
    "reportEventLimit" : 9,
    "enableAuditPaging" : true,
    "rollbackLayout" : [ null, null ],
    "auditEventLimit" : 7,
    "auditingLayout" : [ {
      "isIntersecting" : true,
      "hover" : {
        "addAction" : 5,
        "removeAction" : 2,
        "field" : "field",
        "position" : "position"
      },
      "visible" : true,
      "sources" : [ 0, 0 ],
      "isMetaEventColumn" : true,
      "name" : "name",
      "width" : {
        "default" : 1,
        "value" : 6,
        "minimum" : 5
      },
      "header" : "header",
      "position" : "position",
      "type" : "type"
    }, {
      "isIntersecting" : true,
      "hover" : {
        "addAction" : 5,
        "removeAction" : 2,
        "field" : "field",
        "position" : "position"
      },
      "visible" : true,
      "sources" : [ 0, 0 ],
      "isMetaEventColumn" : true,
      "name" : "name",
      "width" : {
        "default" : 1,
        "value" : 6,
        "minimum" : 5
      },
      "header" : "header",
      "position" : "position",
      "type" : "type"
    } ],
    "isSideMenuExpanded" : true
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success UserConfiguration

VMWare

Up
get /api/v{version}/collectors/vmware/servers
(apiVversionCollectorsVmwareServersGet)

Path parameters

version (required)
Path Parameter

Return type

array[VMWareServer]

Example data

Content-Type: application/json
[ {
  "lastActiveTime" : "2000-01-23T04:56:07.000+00:00",
  "isCertToBeIgnored" : true,
  "credentials" : {
    "password" : "password",
    "username" : "username"
  },
  "isSsoToBeDisabled" : true,
  "backupCollectionInterval" : 1,
  "lastCollectionTime" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "message" : "message",
  "vCenterName" : "vCenterName",
  "collectionInterval" : 6,
  "status" : 5
}, {
  "lastActiveTime" : "2000-01-23T04:56:07.000+00:00",
  "isCertToBeIgnored" : true,
  "credentials" : {
    "password" : "password",
    "username" : "username"
  },
  "isSsoToBeDisabled" : true,
  "backupCollectionInterval" : 1,
  "lastCollectionTime" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "message" : "message",
  "vCenterName" : "vCenterName",
  "collectionInterval" : 6,
  "status" : 5
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success

Up
delete /api/v{version}/collectors/vmware/servers/{id}
(apiVversionCollectorsVmwareServersIdDelete)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "isSuccessful" : true,
  "message" : "message",
  "status" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success CygApiResultBase

Up
get /api/v{version}/collectors/vmware/servers/{id}
(apiVversionCollectorsVmwareServersIdGet)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Return type

Example data

Content-Type: application/json
{
  "lastActiveTime" : "2000-01-23T04:56:07.000+00:00",
  "isCertToBeIgnored" : true,
  "credentials" : {
    "password" : "password",
    "username" : "username"
  },
  "isSsoToBeDisabled" : true,
  "backupCollectionInterval" : 1,
  "lastCollectionTime" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "message" : "message",
  "vCenterName" : "vCenterName",
  "collectionInterval" : 6,
  "status" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success VMWareServer

Up
put /api/v{version}/collectors/vmware/servers/{id}
(apiVversionCollectorsVmwareServersIdPut)

Path parameters

id (required)
Path Parameter — format: int32
version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body VMWareServer (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "lastActiveTime" : "2000-01-23T04:56:07.000+00:00",
  "isCertToBeIgnored" : true,
  "credentials" : {
    "password" : "password",
    "username" : "username"
  },
  "isSsoToBeDisabled" : true,
  "backupCollectionInterval" : 1,
  "lastCollectionTime" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "message" : "message",
  "vCenterName" : "vCenterName",
  "collectionInterval" : 6,
  "status" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success VMWareServer

Up
post /api/v{version}/collectors/vmware/servers
(apiVversionCollectorsVmwareServersPost)

Path parameters

version (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json-patch+json
  • application/json
  • text/json
  • application/*+json

Request body

body VMWareServer (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "lastActiveTime" : "2000-01-23T04:56:07.000+00:00",
  "isCertToBeIgnored" : true,
  "credentials" : {
    "password" : "password",
    "username" : "username"
  },
  "isSsoToBeDisabled" : true,
  "backupCollectionInterval" : 1,
  "lastCollectionTime" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "message" : "message",
  "vCenterName" : "vCenterName",
  "collectionInterval" : 6,
  "status" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/plain
  • application/json
  • text/json

Responses

200

Success VMWareServer

Models

  1. ADBackupConfiguration
  2. AboutInformation
  3. AccountCredentials
  4. AccountRoleWeb
  5. ActionConfiguration
  6. ActiveDirectoryAce
  7. ActiveDirectoryAttribute
  8. ActiveDirectoryAttributeData
  9. ActiveDirectoryDomain
  10. ActiveDirectoryObject
  11. ActiveDirectoryObject2
  12. ActiveDirectoryObjectRecord
  13. ActiveDirectoryProfile
  14. ActiveDirectorySecurityDescriptor
  15. ApplicationPool
  16. ApplicationPoolIdentity
  17. ApplicationSettings
  18. Assembly
  19. AttributeValue
  20. AuditEvent
  21. AuditEventColumn
  22. AuditEventColumnHover
  23. AuditEventColumnWidth
  24. AuditEventDetailBase
  25. AzureSnapshot
  26. BooleanCygTResultBase
  27. CallingConventions
  28. Chart
  29. ChartParameter
  30. ChartType
  31. Clause
  32. ClauseType
  33. ClauseValue
  34. CollectionConfiguration
  35. CollectorBackup
  36. CollectorStatusCheckCollector
  37. CollectorStatusCheckConfiguration
  38. CollectorStatusCheckConfigurationState
  39. CollectorStatusCheckDirective
  40. Configuration
  41. ConfigurationStatus
  42. ConnectionString
  43. ConstructorInfo
  44. ContainerOption
  45. ContextualTag
  46. CreateTarget
  47. CustomAttributeData
  48. CustomAttributeNamedArgument
  49. CustomAttributeTypedArgument
  50. CygApiResultBase
  51. CygStatus
  52. CygnaAuditorService
  53. DataComparison
  54. DataSource
  55. DatabaseConnectorDesignation
  56. DatabaseConnectorType
  57. DatabaseInfo
  58. DatabaseList
  59. DatabaseSetup
  60. DatabaseStatistics
  61. DatabaseVersion
  62. DatabaseVersionCompare
  63. DelegatedAccount
  64. DelegatedDatabaseConnector
  65. DelegatedResourceType
  66. DelegatedResourceX
  67. DelegationAccount
  68. DeletedObject
  69. DomainConfiguration
  70. DomainController
  71. DomainControllerSearch
  72. DomainProtectionPolicy
  73. DomainSearch
  74. EventAttributes
  75. EventInfo
  76. EventsRequest
  77. Exception
  78. FieldAttributes
  79. FieldInfo
  80. FileServer
  81. FileSystemConfiguration
  82. FilterAction
  83. FilterClause
  84. FilterReport
  85. FilterValue
  86. GenericParameterAttributes
  87. GpoChange
  88. HealthCheck
  89. HealthStatus
  90. ICustomAttributeProvider
  91. IMatchedElement
  92. IUserSearchMatch
  93. Identity
  94. IdentityAccount
  95. IdentityAccountState
  96. IdentityType
  97. InheritanceType
  98. IntPtr
  99. JobInfoBase
  100. LayoutKind
  101. LdapScope
  102. License
  103. LicenseDetail
  104. LogConfiguration
  105. LogLevel
  106. LogMessage
  107. LoggingConfiguration
  108. ManagedPipelineMode
  109. MemberInfo
  110. MemberTypes
  111. MethodAttributes
  112. MethodBase
  113. MethodImplAttributes
  114. MethodInfo
  115. MisfireRule
  116. Module
  117. ModuleHandle
  118. NamingConflictOption
  119. NamingContext
  120. Object
  121. ObjectClassType
  122. ObjectSnapshot
  123. Option
  124. Order
  125. ParameterAttributes
  126. ParameterInfo
  127. Permission
  128. PostRunActionBase
  129. PostRunActionType
  130. ProductInformation
  131. PropertyAttributes
  132. PropertyInfo
  133. ProtectedAccount
  134. ProtectedObject
  135. ProtectionFilter
  136. ProtectionRule
  137. ProxyConfigurationWeb
  138. RecoveryRequest
  139. RemoteLoggerConfigurationInfoBase
  140. RemoteLoggerConfigurationX
  141. RemoteLoggerType
  142. ReportAccess
  143. ReportRunnerJobInfo
  144. ReportStylingX
  145. ReportWeb
  146. RequestLock
  147. Role
  148. RunReportInfo
  149. RuntimeFieldHandle
  150. RuntimeMethodHandle
  151. RuntimeTypeHandle
  152. ScheduledJobState
  153. ScheduledJobType
  154. ScheduledJobWeb
  155. ScheduledTimingType
  156. SchedulerConfiguration
  157. SchedulerControlDirective
  158. SchedulerStatus
  159. Scope
  160. SearchObjectType
  161. SearchType
  162. SecurityIdentifier
  163. SecurityRuleSet
  164. ServerList
  165. ServiceCommand
  166. ServiceCommandId
  167. ServiceConfigurationWeb
  168. ServiceControllerStatus
  169. SmtpConfiguration
  170. SocketConfiguration
  171. SocketType
  172. Source
  173. State
  174. StorageType
  175. StructLayoutAttribute
  176. SysConfigItem
  177. SystemConfiguration
  178. SystemConfigurationBase
  179. SystemInformation
  180. SystemStatus
  181. Tag
  182. TagContext
  183. TagOrigin
  184. Target
  185. TargetConfig
  186. TeamsChannel
  187. Tenant
  188. TenantPrecursor
  189. TenantState
  190. Timeframe
  191. TimingInfoBase
  192. TimingPriority
  193. Type
  194. TypeAttributes
  195. TypeInfo
  196. UserConfiguration
  197. UserIdType
  198. UserProfile
  199. UserProvenance
  200. VMWareServer

ADBackupConfiguration Up

id (optional)
Integer format: int32
name (optional)
description (optional)
backupCollectionInterval (optional)
Integer format: int32
dnsName (optional)
domainController (optional)
namingContext (optional)
scope (optional)
customDN (optional)
backupCredentials (optional)
backupAccountName (optional)
backupPassword (optional)
fullBackup (optional)
enabled (optional)
objectGuid (optional)
UUID format: uuid

AboutInformation Up

about (optional)
systemInformation (optional)
databaseStatistics (optional)

AccountCredentials Up

username (optional)
password (optional)

AccountRoleWeb Up

The object describes a role assignment.
id (optional)
Integer format: int32
roleId (optional)
UUID format: uuid
delegationAccount (optional)
scopes (optional)

ActionConfiguration Up

type (optional)
configuration (optional)
credentials (optional)
isEnabled (optional)

ActiveDirectoryAce Up

type (optional)
sid (optional)
accessMask (optional)
Integer format: int32
objectAce (optional)
objectTypeGuid (optional)
UUID format: uuid
inheritedTypeGuid (optional)
UUID format: uuid
objectType (optional)
inheritedType (optional)
account (optional)
aceMask (optional)
aceFlags (optional)

ActiveDirectoryAttribute Up

id (optional)
Integer format: int32
name (optional)
displayName (optional)
isClass (optional)
aDsType (optional)
Integer format: int32
schemaID (optional)
UUID format: uuid
systemOnly (optional)
linkId (optional)
Integer format: int32
isOID (optional)
syntaxOID (optional)
displayValue (optional)
values (optional)

ActiveDirectoryAttributeData Up

name (optional)
value (optional)

ActiveDirectoryDomain Up

id (optional)
Integer format: int32
dnsName (optional)
ncName (optional)
netBiosName (optional)
objectGuid (optional)

ActiveDirectoryObject Up

cn (optional)
objectGuid (optional)
UUID format: uuid
objectSid (optional)
objectClass (optional)
dn (optional)
displayName (optional)
name (optional)
domain (optional)
dnsName (optional)
ldapName (optional)
samAccountName (optional)
userPrincipalName (optional)
presentationName (optional)
description (optional)
msdsPrincipalName (optional)
userAccountControl (optional)
Long format: int64
managerEmail (optional)
pwdLastSet (optional)
Long format: int64
accountExpires (optional)
Long format: int64
attributes (optional)
rawValues (optional)

ActiveDirectoryObject2 Up

cn (optional)
objectGuid (optional)
objectSid (optional)
objectClass (optional)
dn (optional)
displayName (optional)
name (optional)
domain (optional)
dnsName (optional)
ldapName (optional)
samAccountName (optional)
userPrincipalName (optional)
presentationName (optional)
description (optional)
msdsPrincipalName (optional)
userAccountControl (optional)
Long format: int64
managerEmail (optional)
pwdLastSet (optional)
Long format: int64
accountExpires (optional)
Long format: int64
attributes (optional)

ActiveDirectoryObjectRecord Up

id (optional)
Integer format: int32
distinguishedName (optional)
objectGuid (optional)
UUID format: uuid
objectSid (optional)
displayName (optional)
objectClass (optional)

ActiveDirectoryProfile Up

systemAttributes (optional)

ActiveDirectorySecurityDescriptor Up

discretionaryAccessControlList (optional)
systemAccessControlList (optional)
daclPresent (optional)
saclPresent (optional)

ApplicationPool Up

name (optional)
managedPipelineMode (optional)
state (optional)
managedRuntimeVersion (optional)
identity (optional)

ApplicationPoolIdentity Up

identityType (optional)
credentials (optional)

ApplicationSettings Up

isSideMenuExpanded (optional)
auditingLayout (optional)
rollbackLayout (optional)
enableAutoSearch (optional)
auditEventLimit (optional)
Integer format: int32
reportEventLimit (optional)
Integer format: int32
enableAuditPaging (optional)

Assembly Up

definedTypes (optional)
exportedTypes (optional)
codeBase (optional)
entryPoint (optional)
fullName (optional)
imageRuntimeVersion (optional)
isDynamic (optional)
location (optional)
reflectionOnly (optional)
isCollectible (optional)
isFullyTrusted (optional)
customAttributes (optional)
escapedCodeBase (optional)
manifestModule (optional)
modules (optional)
globalAssemblyCache (optional)
hostContext (optional)
Long format: int64
securityRuleSet (optional)

AttributeValue Up

name (optional)
value (optional)
displayValue (optional)

AuditEvent Up

An audit event record.
id (optional)
Long format: int64
module (optional)
Integer format: int32
when (optional)
Date format: date-time
user (optional)
server (optional)
eventName (optional)
objectName (optional)
success (optional)
Integer format: int32
fromAgent (optional)
workstationId (optional)
Integer format: int32
nativeEventId (optional)
Integer format: int32
databaseId (optional)
databaseName (optional)
attribute (optional)
attributeValue (optional)
attributePreviousValue (optional)
objectDN (optional)
objectClass (optional)
location (optional)
isRisky (optional)
client (optional)
crossMailboxOperations (optional)
mailboxUPN (optional)
mailboxFolder (optional)
sourceFileName (optional)
path (optional)
itemType (optional)
Integer format: int32
workload (optional)
valueAdded (optional)
valueAddedDisplay (optional)
valueRemoved (optional)
vmHost (optional)
vmType (optional)
dataCenter (optional)
dataStore (optional)
vm (optional)
vmCategory (optional)
teamName (optional)
teamRole (optional)
teamMember (optional)
tenant (optional)
external (optional)
identityName (optional)
resourceGroup (optional)
eventCategory (optional)
status (optional)
operation (optional)
resourceType (optional)
level (optional)
subscription (optional)
accountSid (optional)
workstation (optional)
samAccountName (optional)
aDsType (optional)
Integer format: int32
opn (optional)
Integer format: int32

AuditEventColumn Up

Defines the data to retrieve and display.
name (optional)
header (optional)
sources (optional)
array[Integer] format: int32
type (optional)
position (optional)
visible (optional)
width (optional)
hover (optional)
isIntersecting (optional)
isMetaEventColumn (optional)

AuditEventColumnHover Up

field (optional)
addAction (optional)
Integer format: int32
removeAction (optional)
Integer format: int32
position (optional)

AuditEventColumnWidth Up

value (optional)
Integer format: int32
default (optional)
Integer format: int32
minimum (optional)
Integer format: int32

AuditEventDetailBase Up

Contains detailed information about the audit event.
id (optional)
Integer format: int32
source (optional)
Integer format: int32
organizationId (optional)
Integer format: int32
success (optional)
eventTime (optional)
Date format: date-time
statusMessage (optional)
userCategory (optional)
Integer format: int32
displayMessage (optional)

AzureSnapshot Up

id (optional)
Long format: int64
backupId (optional)
Long format: int64
objectId (optional)
UUID format: uuid
snapshot (optional)
snapshotBinary (optional)
byte[] format: byte

BooleanCygTResultBase Up

status (optional)
message (optional)
auditDetails (optional)
exception (optional)
isException (optional)
items (optional)
item (optional)
count (optional)
Integer format: int32

CallingConventions Up

1 = Standard, 2 = Var Args, 3 = Any, 32 = Has This, 64 = Explicit This

Chart Up

id (optional)
UUID format: uuid
instanceId (optional)
Integer format: int32
name (optional)
description (optional)
subTitleFormat (optional)
chartType (optional)
parameters (optional)
data (optional)

ChartParameter Up

name (optional)
description (optional)
type (optional)
value (optional)
defaultValue (optional)
hidden (optional)

ChartType Up

0 = Undefined, 1 = Events by Source, 2 = Top Users, 3 = Top Events, 4 = Events collected per day, 5 = Events per Minute, 6 = Top events per field

Clause Up

Defines the data to search for.
type (optional)
fieldName (optional)
String The name of the field.
comparison (optional)
childClauses (optional)
array[Clause] The list of sub-clauses.
values (optional)
array[ClauseValue] The list of values.

ClauseType Up

The enum type of the clause.<br><br>0 = Or, 1 = And, -1 = Undefined

ClauseValue Up

The values.
value (optional)
value2 (optional)

CollectionConfiguration Up

combineEventsDelay (optional)
Integer format: int32
combineEventsEnabled (optional)
excludedAttributes (optional)
ignoreLogonEvents (optional)
ldapTimeout (optional)
Integer format: int32
workstationResolution (optional)
workstationReverseLookup (optional)
processNestedGroups (optional)
processNestedGroupUsers (optional)
processNestedGroupMembers (optional)
processNestedGroupUserMembers (optional)
suppressNestedGroupEventBacklinks (optional)
suppressNestedGroupEventData (optional)
nestedGroups (optional)
enableGPOBackup (optional)
enableMissingGPOBackup (optional)
logLevel (optional)
Integer format: int32

CollectorBackup Up

id (optional)
Integer format: int32
when (optional)
Date format: date-time
source (optional)
objectCount (optional)
Integer format: int32

CollectorStatusCheckCollector Up

configurationId (optional)
Integer format: int32
type (optional)

CollectorStatusCheckConfiguration Up

directive (optional)
interval (optional)
Integer format: int32
excludedCollectors (optional)
excludedStatuses (optional)
state (optional)
version (optional)
Integer format: int32

CollectorStatusCheckConfigurationState Up

0 = Undefined, 1 = Ready, 2 = Disabled

CollectorStatusCheckDirective Up

0 = Undefined, 1 = No Action, 2 = Change With Enable, 3 = Change With Disable

Configuration Up

companyName (optional)
xml (optional)

ConfigurationStatus Up

item (optional)
displayName (optional)
isConfigured (optional)

ConnectionString Up

dataSource (optional)
initialCatalog (optional)
credentials (optional)
connectionTimeout (optional)
Integer format: int32
connectRetryCount (optional)
Integer format: int32
connectRetryInterval (optional)
Integer format: int32
useWindowsAuth (optional)

ConstructorInfo Up

name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
attributes (optional)
methodImplementationFlags (optional)
callingConvention (optional)
isAbstract (optional)
isConstructor (optional)
isFinal (optional)
isHideBySig (optional)
isSpecialName (optional)
isStatic (optional)
isVirtual (optional)
isAssembly (optional)
isFamily (optional)
isFamilyAndAssembly (optional)
isFamilyOrAssembly (optional)
isPrivate (optional)
isPublic (optional)
isConstructedGenericMethod (optional)
isGenericMethod (optional)
isGenericMethodDefinition (optional)
containsGenericParameters (optional)
methodHandle (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)
memberType (optional)

ContainerOption Up

0 = Do Not Restore Child Objects, 1 = Restore Immediate Children Only, 2 = Restore Entire Sub Tree, 3 = Max Value

ContextualTag Up

id (optional)
UUID format: uuid
name (optional)
origin (optional)
contexts (optional)

CreateTarget Up

target (optional)
state (optional)

CustomAttributeData Up

attributeType (optional)
constructor (optional)
constructorArguments (optional)
namedArguments (optional)

CustomAttributeNamedArgument Up

memberInfo (optional)
typedValue (optional)
memberName (optional)
isField (optional)

CustomAttributeTypedArgument Up

argumentType (optional)
value (optional)

CygApiResultBase Up

isSuccessful (optional)
status (optional)
message (optional)

CygStatus Up

0 = Undefined, 1 = Created, 2 = Found, 3 = Updated, 4 = Deleted, 5 = Set, 6 = Passed, 7 = In Progress, 10 = Success, 20 = Already Exists, 22 = Not Found, 25 = Not Set, 26 = Failed, 27 = Transaction Failed, 50 = Insufficient Permission, 100 = Exception, 101 = Assert Exception, 102 = Migration Exception, 103 = Skipped, 104 = Partial

CygnaAuditorService Up

id (optional)
UUID format: uuid
serviceName (optional)
serviceDisplayName (optional)
status (optional)

DataComparison Up

Defines the condition for the search. Each value stands for a specific condition, such as doesn't contain or is.<br><br>0 = None, 1 = Equal, 2 = Not Equal, 3 = Less Than, 4 = Greater Than, 5 = Contains, 6 = Does Not Contain, 7 = Starts With, 8 = Does Not Start With, 9 = Ends With, 10 = Does Not End With, 11 = Between Dates, 12 = Not Between Dates, 13 = In, 14 = Not In, 15 = Like, 16 = Not Like, 17 = Since, 18 = In The Last, 19 = Today, 20 = Between Date Times, 21 = Not Between Date Times, 22 = Older Than

DataSource Up

Defines the data source. Each value stands for a specific data source, such as Active Directory or File System.<br><br>0 = Unknown, 1 = Active Directory, 2 = File System, 3 = Azure AD, 4 = Azure AD Sign-In, 5 = Exchange Online, 6 = SharePoint Online, 7 = VMWare, 8 = Active Directory Rollback, 9 = Microsoft Teams, 10 = Cygna Auditor, 11 = OneDrive, 12 = Azure, 14 = Security &amp; Compliance Center, 101 = Active Directory (Blackbird)

DatabaseConnectorDesignation Up

0 = Undefined, 1 = Cygna Auditor Core Configuration, 2 = Cygna Auditor Event Provider, 4 = Cygna Auditor Archive Event Provider

DatabaseConnectorType Up

0 = Undefined, 1 = Cygna Auditor, 2 = PBMS, 3 = Cygna Auditor Archive

DatabaseInfo Up

connectionString (optional)
versionComparison (optional)

DatabaseList Up

databases (optional)

DatabaseSetup Up

credentials (optional)
connectionString (optional)
forest (optional)

DatabaseStatistics Up

adEventCount (optional)
Integer format: int32
fsEventCount (optional)
Integer format: int32
azureAdEventCount (optional)
Integer format: int32
azureLogonEventCount (optional)
Integer format: int32
azureEventCount (optional)
Integer format: int32
securityComplianceCenterEventCount (optional)
Integer format: int32
sharePointOnlineEventCount (optional)
Integer format: int32
microsoftTeamsEventCount (optional)
Integer format: int32
exchangeOnlineEventCount (optional)
Integer format: int32
vMwareEventCount (optional)
Integer format: int32
totalEventCount (optional)
Integer format: int32
databaseSize (optional)
Integer format: int32
eventsPerGb (optional)
Integer format: int32

DatabaseVersion Up

build (optional)
sqlSchema (optional)
appliedTime (optional)
Date format: date-time

DatabaseVersionCompare Up

requiredVersion (optional)
databaseVersion (optional)

DelegatedAccount Up

dn (optional)
displayName (optional)
domain (optional)
objectClass (optional)
sid (optional)
isReadOnly (optional)

DelegatedDatabaseConnector Up

id (optional)
UUID format: uuid
name (optional)
description (optional)
type (optional)
designation (optional)
isEnabled (optional)
connectionString (optional)
isReadOnly (optional)
configuration (optional)
delegatedResources (optional)

DelegatedResourceType Up

0 = Undefined, 1 = Report, 2 = Report Tag, 3 = Report Type, 4 = Scheduled Job, 5 = Scheduled Job Tag, 6 = Scheduled Job Type, 7 = Database Connector

DelegatedResourceX Up

id (optional)
Integer format: int32
type (optional)
resourceId (optional)
accounts (optional)

DelegationAccount Up

The object contains information about the Cygna user and assigned roles.
id (optional)
Integer format: int32
lastLogon (optional)
Date format: date-time
name (optional)
displayName (optional)
identifier (optional)
roles (optional)
type (optional)
enabled (optional)

DeletedObject Up

cn (optional)
objectGuid (optional)
UUID format: uuid
objectSid (optional)
objectClass (optional)
dn (optional)
displayName (optional)
name (optional)
domain (optional)
dnsName (optional)
ldapName (optional)
samAccountName (optional)
userPrincipalName (optional)
presentationName (optional)
description (optional)
msdsPrincipalName (optional)
userAccountControl (optional)
Long format: int64
managerEmail (optional)
pwdLastSet (optional)
Long format: int64
accountExpires (optional)
Long format: int64
attributes (optional)
rawValues (optional)
showInAdvancedViewOnly (optional)
hasInferiors (optional)
lastKnownParent (optional)
deletedOn (optional)
Date format: date-time
distinguishedName (optional)
timeLeftBeforePurge (optional)

DomainConfiguration Up

id (optional)
Integer format: int32
dnsName (optional)
ncName (optional)
netBiosName (optional)
objectGuid (optional)
UUID format: uuid
accountName (optional)
password (optional)
collectionInterval (optional)
Integer format: int32
dcAccountName (optional)
dcPassword (optional)
backupAccountName (optional)
backupPassword (optional)
flags (optional)
Integer format: int32
status (optional)
Integer format: int32
statusDescription (optional)
localDcCollection (optional)
parentDomain (optional)
domainControllers (optional)
agentConfiguration (optional)
enabled (optional)

DomainController Up

domain (optional)
name (optional)
netBiosName (optional)
status (optional)
Integer format: int32
statusMessage (optional)
osVersion (optional)
agentVersion (optional)
upgradeRequired (optional)
id (optional)
Integer format: int32
sid (optional)
lastActive (optional)
Date format: date-time
hasAgent (optional)
enabled (optional)

DomainControllerSearch Up

searchString (optional)
credentials (optional)
excludeConfiguredDomains (optional)
collectorId (optional)
Integer format: int32

DomainProtectionPolicy Up

id (optional)
Integer format: int32
domainId (optional)
Integer format: int32
ruleId (optional)
Integer format: int32
enabled (optional)
actionMask (optional)
Integer format: int32
rule (optional)

DomainSearch Up

searchString (optional)
credentials (optional)
excludeConfiguredDomains (optional)

EventAttributes Up

0 = None, 512 = Special Name, 1024 = R T Special Name

EventInfo Up

name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
memberType (optional)
attributes (optional)
isSpecialName (optional)
addMethod (optional)
removeMethod (optional)
raiseMethod (optional)
isMulticast (optional)
eventHandlerType (optional)

EventsRequest Up

Defines the way returned data should be organized.
clauses (optional)
columns (optional)

Exception Up

targetSite (optional)
stackTrace (optional)
message (optional)
data (optional)
innerException (optional)
helpLink (optional)
source (optional)
hResult (optional)
Integer format: int32

FieldAttributes Up

0 = Private Scope, 1 = Private, 2 = Fam AND Assem, 3 = Assembly, 4 = Family, 5 = Fam OR Assem, 6 = Public, 7 = Field Access Mask, 16 = Static, 32 = Init Only, 64 = Literal, 128 = Not Serialized, 256 = Has FieldRVA, 512 = Special Name, 1024 = R T Special Name, 4096 = Has Field Marshal, 8192 = Pinvoke Impl, 32768 = Has Default, 38144 = Reserved Mask

FieldInfo Up

name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
memberType (optional)
attributes (optional)
fieldType (optional)
isInitOnly (optional)
isLiteral (optional)
isNotSerialized (optional)
isPinvokeImpl (optional)
isSpecialName (optional)
isStatic (optional)
isAssembly (optional)
isFamily (optional)
isFamilyAndAssembly (optional)
isFamilyOrAssembly (optional)
isPrivate (optional)
isPublic (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)
fieldHandle (optional)

FileServer Up

id (optional)
Integer format: int32
serverId (optional)
Integer format: int32
serverName (optional)
serverDnsName (optional)
serverSid (optional)
version (optional)
status (optional)
Integer format: int32
isDriver (optional)
lastUpdate (optional)
Date format: date-time
workItemId (optional)
UUID format: uuid
lastCollection (optional)
Date format: date-time
collectionInterval (optional)
Integer format: int32
alertCount (optional)
Integer format: int32
upgradeRequired (optional)

FileSystemConfiguration Up

credentials (optional)
servers (optional)

FilterAction Up

type (optional)
data (optional)

FilterClause Up

type (optional)
field (optional)
comparison (optional)
values (optional)

FilterReport Up

description (optional)
isAlert (optional)
name (optional)
reportType (optional)
sortAscending (optional)
tags (optional)
id (optional)
UUID format: uuid
enabled (optional)
maxRecordCount (optional)
Integer format: int32
actions (optional)
clauses (optional)
baseQuery (optional)

FilterValue Up

value1 (optional)
value2 (optional)

GenericParameterAttributes Up

0 = None, 1 = Covariant, 2 = Contravariant, 3 = Variance Mask, 4 = Reference Type Constraint, 8 = Not Nullable Value Type Constraint, 16 = Default Constructor Constraint, 28 = Special Constraint Mask

GpoChange Up

name (optional)
attributeName (optional)
state (optional)
explain (optional)
supported (optional)
category (optional)
oldValue (optional)
newValue (optional)

HealthCheck Up

id (optional)
UUID format: uuid
name (optional)
description (optional)
status (optional)
statusDetail (optional)

HealthStatus Up

1 = Success, 2 = Failure, 3 = Unavailable

ICustomAttributeProvider Up

IMatchedElement Up

name (optional)
value (optional)

IUserSearchMatch Up

accountId (optional)
Integer format: int32
presentationName (optional)
origin (optional)
matchedElements (optional)

Identity Up

The object describes Cygna identity and enables you to manage events created by several accounts as events created by a single entity.
id (optional)
Integer format: int32
name (optional)
description (optional)
modifiedOn (optional)
Date format: date-time
accounts (optional)

IdentityAccount Up

The object contains information about the account linked to a Cygna identity.
id (optional)
Integer format: int32
identityId (optional)
Integer format: int32
accountId (optional)
Integer format: int32
source (optional)
state (optional)
displayName (optional)
accountName (optional)
securityIdentifier (optional)

IdentityAccountState Up

Defines the account status in the identity configuration.<br><br>0 = Undefined, 1 = Ready, 2 = Pending Approval, 3 = Disabled, 4 = Delete Pending

IdentityType Up

0 = Local System, 1 = Local Service, 2 = Network Service, 3 = Specific User, 4 = Application Pool Identity

InheritanceType Up

0 = e This Object Only, 1 = e Child Objects Only, 2 = e This Object And Child Objects

IntPtr Up

JobInfoBase Up

type (optional)

LayoutKind Up

0 = Sequential, 2 = Explicit, 3 = Auto

LdapScope Up

0 = This Object Only, 1 = Child Object Only, 2 = This Object And Children

License Up

company (optional)
UUID format: uuid
modules (optional)
generatedOn (optional)
Date format: date-time
maintenanceExpiry (optional)
Date format: date-time
version (optional)
Integer format: int32
configuration (optional)

LicenseDetail Up

id (optional)
UUID format: uuid
name (optional)
count (optional)
Integer format: int32
endDate (optional)
Date format: date-time
licenseType (optional)
Integer format: int32

LogConfiguration Up

level (optional)

LogLevel Up

0 = Undefined, 10 = Verbose, 11 = Debug, 12 = Info, 13 = Warn, 14 = Error, 15 = Fatal, 20 = Audit Verbose, 21 = Audit Debug, 22 = Audit Info, 23 = Audit Warn, 24 = Audit Error, 25 = Audit Fatal, 30 = Audit Exception

LogMessage Up

level (optional)
message (optional)
auditDetails (optional)

LoggingConfiguration Up

isApiLoggingEnabled (optional)
isStatusEventsLoggingEnabled (optional)

ManagedPipelineMode Up

0 = Integrated, 1 = Classic

MemberInfo Up

memberType (optional)
declaringType (optional)
reflectedType (optional)
name (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32

MemberTypes Up

1 = Constructor, 2 = Event, 4 = Field, 8 = Method, 16 = Property, 32 = Type Info, 64 = Custom, 128 = Nested Type, 191 = All

MethodAttributes Up

0 = Reuse Slot, 1 = Private, 2 = Fam AND Assem, 3 = Assembly, 4 = Family, 5 = Fam OR Assem, 6 = Public, 7 = Member Access Mask, 8 = Unmanaged Export, 16 = Static, 32 = Final, 64 = Virtual, 128 = Hide By Sig, 256 = New Slot, 512 = Check Access On Override, 1024 = Abstract, 2048 = Special Name, 4096 = R T Special Name, 8192 = Pinvoke Impl, 16384 = Has Security, 32768 = Require Sec Object, 53248 = Reserved Mask

MethodBase Up

memberType (optional)
name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
attributes (optional)
methodImplementationFlags (optional)
callingConvention (optional)
isAbstract (optional)
isConstructor (optional)
isFinal (optional)
isHideBySig (optional)
isSpecialName (optional)
isStatic (optional)
isVirtual (optional)
isAssembly (optional)
isFamily (optional)
isFamilyAndAssembly (optional)
isFamilyOrAssembly (optional)
isPrivate (optional)
isPublic (optional)
isConstructedGenericMethod (optional)
isGenericMethod (optional)
isGenericMethodDefinition (optional)
containsGenericParameters (optional)
methodHandle (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)

MethodImplAttributes Up

0 = Managed, 1 = Native, 2 = OPTIL, 3 = Code Type Mask, 4 = Unmanaged, 8 = No Inlining, 16 = Forward Ref, 32 = Synchronized, 64 = No Optimization, 128 = Preserve Sig, 256 = Aggressive Inlining, 512 = Aggressive Optimization, 4096 = Internal Call, 65535 = Max Method Impl Val

MethodInfo Up

name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
attributes (optional)
methodImplementationFlags (optional)
callingConvention (optional)
isAbstract (optional)
isConstructor (optional)
isFinal (optional)
isHideBySig (optional)
isSpecialName (optional)
isStatic (optional)
isVirtual (optional)
isAssembly (optional)
isFamily (optional)
isFamilyAndAssembly (optional)
isFamilyOrAssembly (optional)
isPrivate (optional)
isPublic (optional)
isConstructedGenericMethod (optional)
isGenericMethod (optional)
isGenericMethodDefinition (optional)
containsGenericParameters (optional)
methodHandle (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)
memberType (optional)
returnParameter (optional)
returnType (optional)
returnTypeCustomAttributes (optional)

MisfireRule Up

0 = Undefined, 1 = Do Nothing, 2 = Fire And Proceed

Module Up

assembly (optional)
fullyQualifiedName (optional)
name (optional)
mdStreamVersion (optional)
Integer format: int32
moduleVersionId (optional)
UUID format: uuid
scopeName (optional)
moduleHandle (optional)
customAttributes (optional)
metadataToken (optional)
Integer format: int32

ModuleHandle Up

mdStreamVersion (optional)
Integer format: int32

NamingConflictOption Up

0 = Skip the object, 1 = Prompt for new values, 2 = Automatically choose new values, 3 = Max Value

NamingContext Up

0 = Default, 1 = Configuration, 2 = Schema, 3 = RootDSE, 4 = Custom

Object Up

tenantId (optional)
UUID format: uuid
id (optional)
UUID format: uuid
name (optional)
type (optional)
createdOn (optional)
Date format: date-time
deletedOn (optional)
Date format: date-time
userPrincipalName (optional)

ObjectClassType Up

0 = Undefined, 1 = User, 2 = Group

ObjectSnapshot Up

id (optional)
Integer format: int32
objectGuid (optional)
UUID format: uuid
domain (optional)
encodedAttributeCount (optional)
Integer format: int32
encodedData (optional)
attributes (optional)
eventTime (optional)
Date format: date-time
samType (optional)
Integer format: int32
adObject (optional)
storageType (optional)
Integer format: int32

Option Up

0 = Starts With, 1 = Ends With, 2 = Contains

Order Up

0 = Asc, 1 = Desc

ParameterAttributes Up

0 = None, 1 = In, 2 = Out, 4 = Lcid, 8 = Retval, 16 = Optional, 4096 = Has Default, 8192 = Has Field Marshal, 16384 = Reserved3, 32768 = Reserved4, 61440 = Reserved Mask

ParameterInfo Up

attributes (optional)
member (optional)
name (optional)
parameterType (optional)
position (optional)
Integer format: int32
isIn (optional)
isLcid (optional)
isOptional (optional)
isOut (optional)
isRetval (optional)
defaultValue (optional)
rawDefaultValue (optional)
hasDefaultValue (optional)
customAttributes (optional)
metadataToken (optional)
Integer format: int32

Permission Up

A permission record.
id (optional)
UUID format: uuid
code (optional)
Integer format: int32
category (optional)
displayPermission (optional)
name (optional)
shortName (optional)
description (optional)
type (optional)
configuration (optional)
visible (optional)

PostRunActionBase Up

type (optional)
isEnabled (optional)

PostRunActionType Up

0 = Undefined, 1 = Email Report, 2 = Archive Report, 3 = Export Report, 4 = SMS

ProductInformation Up

company (optional)
copyright (optional)
productName (optional)

PropertyAttributes Up

0 = None, 512 = Special Name, 1024 = R T Special Name, 4096 = Has Default, 8192 = Reserved2, 16384 = Reserved3, 32768 = Reserved4, 62464 = Reserved Mask

PropertyInfo Up

name (optional)
declaringType (optional)
reflectedType (optional)
module (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
memberType (optional)
propertyType (optional)
attributes (optional)
isSpecialName (optional)
canRead (optional)
canWrite (optional)
getMethod (optional)
setMethod (optional)

ProtectedAccount Up

id (optional)
Integer format: int32
dn (optional)
displayName (optional)
domain (optional)
sid (optional)
excluded (optional)

ProtectedObject Up

id (optional)
Integer format: int32
dn (optional)
objectClass (optional)
displayName (optional)
guid (optional)
UUID format: uuid
inheritance (optional)
excluded (optional)
domainId (optional)
Integer format: int32

ProtectionFilter Up

id (optional)
Integer format: int32
eventMask (optional)
Integer format: int32
accounts (optional)
attributes (optional)
objects (optional)
objectClasses (optional)

ProtectionRule Up

id (optional)
Integer format: int32
name (optional)
description (optional)
defaultAllow (optional)
builtIn (optional)
filters (optional)

ProxyConfigurationWeb Up

isProxyToBeUsed (optional)
server (optional)
port (optional)
Integer format: int32
isSpecificUserToBeUsed (optional)
userCredentials (optional)
adminCredentials (optional)

RecoveryRequest Up

objectId (optional)
UUID format: uuid
domainId (optional)
Integer format: int32
clearUserMustChangePasswordFlag (optional)
newPassword (optional)
containerOption (optional)
namingConflictOption (optional)
forceReplication (optional)
snapshotId (optional)
Integer format: int32
credentials (optional)
storageType (optional)
objectClass (optional)
enableAccount (optional)
domainController (optional)

RemoteLoggerConfigurationInfoBase Up

type (optional)

RemoteLoggerConfigurationX Up

type (optional)
configInfo (optional)

RemoteLoggerType Up

0 = Undefined, 1 = Splunk, 2 = Syslog

ReportAccess Up

id (optional)
Integer format: int32
reportId (optional)
UUID format: uuid
createdByUserType (optional)
createdByUserId (optional)
createdByUserName (optional)
createdOn (optional)
Date format: date-time
modifiedByUserType (optional)
modifiedByUserId (optional)
modifiedByUserName (optional)
modifiedOn (optional)
Date format: date-time
isPrivate (optional)

ReportRunnerJobInfo Up

type (optional)
runInfo (optional)
postRunActions (optional)

ReportStylingX Up

elementName (optional)
textColour (optional)
isBold (optional)
isItalic (optional)
mappings (optional)
map[String, Integer] format: int32

ReportWeb Up

id (optional)
UUID format: uuid
name (optional)
description (optional)
filter (optional)
type (optional)
tags (optional)
actions (optional)
eventColumns (optional)
access (optional)
delegatedResources (optional)
isReadOnly (optional)

RequestLock Up

enabled (optional)
maxLocks (optional)
Integer format: int32

Role Up

The role object contains delegation settings including a role name and included permissions.
id (optional)
UUID format: uuid
name (optional)
description (optional)
type (optional)
Integer format: int32
permissions (optional)

RunReportInfo Up

id (optional)
UUID format: uuid
name (optional)
description (optional)
request (optional)

RuntimeFieldHandle Up

value (optional)

RuntimeMethodHandle Up

value (optional)

RuntimeTypeHandle Up

value (optional)

ScheduledJobState Up

0 = Undefined, 1 = Ready, 2 = Currently Active, 3 = Disabled, 4 = Delete Pending

ScheduledJobType Up

0 = Undefined, 2 = Report Runner, 3 = System Summary, 4 = Identity Searcher, 5 = Data Purge, 6 = WorkItem

ScheduledJobWeb Up

id (optional)
UUID format: uuid
name (optional)
description (optional)
type (optional)
jobInfo (optional)
timingInfo (optional)
modifiedOn (optional)
Date format: date-time
lastRunOn (optional)
Date format: date-time
nextRunOn (optional)
Date format: date-time
state (optional)
isEnabled (optional)

ScheduledTimingType Up

0 = Undefined, 1 = Custom Interval, 2 = Simple Repeat, 3 = Explicit Cron

SchedulerConfiguration Up

directive (optional)
status (optional)

SchedulerControlDirective Up

0 = Undefined, 1 = No Action, 2 = Pause All, 3 = Resume All, 11 = Audit Per ScheduledJobs table

SchedulerStatus Up

0 = Undefined, 1 = Active, 2 = Paused

Scope Up

The object limits the role assignment to certain settings.
id (optional)
Integer format: int32
accountRoleId (optional)
Integer format: int32
displayName (optional)
configurationObject (optional)
type (optional)
Integer format: int32

SearchObjectType Up

1 = Local Users, 2 = Local Groups, 4 = Domain Users, 8 = Domain Groups, 16 = Computers, 32 = Domain Controllers, 64 = Exchange Servers, 128 = Sql Servers, 256 = Containers, 512 = Organizational Units

SearchType Up

0 = None, 1 = Active Directory, 2 = Azure, 3 = O365, 4 = Teams, 5 = V M Ware, 6 = AzureARM

SecurityIdentifier Up

binaryLength (optional)
Integer format: int32
accountDomainSid (optional)
value (optional)

SecurityRuleSet Up

0 = None, 1 = Level1, 2 = Level2

ServerList Up

servers (optional)

ServiceCommand Up

targetGuid (optional)
UUID format: uuid
dateTime (optional)
commandId (optional)
commandData (optional)

ServiceCommandId Up

0 = Undefined, 1 = Collect, 2 = Status, 3 = Stop, 4 = Restart

ServiceConfigurationWeb Up

isRunAsLocalSystem (optional)
userCredentials (optional)
adminCredentials (optional)
serviceSocket (optional)

ServiceControllerStatus Up

1 = Stopped, 2 = Start Pending, 3 = Stop Pending, 4 = Running, 5 = Continue Pending, 6 = Pause Pending, 7 = Paused

SmtpConfiguration Up

server (optional)
port (optional)
Integer format: int32
userCredentials (optional)
fromName (optional)
fromAddress (optional)
toAddress (optional)
isSslToBeUsed (optional)

SocketConfiguration Up

type (optional)
port (optional)
Integer format: int32
serverAddress (optional)
encrypted (optional)

SocketType Up

0 = 0, 1 = Stream, 2 = Dgram, 3 = Raw, 4 = Rdm

Source Up

Defines the data source the account authenticates in.<br><br>0 = Undefined, 1 = Active Directory, 2 = File System, 3 = Azure AD, 7 = vCenter

State Up

0 = Escaped, 1 = Not Escaped, 2 = Start Of Token, 3 = End Of Line, 4 = 4

StorageType Up

0 = Unknown, 1 = Active Directory, 2 = Group Policy Container, 3 = Max Value

StructLayoutAttribute Up

typeId (optional)
value (optional)

SysConfigItem Up

0 = License, 1 = Proxy, 2 = Cygna Auditor Service, 3 = SMTP, 4 = Scheduler

SystemConfiguration Up

id (optional)
UUID format: uuid
data (optional)
adminCredentials (optional)

SystemConfigurationBase Up

SystemInformation Up

productVersion (optional)
adDriverVersion (optional)
rsatExtensionVersion (optional)
fsDriverVersion (optional)
buildDate (optional)
licensedTo (optional)
maintenanceExpiry (optional)
machineName (optional)
operatingSystem (optional)
processorCount (optional)
databaseServer (optional)
databaseName (optional)

SystemStatus Up

id (optional)
Integer format: int32
configurationId (optional)
Integer format: int32
type (optional)
name (optional)
parentItem (optional)
statusCode (optional)
Integer format: int32
statusCodeDisplay (optional)
statusMessage (optional)
errorCode (optional)
Integer format: int32
interval (optional)
Integer format: int32
lastActiveTime (optional)
Date format: date-time
lastEventTime (optional)
Date format: date-time
enabled (optional)
isAgent (optional)
appVersion (optional)
isInactive (optional)
isStale (optional)
applicationGuid (optional)
UUID format: uuid
statusId (optional)
Integer format: int32
statusCodeDisplayEnhanced (optional)

Tag Up

id (optional)
UUID format: uuid
name (optional)
origin (optional)

TagContext Up

0 = Reports, 1 = Alerts, 1111 = All

TagOrigin Up

0 = Built In, 1 = User, 1111 = All

Target Up

id (optional)
Integer format: int32
status (optional)
Integer format: int32
config (optional)
lastCollection (optional)
Date format: date-time
lastActive (optional)
Date format: date-time
collectionInterval (optional)
Integer format: int32
tenantCode (optional)
displayName (optional)
enabled (optional)

TargetConfig Up

tenantActivityCollection (optional)
collectAllSubscriptions (optional)
collectResourceData (optional)
dataCollectionTimeout (optional)
Integer format: int32
activityLogCollectionTimeout (optional)
Integer format: int32
activityLogCollectionSkew (optional)
Integer format: int32
parallelResourceResolutionRequests (optional)
Integer format: int32
resolveConfigurationObjects (optional)
initialCollectionOffset (optional)
Integer format: int32
ignoredStatuses (optional)
ignoredItems (optional)
ignoredOperations (optional)
subscriptions (optional)
tenantResourceTypes (optional)
subscriptionResourceTypes (optional)

TeamsChannel Up

id (optional)
Integer format: int32
channelName (optional)
channelType (optional)
channelGuid (optional)
teamGuid (optional)
mailboxUpn (optional)
teamName (optional)

Tenant Up

id (optional)
Integer format: int32
tenantId (optional)
UUID format: uuid
displayName (optional)
enabled (optional)
interval (optional)
Integer format: int32
tenantCode (optional)

TenantPrecursor Up

authorizationUrl (optional)
state (optional)

TenantState Up

state (optional)

Timeframe Up

startAt (optional)
Date format: date-time
endAt (optional)
Date format: date-time

TimingInfoBase Up

type (optional)
effectiveDates (optional)
misfireRule (optional)
priority (optional)

TimingPriority Up

No other &quot;Schedule&quot; should be given a TimingPriority of SchedulerOverseer or higher<br><br>0 = Undefined, 10 = Low, 20 = Medium, 30 = Default, 40 = High, 50 = Priority, 60 = Critical, 100 = Scheduler Overseer

Type Up

name (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
isInterface (optional)
memberType (optional)
namespace (optional)
assemblyQualifiedName (optional)
fullName (optional)
assembly (optional)
module (optional)
isNested (optional)
declaringType (optional)
declaringMethod (optional)
reflectedType (optional)
underlyingSystemType (optional)
isTypeDefinition (optional)
isArray (optional)
isByRef (optional)
isPointer (optional)
isConstructedGenericType (optional)
isGenericParameter (optional)
isGenericTypeParameter (optional)
isGenericMethodParameter (optional)
isGenericType (optional)
isGenericTypeDefinition (optional)
isSZArray (optional)
isVariableBoundArray (optional)
isByRefLike (optional)
hasElementType (optional)
genericTypeArguments (optional)
genericParameterPosition (optional)
Integer format: int32
genericParameterAttributes (optional)
attributes (optional)
isAbstract (optional)
isImport (optional)
isSealed (optional)
isSpecialName (optional)
isClass (optional)
isNestedAssembly (optional)
isNestedFamANDAssem (optional)
isNestedFamily (optional)
isNestedFamORAssem (optional)
isNestedPrivate (optional)
isNestedPublic (optional)
isNotPublic (optional)
isPublic (optional)
isAutoLayout (optional)
isExplicitLayout (optional)
isLayoutSequential (optional)
isAnsiClass (optional)
isAutoClass (optional)
isUnicodeClass (optional)
isCOMObject (optional)
isContextful (optional)
isEnum (optional)
isMarshalByRef (optional)
isPrimitive (optional)
isValueType (optional)
isSignatureType (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)
structLayoutAttribute (optional)
typeInitializer (optional)
typeHandle (optional)
guid (optional)
UUID format: uuid
baseType (optional)
isSerializable (optional)
containsGenericParameters (optional)
isVisible (optional)

TypeAttributes Up

0 = Class, 1 = Public, 2 = Nested Public, 3 = Nested Private, 4 = Nested Family, 5 = Nested Assembly, 6 = Nested Fam AND Assem, 7 = Visibility Mask, 8 = Sequential Layout, 16 = Explicit Layout, 24 = Layout Mask, 32 = Interface, 128 = Abstract, 256 = Sealed, 1024 = Special Name, 2048 = R T Special Name, 4096 = Import, 8192 = Serializable, 16384 = Windows Runtime, 65536 = Unicode Class, 131072 = Auto Class, 196608 = String Format Mask, 262144 = Has Security, 264192 = Reserved Mask, 1048576 = Before Field Init, 12582912 = Custom Format Mask

TypeInfo Up

name (optional)
customAttributes (optional)
isCollectible (optional)
metadataToken (optional)
Integer format: int32
isInterface (optional)
memberType (optional)
namespace (optional)
assemblyQualifiedName (optional)
fullName (optional)
assembly (optional)
module (optional)
isNested (optional)
declaringType (optional)
declaringMethod (optional)
reflectedType (optional)
underlyingSystemType (optional)
isTypeDefinition (optional)
isArray (optional)
isByRef (optional)
isPointer (optional)
isConstructedGenericType (optional)
isGenericParameter (optional)
isGenericTypeParameter (optional)
isGenericMethodParameter (optional)
isGenericType (optional)
isGenericTypeDefinition (optional)
isSZArray (optional)
isVariableBoundArray (optional)
isByRefLike (optional)
hasElementType (optional)
genericTypeArguments (optional)
genericParameterPosition (optional)
Integer format: int32
genericParameterAttributes (optional)
attributes (optional)
isAbstract (optional)
isImport (optional)
isSealed (optional)
isSpecialName (optional)
isClass (optional)
isNestedAssembly (optional)
isNestedFamANDAssem (optional)
isNestedFamily (optional)
isNestedFamORAssem (optional)
isNestedPrivate (optional)
isNestedPublic (optional)
isNotPublic (optional)
isPublic (optional)
isAutoLayout (optional)
isExplicitLayout (optional)
isLayoutSequential (optional)
isAnsiClass (optional)
isAutoClass (optional)
isUnicodeClass (optional)
isCOMObject (optional)
isContextful (optional)
isEnum (optional)
isMarshalByRef (optional)
isPrimitive (optional)
isValueType (optional)
isSignatureType (optional)
isSecurityCritical (optional)
isSecuritySafeCritical (optional)
isSecurityTransparent (optional)
structLayoutAttribute (optional)
typeInitializer (optional)
typeHandle (optional)
guid (optional)
UUID format: uuid
baseType (optional)
isSerializable (optional)
containsGenericParameters (optional)
isVisible (optional)
genericTypeParameters (optional)
declaredConstructors (optional)
declaredEvents (optional)
declaredFields (optional)
declaredMembers (optional)
declaredMethods (optional)
declaredNestedTypes (optional)
declaredProperties (optional)
implementedInterfaces (optional)

UserConfiguration Up

applicationTheme (optional)
applicationSettings (optional)
consoleOptions (optional)

UserIdType Up

0 = Undefined, 1 = Security Identifier, 2 = Email, 3 = Cygna Auditor (Internal)

UserProfile Up

user (optional)
password (optional)
displayName (optional)
userDomain (optional)