--- title: Tenable Identity Exposure slug: connectors/tenable-identity-exposure docTags: createdAt: 2026-06-09T16:30:16.176Z --- This is a connector for Tenable Identity Exposure Integration. It provides real-time security monitoring for Microsoft Active Directory (AD) infrastructures. ## Prerequisites The Tenable Identity Exposure asset requires a `URL` and an `API Key` to interact with the API. ## Capabilities This connector provides the following capabilities: - Create attack type options related to a profile and attack type - Create dashboard instance - Create directory instance - Create email-notifier instance - Create infrastructure instance - Create role instance - Create syslog instance - Create user instance - Creates a new role from another one - Delete dashboard instance with it's associated widgets - Delete directory instance - Delete email-notifier instance - Delete infrastructure instance - Delete role instance - Delete syslog instance *... and so on* # Configurations ## API Key Authentication Authenticates using an API Key ### Configuration Parameters | **Parameter** | **Description** | **Type** | **Required** | | ------------- | ---------------------------------- | -------- | ------------ | | url | A URL to the target host. | string | Required | | x-api-key | API key | string | Required | | verify\_ssl | Verify SSL certificate | boolean | Optional | | http\_proxy | A proxy to route requests through. | string | Optional | # Actions ## Create Attack Type Options Related To A Profile Create attack type options related to a profile and attack type. ### Endpoint - **URL:** `api/profiles/{{profileId}}/attack-types/{{attackTypeId}}/attack-type-options` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------------ | -------- | ------------ | ------------------------------------------------------------------------- | | `path_parameters.profileId` | string | Required | Parameters for the Create Attack Type Options Related To A Profile action | | `path_parameters.attackTypeId` | string | Required | Parameters for the Create Attack Type Options Related To A Profile action | | `codename` | string | Optional | Name of the resource | | `directoryId` | number | Optional | Unique identifier | | `value` | string | Optional | Value for the parameter | | `valueType` | string | Optional | Type of the resource | ### Input Example `{"json_body":{"codename":"string","directoryId":0,"value":"1","valueType":"string"},"path_parameters":{"profileId":"0","attackTypeId":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"codename":"string","profileId":0,"attackTypeId":0,"directoryId":0,"value":"string","valueType":"string","name":"string","description":"string","translations":[],"staged":true}]}` ## Create Dashboard Instance Create dashboard instance. ### Endpoint - **URL:** `api/dashboards` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | --------------------------------------- | | `name` | string | Optional | Name of the resource | | `order` | number | Optional | Parameter for Create Dashboard Instance | ### Input Example `{"json_body":{"name":"string","order":0}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `name` | string | Name of the resource | | `order` | number | Output field: order | | `userId` | number | Unique identifier | ### Output Example `{"status_code":201,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"name":"string","order":0,"userId":0}}` ## Create Directory Instance Create directory instance. ### Endpoint - **URL:** `api/directories` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------- | -------- | ------------ | --------------------------------------- | | `infrastructureId` | number | Optional | Unique identifier | | `name` | string | Optional | Name of the resource | | `ip` | string | Optional | Parameter for Create Directory Instance | | `type` | string | Optional | Type of the resource | | `ldapPort` | number | Optional | Parameter for Create Directory Instance | | `globalCatalogPort` | number | Optional | Parameter for Create Directory Instance | | `smbPort` | number | Optional | Parameter for Create Directory Instance | | `dns` | string | Optional | Parameter for Create Directory Instance | | `sensitiveDataCollectionIsEnabled` | boolean | Optional | Response data | | `relayId` | string | Optional | Unique identifier | ### Input Example `{"json_body":{"infrastructureId":0,"name":"string","ip":"string","type":"ADDS","ldapPort":0,"globalCatalogPort":0,"smbPort":0,"dns":"string","sensitiveDataCollectionIsEnabled":true,"relayId":"string"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":201,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"name":"string","ip":"string","type":"ADDS","ldapPort":0,"globalCatalogPort":0,"smbPort":0,"dns":"string","infrastructureId":0,"ldapCrawlingStatus":"none","sysvolCrawlingStatus":"none","honeyAccountAdObjectId":0,"honeyAccountDistinguishedName":"string","honeyAccountConfigurationStatus":"none","sensitiveDataCollectionIsEnabled":...` ## Create Email Notifier Instance Create email-notifier instance. ### Endpoint - **URL:** `api/email-notifiers` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------------- | -------- | ------------ | -------------------------------------------- | | `checkers` | array | Optional | Parameter for Create Email Notifier Instance | | `profiles` | array | Optional | Parameter for Create Email Notifier Instance | | `attackTypes` | array | Optional | Type of the resource | | `address` | string | Optional | Parameter for Create Email Notifier Instance | | `criticityThreshold` | number | Optional | Parameter for Create Email Notifier Instance | | `directories` | array | Optional | Parameter for Create Email Notifier Instance | | `description` | string | Optional | Parameter for Create Email Notifier Instance | | `shouldNotifyOnInitialFullSecurityCheck` | boolean | Optional | Parameter for Create Email Notifier Instance | | `inputType` | string | Optional | Input data for the action | ### Input Example `{"json_body":{"checkers":[0],"profiles":[0],"attackTypes":[0],"address":"string","criticityThreshold":0,"directories":[0],"description":"string","shouldNotifyOnInitialFullSecurityCheck":true,"inputType":"deviances"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":201,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"address":"string","criticityThreshold":0,"directories":[],"description":"string","checkers":[],"attackTypes":[],"profiles":[],"shouldNotifyOnInitialFullSecurityCheck":true}]}` ## Create Infrastructure Instance Create infrastructure instance. ### Endpoint - **URL:** `api/infrastructures` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | -------------------------------------------- | | `name` | string | Optional | Name of the resource | | `login` | string | Optional | Parameter for Create Infrastructure Instance | | `password` | string | Optional | Parameter for Create Infrastructure Instance | ### Input Example `{"json_body":{"name":"string","login":"string","password":"string"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":201,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"name":"string","login":"string","directories":[]}]}` ## Create Role Instance Create role instance. ### Endpoint - **URL:** `api/roles` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ---------------------------------- | | `name` | string | Optional | Name of the resource | | `description` | string | Optional | Parameter for Create Role Instance | ### Input Example `{"json_body":{"name":"string","description":"string"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":201,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"name":"string","description":"string","permissions":[]}]}` ## Create Syslog Instance Create syslog instance. ### Endpoint - **URL:** `api/syslogs` - **Method:** `POST` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":201,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"ip":"string","port":0,"protocol":"UDP","tls":true,"criticityThreshold":0,"description":"string","filterExpression":{},"inputType":"deviances","directories":[],"checkers":[],"attackTypes":[],"profiles":[],"shouldNotifyOnInitialFullSecurityCheck":true}]}` ## Create User Instance Create user instance. ### Endpoint - **URL:** `api/users` - **Method:** `POST` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":201,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"surname":"string","name":"string","email":"string","lockedOut":true,"department":"string","biography":"string","active":true,"picture":[],"roles":[],"identifier":"string","provider":"tenable","eulaVersion":0}]}` ## Creates A New Role From Another One Creates a new role from another one. ### Endpoint - **URL:** `api/roles/from/{{fromId}}` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------ | -------- | ------------ | ------------------------------------------------------------- | | `path_parameters.fromId` | string | Required | Parameters for the Creates A New Role From Another One action | | `name` | string | Optional | Name of the resource | ### Input Example `{"json_body":{"name":"string"},"path_parameters":{"fromId":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------ | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `name` | string | Name of the resource | | `description` | string | Output field: description | | `permissions` | array | Output field: permissions | | `permissions.entityName` | string | Name of the resource | | `permissions.action` | string | Output field: permissions.action | | `permissions.entityIds` | array | Unique identifier | | `permissions.dynamicId` | string | Unique identifier | ### Output Example `{"status_code":204,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"name":"string","description":"string","permissions":[{}]}}` ## Delete Dashboard Instance With Associated Widgets Delete dashboard instance with it's associated widgets. ### Endpoint - **URL:** `api/dashboards/{{id}}` - **Method:** `DELETE` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | --------------------------------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Delete Dashboard Instance With Associated Widgets action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":204,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Delete Directory Instance Delete directory instance. ### Endpoint - **URL:** `api/infrastructures/{{infrastructureId}}/directories/{{id}}` - **Method:** `DELETE` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------- | -------- | ------------ | --------------------------------------------------- | | `path_parameters.infrastructureId` | string | Required | Parameters for the Delete Directory Instance action | | `path_parameters.id` | string | Required | Parameters for the Delete Directory Instance action | ### Input Example `{"path_parameters":{"infrastructureId":"0","id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":204,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Delete Email Notifier Instance Delete email-notifier instance. ### Endpoint - **URL:** `api/email-notifiers/{{id}}` - **Method:** `DELETE` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | -------------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Delete Email Notifier Instance action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":204,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Delete Infrastructure Instance Delete infrastructure instance. ### Endpoint - **URL:** `api/infrastructures/{{id}}` - **Method:** `DELETE` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | -------------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Delete Infrastructure Instance action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":204,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Delete Role Instance Delete role instance. ### Endpoint - **URL:** `api/roles/{{id}}` - **Method:** `DELETE` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ---------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Delete Role Instance action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Delete Syslog Instance Delete syslog instance. ### Endpoint - **URL:** `api/syslogs/{{id}}` - **Method:** `DELETE` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ------------------------------------------------ | | `path_parameters.id` | string | Required | Parameters for the Delete Syslog Instance action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":204,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Delete User Instance Delete user instance. ### Endpoint - **URL:** `api/users/{{id}}` - **Method:** `DELETE` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ---------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Delete User Instance action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Generates SAML certificate Generates SAML certificate. ### Endpoint - **URL:** `api/saml-configuration/generate-certificate` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | ----------------------- | -------- | ----------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `encryptionCertificate` | string | Output field: encryptionCertificate | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"encryptionCertificate":"string"}}` ## Get A User's Information Get a user's information. ### Endpoint - **URL:** `api/users/whoami` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | ------------------------------ | -------- | -------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `surname` | string | Name of the resource | | `name` | string | Name of the resource | | `email` | string | Output field: email | | `provider` | string | Unique identifier | | `lockedOut` | boolean | Output field: lockedOut | | `department` | string | Output field: department | | `roles` | array | Output field: roles | | `roles.id` | number | Unique identifier | | `roles.name` | string | Name of the resource | | `roles.description` | string | Output field: roles.description | | `roles.permissions` | array | Output field: roles.permissions | | `roles.permissions.entityName` | string | Name of the resource | | `roles.permissions.action` | string | Output field: roles.permissions.action | | `roles.permissions.entityIds` | array | Unique identifier | | `roles.permissions.dynamicId` | string | Unique identifier | | `biography` | string | Output field: biography | | `active` | boolean | Output field: active | | `picture` | array | Output field: picture | | `identifier` | string | Unique identifier | | `eulaVersion` | number | Output field: eulaVersion | | `internal` | boolean | Output field: internal | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"surname":"string","name":"string","email":"string","provider":"string","lockedOut":true,"department":"string","roles":[{}],"biography":"string","active":true,"picture":[0],"identifier":"string","eulaVersion":0,"internal":true}}` ## Get AD-Object Deviance History Instance By ID Get ad-object-deviance-history instance by ID. ### Endpoint - **URL:** `api/infrastructures/{{infrastructureId}}/directories/{{directoryId}}/deviances/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------- | -------- | ------------ | ----------------------------------------------------------------------- | | `path_parameters.infrastructureId` | string | Required | Parameters for the Get AD-Object Deviance History Instance By ID action | | `path_parameters.directoryId` | string | Required | Parameters for the Get AD-Object Deviance History Instance By ID action | | `path_parameters.id` | string | Required | Parameters for the Get AD-Object Deviance History Instance By ID action | ### Input Example `{"path_parameters":{"infrastructureId":"0","directoryId":"0","id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------------------ | -------- | -------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `directoryId` | number | Unique identifier | | `checkerId` | number | Unique identifier | | `profileId` | number | Unique identifier | | `adObjectId` | number | Unique identifier | | `reasonId` | number | Unique identifier | | `resolvedAt` | string | Output field: resolvedAt | | `eventDate` | string | Date value | | `ignoreUntil` | string | Output field: ignoreUntil | | `devianceProviderId` | string | Unique identifier | | `attributes` | array | Output field: attributes | | `attributes.name` | string | Name of the resource | | `attributes.value` | string | Value for the parameter | | `description` | object | Output field: description | | `description.template` | string | Output field: description.template | | `description.replacements` | array | Output field: description.replacements | | `description.replacements.name` | string | Name of the resource | | `description.replacements.valueType` | string | Type of the resource | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"directoryId":0,"checkerId":0,"profileId":0,"adObjectId":0,"reasonId":0,"resolvedAt":"2023-08-01T05:47:38.860Z","eventDate":"2023-08-01T05:47:38.860Z","ignoreUntil":"2023-08-01T05:47:38.860Z","devianceProviderId":"string","attributes":[{}],"description":{"template":"string","replacements":[]}}}` ## Get AD-Object Instance By ID Get ad-object instance by ID. ### Endpoint - **URL:** `api/infrastructures/{{infrastructureId}}/directories/{{directoryId}}/ad-objects/{{id})` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------- | -------- | ------------ | ------------------------------------------------------ | | `path_parameters.directoryId` | string | Required | Parameters for the Get AD-Object Instance By ID action | | `path_parameters.infrastructureId` | string | Required | Parameters for the Get AD-Object Instance By ID action | | `path_parameters.id` | string | Required | Parameters for the Get AD-Object Instance By ID action | ### Input Example `{"path_parameters":{"directoryId":"0","infrastructureId":"0","id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `directoryId` | number | Unique identifier | | `objectId` | string | Unique identifier | | `type` | string | Type of the resource | | `objectAttributes` | array | Output field: objectAttributes | | `objectAttributes.name` | string | Name of the resource | | `objectAttributes.value` | string | Value for the parameter | | `objectAttributes.valueType` | string | Type of the resource | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"directoryId":0,"objectId":"string","type":"LDAP","objectAttributes":[{}]}}` ## Get Alert Instance By ID Get alert instance by ID. ### Endpoint - **URL:** `api/alerts/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | -------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Get Alert Instance By ID action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------ | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `devianceId` | number | Unique identifier | | `archived` | boolean | Output field: archived | | `read` | boolean | Output field: read | | `date` | string | Date value | | `directoryId` | number | Unique identifier | | `infrastructureId` | number | Unique identifier | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"devianceId":0,"archived":false,"read":false,"date":"2023-08-01T05:47:38.860Z","directoryId":0,"infrastructureId":0}}` ## Get All Attack Type Options Related To A Profile Get all the attack type options related to a profile and attack type. ### Endpoint - **URL:** `api/profiles/{{profileId}}/attack-types/{{attackTypeId}}/attack-type-options` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------------ | -------- | ------------ | -------------------------------------------------------------------------- | | `path_parameters.profileId` | string | Required | Parameters for the Get All Attack Type Options Related To A Profile action | | `path_parameters.attackTypeId` | string | Required | Parameters for the Get All Attack Type Options Related To A Profile action | | `parameters.staged` | string | Optional | Parameters for the Get All Attack Type Options Related To A Profile action | ### Input Example `{"parameters":{"staged":"0"},"path_parameters":{"profileId":"0","attackTypeId":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"codename":"string","profileId":0,"attackTypeId":0,"directoryId":0,"value":"string","valueType":"string","name":"string","description":"string","translations":[],"staged":true}]}` ## Get All Attacks Get all attacks. ### Endpoint - **URL:** `api/profiles/{{profileId}}/attacks` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | --------------------------- | -------- | ------------ | ----------------------------------------- | | `path_parameters.profileId` | string | Required | Parameters for the Get All Attacks action | | `parameters.attackTypeIds` | array | Optional | Parameters for the Get All Attacks action | | `parameters.dateEnd` | string | Optional | Parameters for the Get All Attacks action | | `parameters.dateStart` | string | Optional | Parameters for the Get All Attacks action | | `parameters.includeClosed` | string | Optional | Parameters for the Get All Attacks action | | `parameters.limit` | string | Optional | Parameters for the Get All Attacks action | | `parameters.order` | string | Optional | Parameters for the Get All Attacks action | | `parameters.resourceType` | string | Required | Parameters for the Get All Attacks action | | `parameters.resourceValue` | string | Required | Parameters for the Get All Attacks action | | `parameters.search` | string | Optional | Parameters for the Get All Attacks action | ### Input Example `{"parameters":{"attackTypeIds":["a","b","c"],"dateEnd":"2023-08-01T05:47:38.860Z","dateStart":"2023-09-01T05:47:38.860Z","includeClosed":"true","limit":"string","order":"desc","resourceType":"infrastructure","resourceValue":"string","search":"string"},"path_parameters":{"profileId":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"directoryId":0,"attackTypeId":0,"dc":"string","date":"2023-08-01T05:47:38.860Z","vector":{},"source":{},"destination":{},"isClosed":true}]}` ## Get All Deviances By Checker Get all deviances by checker. ### Endpoint - **URL:** `api/profiles/{{profileId}}/checkers/{{checkerId}}/deviances` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------------- | -------- | ------------ | ------------------------------------------------------ | | `path_parameters.profileId` | string | Required | Parameters for the Get All Deviances By Checker action | | `path_parameters.checkerId` | string | Required | Parameters for the Get All Deviances By Checker action | | `parameters.perPage` | string | Optional | Parameters for the Get All Deviances By Checker action | | `parameters.page` | string | Optional | Parameters for the Get All Deviances By Checker action | | `parameters.batchSize` | string | Optional | Parameters for the Get All Deviances By Checker action | | `parameters.lastIdentifierSeen` | string | Optional | Parameters for the Get All Deviances By Checker action | | `expression` | object | Optional | Parameter for Get All Deviances By Checker | ### Input Example `{"parameters":{"perPage":"0","page":"0","batchSize":"0","lastIdentifierSeen":"0"},"path_parameters":{"profileId":"0","checkerId":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"directoryId":0,"checkerId":0,"profileId":0,"adObjectId":0,"reasonId":0,"resolvedAt":"2023-08-01T05:47:38.860Z","eventDate":"2023-08-01T05:47:38.860Z","ignoreUntil":"2023-08-01T05:47:38.860Z","devianceProviderId":"string","attributes":[],"description":{}}]}` ## Get All Deviances By EventID Get all deviances by eventID. ### Endpoint - **URL:** `api/profiles/{{profileId}}/infrastructures/{{infrastructureId}}/directories/{{directoryId}}/events/{{eventId}}/deviances` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------- | -------- | ------------ | ------------------------------------------------------ | | `path_parameters.profileId` | string | Required | Parameters for the Get All Deviances By EventID action | | `path_parameters.infrastructureId` | string | Required | Parameters for the Get All Deviances By EventID action | | `path_parameters.directoryId` | string | Required | Parameters for the Get All Deviances By EventID action | | `path_parameters.eventId` | string | Required | Parameters for the Get All Deviances By EventID action | | `parameters.perPage` | string | Optional | Parameters for the Get All Deviances By EventID action | | `parameters.page` | string | Optional | Parameters for the Get All Deviances By EventID action | | `checkers` | array | Optional | Parameter for Get All Deviances By EventID | | `reasons` | array | Optional | Response reason phrase | ### Input Example `{"parameters":{"perPage":"0","page":"0"},"json_body":{"checkers":[1,2,3],"reasons":[1,2,3]},"path_parameters":{"profileId":"0","infrastructureId":"0","directoryId":"0","eventId":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"directoryId":0,"checkerId":0,"profileId":0,"adObjectId":0,"reasonId":0,"resolvedAt":"2023-08-04T04:34:23.521Z","eventDate":"2023-08-04T04:34:23.521Z","ignoreUntil":"2023-08-04T04:34:23.521Z","devianceProviderId":"string","attributes":[],"description":{}}]}` ## Get All Deviances By Single Directory And Checker Get all deviances related to a single directory and checker. ### Endpoint - **URL:** `api/profiles/{{profileId}}/infrastructures/{{infrastructureId}}/directories/{{directoryId}}/checkers/{{checkerId}}/deviances` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------- | -------- | ------------ | --------------------------------------------------------------------------- | | `path_parameters.profileId` | string | Required | Parameters for the Get All Deviances By Single Directory And Checker action | | `path_parameters.infrastructureId` | string | Required | Parameters for the Get All Deviances By Single Directory And Checker action | | `path_parameters.directoryId` | string | Required | Parameters for the Get All Deviances By Single Directory And Checker action | | `path_parameters.checkerId` | string | Required | Parameters for the Get All Deviances By Single Directory And Checker action | | `parameters.perPage` | string | Optional | Parameters for the Get All Deviances By Single Directory And Checker action | | `parameters.page` | string | Optional | Parameters for the Get All Deviances By Single Directory And Checker action | ### Input Example `{"parameters":{"perPage":"0","page":"0"},"path_parameters":{"profileId":"0","infrastructureId":"0","directoryId":"0","checkerId":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"directoryId":0,"checkerId":0,"profileId":0,"adObjectId":0,"reasonId":0,"resolvedAt":"2023-08-01T05:47:38.860Z","eventDate":"2023-08-01T05:47:38.860Z","ignoreUntil":"2023-08-01T05:47:38.860Z","devianceProviderId":"string","attributes":[],"description":{}}]}` ## Get All Deviances For A Directory Get all deviances for a directory. ### Endpoint - **URL:** `api/infrastructures/{{infrastructureId}}/directories/{{directoryId}}/deviances` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------- | -------- | ------------ | ----------------------------------------------------------- | | `path_parameters.directoryId` | string | Required | Parameters for the Get All Deviances For A Directory action | | `path_parameters.infrastructureId` | string | Required | Parameters for the Get All Deviances For A Directory action | | `parameters.page` | string | Optional | Parameters for the Get All Deviances For A Directory action | | `parameters.perPage` | string | Optional | Parameters for the Get All Deviances For A Directory action | | `parameters.batchSize` | string | Optional | Parameters for the Get All Deviances For A Directory action | | `parameters.lastIdentifierSeen` | string | Optional | Parameters for the Get All Deviances For A Directory action | | `parameters.resolved` | string | Optional | Parameters for the Get All Deviances For A Directory action | ### Input Example `{"parameters":{"page":"0","perPage":"0","batchSize":"0","lastIdentifierSeen":"0","resolved":"0"},"path_parameters":{"directoryId":"0","infrastructureId":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"directoryId":0,"checkerId":0,"profileId":0,"adObjectId":0,"reasonId":0,"resolvedAt":"2023-08-01T05:47:38.860Z","eventDate":"2023-08-01T05:47:38.860Z","ignoreUntil":"2023-08-01T05:47:38.860Z","devianceProviderId":"string","attributes":[],"description":{}}]}` ## Get All Deviances That Created Since An Event Get all deviances that has been created or resolved since an event. ### Endpoint - **URL:** `api/deviances/changed` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | ------------------------------------------------------- | -------- | ---------------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `_embedded` | object | Output field: \_embedded | | `_embedded.deviance` | array | Output field: \_embedded.deviance | | `_embedded.deviance.id` | number | Unique identifier | | `_embedded.deviance.directoryId` | number | Unique identifier | | `_embedded.deviance.checkerId` | number | Unique identifier | | `_embedded.deviance.profileId` | number | Unique identifier | | `_embedded.deviance.adObjectId` | number | Unique identifier | | `_embedded.deviance.reasonId` | number | Unique identifier | | `_embedded.deviance.resolvedAt` | string | Output field: \_embedded.deviance.resolvedAt | | `_embedded.deviance.eventDate` | string | Date value | | `_embedded.deviance.ignoreUntil` | string | Output field: \_embedded.deviance.ignoreUntil | | `_embedded.deviance.devianceProviderId` | string | Unique identifier | | `_embedded.deviance.attributes` | array | Output field: \_embedded.deviance.attributes | | `_embedded.deviance.attributes.name` | string | Name of the resource | | `_embedded.deviance.attributes.value` | string | Value for the parameter | | `_embedded.deviance.description` | object | Output field: \_embedded.deviance.description | | `_embedded.deviance.description.template` | string | Output field: \_embedded.deviance.description.template | | `_embedded.deviance.description.replacements` | array | Output field: \_embedded.deviance.description.replacements | | `_embedded.deviance.description.replacements.name` | string | Name of the resource | | `_embedded.deviance.description.replacements.valueType` | string | Type of the resource | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"_embedded":{"deviance":[]}}}` ## Get All Directories For A Given Infrastructure Get all directories for a given infrastructure. ### Endpoint - **URL:** `api/infrastructures/{{infrastructureId}}/directories` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------- | -------- | ------------ | ------------------------------------------------------------------------ | | `path_parameters.infrastructureId` | string | Required | Parameters for the Get All Directories For A Given Infrastructure action | ### Input Example `{"path_parameters":{"infrastructureId":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"name":"string","ip":"string","type":"ADDS","ldapPort":0,"globalCatalogPort":0,"smbPort":0,"dns":"string","infrastructureId":0,"ldapCrawlingStatus":"none","sysvolCrawlingStatus":"none","honeyAccountAdObjectId":0,"honeyAccountDistinguishedName":"string","honeyAccountConfigurationStatus":"none","sensitiveDataCollectionIsEnabled":...` ## Get All Users Get all users. ### Endpoint - **URL:** `api/users` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"surname":"string","name":"string","email":"string","lockedOut":true,"department":"string","biography":"string","active":true,"picture":[],"roles":[],"identifier":"string","provider":"tenable","eulaVersion":0}]}` ## Get Attack Type Configuration Get the attack type configuration. ### Endpoint - **URL:** `api/attack-type-configuration` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | ------------------------------------- | -------- | ------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `version` | number | Output field: version | | `currentWorkloadQuota` | number | Output field: currentWorkloadQuota | | `maxWorkloadQuota` | number | Output field: maxWorkloadQuota | | `configuration` | array | Output field: configuration | | `configuration.attackTypeId` | number | Unique identifier | | `configuration.directoryId` | number | Unique identifier | | `configuration.detectedEvents` | boolean | Output field: configuration.detectedEvents | | `configuration.autoDisabledForPerfAt` | string | Output field: configuration.autoDisabledForPerfAt | | `permissions` | object | Output field: permissions | | `permissions.canEdit` | boolean | Output field: permissions.canEdit | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"version":0,"currentWorkloadQuota":0,"maxWorkloadQuota":0,"configuration":[{}],"permissions":{"canEdit":true}}}` ## Get Attack Types Get attack types. ### Endpoint - **URL:** `api/attack-types` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"name":"string","yaraRules":"string","description":"string","workloadQuota":0,"mitreAttackDescription":"string","resources":[],"vectorTemplate":"string","vectorTemplateReplacements":[],"eventWeight":"string"}]}` ## Get Category Instance By ID Get category instance by ID. ### Endpoint - **URL:** `api/categories/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ----------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Get Category Instance By ID action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `name` | string | Name of the resource | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"name":"string"}}` ## Get Checker Instance By ID Get checker instance by ID. ### Endpoint - **URL:** `api/checkers/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ---------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Get Checker Instance By ID action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | ---------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `codename` | string | Name of the resource | | `categoryId` | number | Unique identifier | | `remediationCost` | number | Output field: remediationCost | | `name` | string | Name of the resource | | `description` | string | Output field: description | | `execSummary` | string | Output field: execSummary | | `vulnerabilityDetail` | object | Output field: vulnerabilityDetail | | `vulnerabilityDetail.detail` | string | Output field: vulnerabilityDetail.detail | | `attackerKnownTools` | array | Output field: attackerKnownTools | | `attackerKnownTools.name` | string | Name of the resource | | `attackerKnownTools.url` | string | URL endpoint for the request | | `attackerKnownTools.author` | string | Output field: attackerKnownTools.author | | `resources` | array | Output field: resources | | `resources.name` | string | Name of the resource | | `resources.url` | string | URL endpoint for the request | | `resources.type` | string | Type of the resource | | `recommendation` | object | Output field: recommendation | | `recommendation.name` | string | Name of the resource | | `recommendation.description` | string | Output field: recommendation.description | | `recommendation.execSummary` | string | Output field: recommendation.execSummary | | `recommendation.detail` | string | Output field: recommendation.detail | | `recommendation.resources` | array | Output field: recommendation.resources | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"codename":"C-toto-s","categoryId":0,"remediationCost":0,"name":"string","description":"string","execSummary":"string","vulnerabilityDetail":{"detail":"string"},"attackerKnownTools":[{}],"resources":[{}],"recommendation":{"name":"string","description":"string","execSummary":"string","detail":"string","resources":[]}}}` ## Get Dashboard Instance By ID Get dashboard instance by ID. ### Endpoint - **URL:** `api/dashboards/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ------------------------------------------------------ | | `path_parameters.id` | string | Required | Parameters for the Get Dashboard Instance By ID action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `name` | string | Name of the resource | | `order` | number | Output field: order | | `userId` | number | Unique identifier | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"name":"string","order":0,"userId":0}}` ## Get Directory Instance By ID Get directory instance by ID. ### Endpoint - **URL:** `api/infrastructures/{{infrastructureId}}/directories/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------- | -------- | ------------ | ------------------------------------------------------ | | `path_parameters.infrastructureId` | string | Required | Parameters for the Get Directory Instance By ID action | | `path_parameters.id` | string | Required | Parameters for the Get Directory Instance By ID action | ### Input Example `{"path_parameters":{"infrastructureId":"0","id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------------- | -------- | -------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `name` | string | Name of the resource | | `ip` | string | Output field: ip | | `type` | string | Type of the resource | | `ldapPort` | number | Output field: ldapPort | | `globalCatalogPort` | number | Output field: globalCatalogPort | | `smbPort` | number | Output field: smbPort | | `dns` | string | Output field: dns | | `infrastructureId` | number | Unique identifier | | `ldapCrawlingStatus` | string | Status value | | `sysvolCrawlingStatus` | string | Status value | | `honeyAccountAdObjectId` | number | Unique identifier | | `honeyAccountDistinguishedName` | string | Name of the resource | | `honeyAccountConfigurationStatus` | string | Status value | | `sensitiveDataCollectionIsEnabled` | boolean | Response data | | `sensitiveDataCollectionStatus` | string | Response data | | `ioaProcedureInstalled` | boolean | Output field: ioaProcedureInstalled | | `ioaProcedureFailureReason` | string | Response reason phrase | | `ioaProcedureFailureDescription` | string | Output field: ioaProcedureFailureDescription | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"name":"string","ip":"string","type":"ADDS","ldapPort":0,"globalCatalogPort":0,"smbPort":0,"dns":"string","infrastructureId":0,"ldapCrawlingStatus":"none","sysvolCrawlingStatus":"none","honeyAccountAdObjectId":0,"honeyAccountDistinguishedName":"string","honeyAccountConfigurationStatus":"none","sensitiveDataCollectionIsEnabled":t...` ## Get Directory Instance By InfrastructureID and ID Get directory instance by infrastructureID and ID ### Endpoint - **URL:** `api/infrastructures/{{infrastructureId}}/directories/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------- | -------- | ------------ | --------------------------------------------------------------------------- | | `path_parameters.infrastructureId` | string | Required | Parameters for the Get Directory Instance By InfrastructureID and ID action | | `path_parameters.id` | string | Required | Parameters for the Get Directory Instance By InfrastructureID and ID action | ### Input Example `{"path_parameters":{"infrastructureId":"0","id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------------- | -------- | -------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `name` | string | Name of the resource | | `ip` | string | Output field: ip | | `type` | string | Type of the resource | | `ldapPort` | number | Output field: ldapPort | | `globalCatalogPort` | number | Output field: globalCatalogPort | | `smbPort` | number | Output field: smbPort | | `dns` | string | Output field: dns | | `infrastructureId` | number | Unique identifier | | `ldapCrawlingStatus` | string | Status value | | `sysvolCrawlingStatus` | string | Status value | | `honeyAccountAdObjectId` | number | Unique identifier | | `honeyAccountDistinguishedName` | string | Name of the resource | | `honeyAccountConfigurationStatus` | string | Status value | | `sensitiveDataCollectionIsEnabled` | boolean | Response data | | `sensitiveDataCollectionStatus` | string | Response data | | `ioaProcedureInstalled` | boolean | Output field: ioaProcedureInstalled | | `ioaProcedureFailureReason` | string | Response reason phrase | | `ioaProcedureFailureDescription` | string | Output field: ioaProcedureFailureDescription | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"name":"string","ip":"string","type":"ADDS","ldapPort":0,"globalCatalogPort":0,"smbPort":0,"dns":"string","infrastructureId":0,"ldapCrawlingStatus":"none","sysvolCrawlingStatus":"none","honeyAccountAdObjectId":0,"honeyAccountDistinguishedName":"string","honeyAccountConfigurationStatus":"none","sensitiveDataCollectionIsEnabled":t...` ## Get Email Notifier Instance By ID Get email-notifier instance by ID. ### Endpoint - **URL:** `api/email-notifiers/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ----------------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Get Email Notifier Instance By ID action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------------------- | -------- | ---------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `address` | string | Output field: address | | `criticityThreshold` | number | Output field: criticityThreshold | | `directories` | array | Output field: directories | | `description` | string | Output field: description | | `checkers` | array | Output field: checkers | | `attackTypes` | array | Type of the resource | | `profiles` | array | Output field: profiles | | `shouldNotifyOnInitialFullSecurityCheck` | boolean | Output field: shouldNotifyOnInitialFullSecurityCheck | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"address":"string","criticityThreshold":0,"directories":[0],"description":"string","checkers":[0],"attackTypes":[0],"profiles":[0],"shouldNotifyOnInitialFullSecurityCheck":true}}` ## Get Event Instance By ID Get event instance by ID. ### Endpoint - **URL:** `api/infrastructures/{{infrastructureId}}/directories/{{directoryId}}/events/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------- | -------- | ------------ | -------------------------------------------------- | | `path_parameters.infrastructureId` | string | Required | Parameters for the Get Event Instance By ID action | | `path_parameters.directoryId` | string | Required | Parameters for the Get Event Instance By ID action | | `path_parameters.id` | string | Required | Parameters for the Get Event Instance By ID action | ### Input Example `{"path_parameters":{"infrastructureId":"0","directoryId":"0","id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `adObjectId` | number | Unique identifier | | `directoryId` | number | Unique identifier | | `type` | string | Type of the resource | | `date` | string | Date value | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"adObjectId":0,"directoryId":0,"type":"string","date":"2023-08-05T06:37:34.211Z"}}` ## Get Infrastructure Instance By ID Get infrastructure instance by ID. ### Endpoint - **URL:** `api/infrastructures/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ----------------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Get Infrastructure Instance By ID action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `name` | string | Name of the resource | | `login` | string | Output field: login | | `directories` | array | Output field: directories | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"name":"string","login":"string","directories":[0]}}` ## Get One AD-Object By Event And By ID Get one ad-object by event and by ID. ### Endpoint - **URL:** `api/infrastructures/{{infrastructureId}}/directories/{{directoryId}}/events/{{eventId}}/ad-objects/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------- | -------- | ------------ | -------------------------------------------------------------- | | `path_parameters.directoryId` | string | Required | Parameters for the Get One AD-Object By Event And By ID action | | `path_parameters.infrastructureId` | string | Required | Parameters for the Get One AD-Object By Event And By ID action | | `path_parameters.id` | string | Required | Parameters for the Get One AD-Object By Event And By ID action | | `path_parameters.eventId` | string | Required | Parameters for the Get One AD-Object By Event And By ID action | ### Input Example `{"path_parameters":{"directoryId":"0","infrastructureId":"0","id":"0","eventId":"2"}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `directoryId` | number | Unique identifier | | `objectId` | string | Unique identifier | | `type` | string | Type of the resource | | `objectAttributes` | array | Output field: objectAttributes | | `objectAttributes.name` | string | Name of the resource | | `objectAttributes.value` | string | Value for the parameter | | `objectAttributes.valueType` | string | Type of the resource | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"directoryId":0,"objectId":"string","type":"LDAP","objectAttributes":[{}]}}` ## Get One AD-Object Changes Between Given Event Get one ad-object changes between a given event and the event which precedes it. ### Endpoint - **URL:** `api/infrastructures/{{infrastructureId}}/directories/{{directoryId}}/events/{{eventId}}/ad-objects/{{id}}/changes` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------- | -------- | ------------ | ----------------------------------------------------------------------- | | `path_parameters.infrastructureId` | string | Required | Parameters for the Get One AD-Object Changes Between Given Event action | | `path_parameters.directoryId` | string | Required | Parameters for the Get One AD-Object Changes Between Given Event action | | `path_parameters.eventId` | string | Required | Parameters for the Get One AD-Object Changes Between Given Event action | | `path_parameters.id` | string | Required | Parameters for the Get One AD-Object Changes Between Given Event action | ### Input Example `{"path_parameters":{"infrastructureId":"0","directoryId":"0","eventId":"2","id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"attributeName":"string","valueType":"boolean","values":{}}]}` ## Get Role Instance By ID Get role instance by ID. ### Endpoint - **URL:** `api/roles/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Get Role Instance By ID action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------ | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `name` | string | Name of the resource | | `description` | string | Output field: description | | `permissions` | array | Output field: permissions | | `permissions.entityName` | string | Name of the resource | | `permissions.action` | string | Output field: permissions.action | | `permissions.entityIds` | array | Unique identifier | | `permissions.dynamicId` | string | Unique identifier | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"name":"string","description":"string","permissions":[{}]}}` ## Get Saml Configuration Singleton Get saml-configuration singleton. ### Endpoint - **URL:** `api/saml-configuration` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | -------------------------------- | -------- | ----------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `enabled` | boolean | Output field: enabled | | `providerLoginUrl` | string | URL endpoint for the request | | `encryptionCertificate` | string | Output field: encryptionCertificate | | `signatureCertificate` | string | Output field: signatureCertificate | | `serviceProviderUrl` | string | URL endpoint for the request | | `assertEndpoint` | string | Output field: assertEndpoint | | `activateCreatedUsers` | boolean | Output field: activateCreatedUsers | | `allowedGroups` | array | Output field: allowedGroups | | `allowedGroups.name` | string | Name of the resource | | `allowedGroups.defaultProfileId` | number | Unique identifier | | `allowedGroups.defaultRoleIds` | array | Unique identifier | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"enabled":true,"providerLoginUrl":"string","encryptionCertificate":"string","signatureCertificate":"string","serviceProviderUrl":"string","assertEndpoint":"string","activateCreatedUsers":true,"allowedGroups":[{}]}}` ## Get Syslog Instance By ID Get syslog instance by ID. ### Endpoint - **URL:** `api/syslogs/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | --------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Get Syslog Instance By ID action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------------------- | -------- | ---------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `ip` | string | Output field: ip | | `port` | number | Output field: port | | `protocol` | string | Output field: protocol | | `tls` | boolean | Output field: tls | | `criticityThreshold` | number | Output field: criticityThreshold | | `description` | string | Output field: description | | `filterExpression` | object | Output field: filterExpression | | `inputType` | string | Input data for the action | | `directories` | array | Output field: directories | | `checkers` | array | Output field: checkers | | `attackTypes` | array | Type of the resource | | `profiles` | array | Output field: profiles | | `shouldNotifyOnInitialFullSecurityCheck` | boolean | Output field: shouldNotifyOnInitialFullSecurityCheck | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"ip":"string","port":0,"protocol":"UDP","tls":true,"criticityThreshold":0,"description":"string","filterExpression":{},"inputType":"deviances","directories":[0],"checkers":[0],"attackTypes":[0],"profiles":[0],"shouldNotifyOnInitialFullSecurityCheck":true}}` ## Get The Application Settings Get the application settings. ### Endpoint - **URL:** `api/application-settings` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | -------------------------------------- | -------- | -------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `userRegistration` | boolean | Output field: userRegistration | | `activityLogsIsActive` | boolean | Output field: activityLogsIsActive | | `activityLogsRetentionDurationInMonth` | number | Output field: activityLogsRetentionDurationInMonth | | `smtpServerAddress` | string | Output field: smtpServerAddress | | `smtpServerPort` | number | Output field: smtpServerPort | | `smtpAccount` | string | Count value | | `smtpAccountPassword` | string | Output field: smtpAccountPassword | | `smtpUseStartTLS` | boolean | Output field: smtpUseStartTLS | | `tls` | boolean | Output field: tls | | `emailSender` | string | Output field: emailSender | | `defaultRoleIds` | array | Unique identifier | | `defaultProfileId` | number | Unique identifier | | `internalCertificate` | string | Output field: internalCertificate | | `telemetryEnabled` | boolean | Output field: telemetryEnabled | | `ioaAutomaticConfiguration` | boolean | Output field: ioaAutomaticConfiguration | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"userRegistration":true,"activityLogsIsActive":true,"activityLogsRetentionDurationInMonth":1,"smtpServerAddress":"string","smtpServerPort":0,"smtpAccount":"string","smtpAccountPassword":"string","smtpUseStartTLS":true,"tls":true,"emailSender":"string","defaultRoleIds":[0],"defaultProfileId":0,"internalCertificate":"string","telemetryEn...` ## Get The Honey Account Integrity Checks Directory Get the Honey Account integrity checks for a directory. ### Endpoint - **URL:** `api/directories/{{id}}/honey-account-integrity-checks` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | -------------------------------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Get The Honey Account Integrity Checks Directory action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `userAccountControl` | number | Output field: userAccountControl | | `logonHours` | string | Output field: logonHours | | `adminCount` | number | Count value | | `servicePrincipalNamePrefix` | string | Name of the resource | | `servicePrincipalNameSuffix` | string | Name of the resource | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"userAccountControl":0,"logonHours":"string","adminCount":0,"servicePrincipalNamePrefix":"string","servicePrincipalNameSuffix":"string"}}` ## Get The Lockout Policy Get the lockout policy. ### Endpoint - **URL:** `api/lockout-policy` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | ------------------------ | -------- | ------------------------------------ | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `enabled` | boolean | Output field: enabled | | `lockoutDuration` | number | Output field: lockoutDuration | | `failedAttemptThreshold` | number | Output field: failedAttemptThreshold | | `failedAttemptPeriod` | number | Output field: failedAttemptPeriod | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"enabled":true,"lockoutDuration":0,"failedAttemptThreshold":0,"failedAttemptPeriod":0}}` ## Get User Instance By ID Get user instance by ID. ### Endpoint - **URL:** `api/users/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Get User Instance By ID action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `surname` | string | Name of the resource | | `name` | string | Name of the resource | | `email` | string | Output field: email | | `lockedOut` | boolean | Output field: lockedOut | | `department` | string | Output field: department | | `biography` | string | Output field: biography | | `active` | boolean | Output field: active | | `picture` | array | Output field: picture | | `roles` | array | Output field: roles | | `identifier` | string | Unique identifier | | `provider` | string | Unique identifier | | `eulaVersion` | number | Output field: eulaVersion | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"surname":"string","name":"string","email":"string","lockedOut":true,"department":"string","biography":"string","active":true,"picture":[0],"roles":[0],"identifier":"string","provider":"tenable","eulaVersion":0}}` ## Logs In A User Logs in a user. ### Endpoint - **URL:** `api/login` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ---------------------------- | | `password` | string | Optional | Parameter for Logs In A User | | `email` | string | Optional | Parameter for Logs In A User | ### Input Example `{"json_body":{"password":"string","email":"string"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `authToken` | string | Output field: authToken | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"authToken":"string"}}` ## Logs Out A User Logs out a user. ### Endpoint - **URL:** `api/logout` - **Method:** `POST` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":204,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Replace Permission List For A Role Replace permission list for a role. ### Endpoint - **URL:** `api/roles/{{id}}/permissions` - **Method:** `PUT` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ------------------------------------------------------------ | | `path_parameters.id` | string | Required | Parameters for the Replace Permission List For A Role action | | `entityName` | string | Optional | Name of the resource | | `action` | string | Optional | Parameter for Replace Permission List For A Role | | `entityIds` | array | Optional | Unique identifier | | `dynamicId` | string | Optional | Unique identifier | ### Input Example `{"json_body":{"entityName":"string","action":"string","entityIds":[0],"dynamicId":"string"},"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------ | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `name` | string | Name of the resource | | `description` | string | Output field: description | | `permissions` | array | Output field: permissions | | `permissions.entityName` | string | Name of the resource | | `permissions.action` | string | Output field: permissions.action | | `permissions.entityIds` | array | Unique identifier | | `permissions.dynamicId` | string | Unique identifier | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"name":"string","description":"string","permissions":[{}]}}` ## Replace Role List For A User Replace role list for a user. ### Endpoint - **URL:** `api/users/{{id}}/roles` - **Method:** `PUT` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ------------------------------------------------------ | | `path_parameters.id` | string | Required | Parameters for the Replace Role List For A User action | | `roles` | array | Optional | Parameter for Replace Role List For A User | ### Input Example `{"json_body":{"roles":[0]},"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `roles` | array | Output field: roles | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"roles":[0]}}` ## Retrieve All Alert Instances Retrieve all alert instances. ### Endpoint - **URL:** `api/profiles/{{profileId}}/alerts` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | --------------------------- | -------- | ------------ | ------------------------------------------------------ | | `path_parameters.profileId` | string | Required | Parameters for the Retrieve All Alert Instances action | | `parameters.archived` | boolean | Optional | Parameters for the Retrieve All Alert Instances action | | `parameters.read` | boolean | Optional | Parameters for the Retrieve All Alert Instances action | | `parameters.perPage` | string | Optional | Parameters for the Retrieve All Alert Instances action | | `parameters.page` | string | Optional | Parameters for the Retrieve All Alert Instances action | ### Input Example `{"parameters":{"archived":true,"read":true,"perPage":"1","page":"0"},"path_parameters":{"profileId":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"devianceId":0,"archived":false,"read":false,"date":"2023-08-01T05:47:38.860Z","directoryId":0,"infrastructureId":0}]}` ## Retrieve All Category Instances Retrieve all category instances. ### Endpoint - **URL:** `api/categories` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"name":"string"}]}` ## Retrieve All Checker Instances Retrieve all checker instances. ### Endpoint - **URL:** `api/checkers` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"codename":"C-SAMPLE-DUMMY","categoryId":0,"name":"string","description":"string","execSummary":"string","vulnerabilityDetail":{},"attackerKnownTools":[],"resources":[],"recommendation":{}}]}` ## Retrieve All Dashboard Instances Retrieve all dashboard instances. ### Endpoint - **URL:** `api/dashboards` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"name":"string","order":0,"userId":0}]}` ## Retrieve All Directory Instances Retrieve all directory instances. ### Endpoint - **URL:** `api/directories` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"name":"string","ip":"string","type":"ADDS","ldapPort":0,"globalCatalogPort":0,"smbPort":0,"dns":"string","infrastructureId":0,"ldapCrawlingStatus":"none","sysvolCrawlingStatus":"none","honeyAccountAdObjectId":0,"honeyAccountDistinguishedName":"string","honeyAccountConfigurationStatus":"none","sensitiveDataCollectionIsEnabled":...` ## Retrieve All Email Notifier Instances Retrieve All Email Notifier Instances. ### Endpoint - **URL:** `api/email-notifiers` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"address":"string","criticityThreshold":0,"directories":[],"description":"string","checkers":[],"attackTypes":[],"profiles":[],"shouldNotifyOnInitialFullSecurityCheck":true}]}` ## Retrieve All Infrastructure Instances Retrieve all infrastructure instances. ### Endpoint - **URL:** `api/infrastructures` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"name":"string","login":"string","directories":[]}]}` ## Retrieve All Role Instances Retrieve all role instances. ### Endpoint - **URL:** `api/roles` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"name":"string","description":"string","permissions":[]}]}` ## Retrieve All Syslog Instances Retrieve all syslog instances. ### Endpoint - **URL:** `api/syslogs` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"ip":"string","port":0,"protocol":"UDP","tls":true,"criticityThreshold":0,"description":"string","filterExpression":{},"inputType":"deviances","directories":[],"checkers":[],"attackTypes":[],"profiles":[],"shouldNotifyOnInitialFullSecurityCheck":true}]}` ## Retrieve An AD-Object By ID Profile And Checker Retrieve an AD object by id that have deviances for a specific profile and checker. ### Endpoint - **URL:** `api/profiles/{{profileId}}/checkers/{{checkerId}}/ad-objects/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | --------------------------- | -------- | ------------ | ------------------------------------------------------------------------- | | `path_parameters.profileId` | string | Required | Parameters for the Retrieve An AD-Object By ID Profile And Checker action | | `path_parameters.checkerId` | string | Required | Parameters for the Retrieve An AD-Object By ID Profile And Checker action | | `path_parameters.id` | string | Required | Parameters for the Retrieve An AD-Object By ID Profile And Checker action | | `parameters.showIgnored` | string | Optional | Parameters for the Retrieve An AD-Object By ID Profile And Checker action | ### Input Example `{"parameters":{"showIgnored":"true"},"path_parameters":{"profileId":"0","checkerId":"0","id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `directoryId` | number | Unique identifier | | `objectId` | string | Unique identifier | | `type` | string | Type of the resource | | `objectAttributes` | array | Output field: objectAttributes | | `objectAttributes.name` | string | Name of the resource | | `objectAttributes.value` | string | Value for the parameter | | `objectAttributes.valueType` | string | Type of the resource | | `reasons` | array | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"directoryId":0,"objectId":"string","type":"LDAP","objectAttributes":[{}],"reasons":[0]}}` ## Return The Default Roles For User Creation Return the default roles for user creation. ### Endpoint - **URL:** `api/roles/user-creation-defaults` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"name":"string","description":"string","permissions":[]}]}` ## Return The Last State Of Every AD-Object Return the last state of every ad-object at the provided timestampBy default, the timestamp is now. Objects out of scope are included. ### Endpoint - **URL:** `api/ad-objects` - **Method:** `GET` ### Output | **Parameter** | **Type** | **Description** | | ------------------------------------------------ | -------- | --------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `_embedded` | object | Output field: \_embedded | | `_embedded.ad-object` | array | Output field: \_embedded.ad-object | | `_embedded.ad-object.id` | number | Unique identifier | | `_embedded.ad-object.directoryId` | number | Unique identifier | | `_embedded.ad-object.objectId` | string | Unique identifier | | `_embedded.ad-object.type` | string | Type of the resource | | `_embedded.ad-object.objectAttributes` | array | Output field: \_embedded.ad-object.objectAttributes | | `_embedded.ad-object.objectAttributes.name` | string | Name of the resource | | `_embedded.ad-object.objectAttributes.value` | string | Value for the parameter | | `_embedded.ad-object.objectAttributes.valueType` | string | Type of the resource | | `_links` | object | Output field: \_links | | `_links.next` | string | Output field: \_links.next | | `_links.additionalProp` | object | Output field: \_links.additionalProp | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"_embedded":{"ad-object":[]},"_links":{"next":"string","additionalProp":{}}}}` ## Search All AD-Objects By Profile By Checker Search all AD objects having deviances by profile by checker. ### Endpoint - **URL:** `api/profiles/{{profileId}}/checkers/{{checkerId}}/ad-objects/search` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | --------------------------- | -------- | ------------ | --------------------------------------------------------------------- | | `path_parameters.profileId` | string | Required | Parameters for the Search All AD-Objects By Profile By Checker action | | `path_parameters.checkerId` | string | Required | Parameters for the Search All AD-Objects By Profile By Checker action | | `parameters.perPage` | string | Optional | Parameters for the Search All AD-Objects By Profile By Checker action | | `parameters.page` | string | Optional | Parameters for the Search All AD-Objects By Profile By Checker action | | `expression` | object | Optional | Parameter for Search All AD-Objects By Profile By Checker | | `directories` | array | Optional | Parameter for Search All AD-Objects By Profile By Checker | | `reasons` | array | Optional | Response reason phrase | | `dateStart` | string | Optional | Parameter for Search All AD-Objects By Profile By Checker | | `dateEnd` | string | Optional | Parameter for Search All AD-Objects By Profile By Checker | | `showIgnored` | boolean | Optional | Parameter for Search All AD-Objects By Profile By Checker | ### Input Example `{"parameters":{"perPage":"0","page":"1"},"json_body":{"expression":{},"directories":[0],"reasons":[0],"dateStart":"2023-08-01T05:47:38.860Z","dateEnd":"2023-09-01T05:47:38.860Z","showIgnored":true},"path_parameters":{"profileId":"0","checkerId":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"directoryId":0,"objectId":"string","type":"LDAP","objectAttributes":[],"reasons":[]}]}` ## Search All Deviances By Profile By Checker Search all deviances by profile by checker by AD-object. ### Endpoint - **URL:** `api/profiles/{{profileId}}/checkers/{{checkerId}}/ad-objects/{{adObjectId}}/deviances` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------- | -------- | ------------ | -------------------------------------------------------------------- | | `path_parameters.profileId` | string | Required | Parameters for the Search All Deviances By Profile By Checker action | | `path_parameters.checkerId` | string | Required | Parameters for the Search All Deviances By Profile By Checker action | | `path_parameters.adObjectId` | string | Required | Parameters for the Search All Deviances By Profile By Checker action | | `parameters.perPage` | string | Optional | Parameters for the Search All Deviances By Profile By Checker action | | `parameters.page` | string | Optional | Parameters for the Search All Deviances By Profile By Checker action | | `dateStart` | string | Optional | Parameter for Search All Deviances By Profile By Checker | | `dateEnd` | string | Optional | Parameter for Search All Deviances By Profile By Checker | | `showIgnored` | boolean | Optional | Parameter for Search All Deviances By Profile By Checker | ### Input Example `{"parameters":{"perPage":"0","page":"0"},"json_body":{"dateStart":"2023-08-04T04:34:23.521Z","dateEnd":"2023-09-04T04:34:23.521Z","showIgnored":true},"path_parameters":{"profileId":"0","checkerId":"0","adObjectId":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"id":0,"directoryId":0,"checkerId":0,"profileId":0,"adObjectId":0,"reasonId":0,"resolvedAt":"2023-08-04T04:34:23.521Z","eventDate":"2023-08-04T04:34:23.521Z","ignoreUntil":"2023-08-04T04:34:23.521Z","devianceProviderId":"string","attributes":[],"description":{}}]}` ## Search Events Instances Search events instances. ### Endpoint - **URL:** `api/events/search` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ------------------------------------- | | `expression` | object | Optional | Parameter for Search Events Instances | | `order` | object | Optional | Parameter for Search Events Instances | | `order.column` | string | Optional | Parameter for Search Events Instances | | `order.direction` | string | Optional | Parameter for Search Events Instances | | `profileId` | number | Optional | Unique identifier | | `directoryIds` | array | Optional | Unique identifier | | `dateStart` | string | Optional | Parameter for Search Events Instances | | `dateEnd` | string | Optional | Parameter for Search Events Instances | ### Input Example `{"json_body":{"expression":{},"order":{"column":"id","direction":"asc"},"profileId":0,"directoryIds":[0],"dateStart":"2023-08-01T05:47:38.860Z","dateEnd":"2023-09-01T05:47:38.860Z"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":[{"adObjectId":0,"directoryId":0,"type":"string","date":"2023-08-05T06:37:34.211Z"}]}` ## Send A Test Email Notification Send a test email notification. ### Endpoint - **URL:** `api/email-notifiers/test-message` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | -------------------------------------------- | | `checkers` | array | Optional | Parameter for Send A Test Email Notification | | `attackTypes` | array | Optional | Type of the resource | | `profiles` | array | Optional | Parameter for Send A Test Email Notification | | `address` | string | Optional | Parameter for Send A Test Email Notification | | `criticityThreshold` | number | Optional | Parameter for Send A Test Email Notification | | `directories` | array | Optional | Parameter for Send A Test Email Notification | | `description` | string | Optional | Parameter for Send A Test Email Notification | | `inputType` | string | Optional | Input data for the action | ### Input Example `{"json_body":{"checkers":[0],"attackTypes":[0],"profiles":[0],"address":"string","criticityThreshold":0,"directories":[0],"description":"string","inputType":"deviances"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Send A Test Email Notification By ID Send a test email notification by ID. ### Endpoint - **URL:** `api/email-notifiers/test-message/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | -------------------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Send A Test Email Notification By ID action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Send A Test Syslog Notification Send a test syslog notification. ### Endpoint - **URL:** `api/syslogs/test-message` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | --------------------------------------------- | | `checkers` | array | Optional | Parameter for Send A Test Syslog Notification | | `profiles` | array | Optional | Parameter for Send A Test Syslog Notification | | `attackTypes` | array | Optional | Type of the resource | | `ip` | string | Optional | Parameter for Send A Test Syslog Notification | | `port` | number | Optional | Parameter for Send A Test Syslog Notification | | `protocol` | string | Optional | Parameter for Send A Test Syslog Notification | | `tls` | boolean | Optional | Parameter for Send A Test Syslog Notification | | `criticityThreshold` | number | Optional | Parameter for Send A Test Syslog Notification | | `directories` | array | Optional | Parameter for Send A Test Syslog Notification | | `description` | string | Optional | Parameter for Send A Test Syslog Notification | | `filterExpression` | object | Optional | Parameter for Send A Test Syslog Notification | | `inputType` | string | Optional | Input data for the action | ### Input Example `{"json_body":{"checkers":[0],"profiles":[0],"attackTypes":[0],"ip":"string","port":0,"protocol":"string","tls":true,"criticityThreshold":0,"directories":[0],"description":"string","filterExpression":{},"inputType":"string"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Send A Test Syslog Notification By ID Send a test syslog notification by ID. ### Endpoint - **URL:** `api/syslogs/test-message/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | --------------------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Send A Test Syslog Notification By ID action | ### Input Example `{"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Update A User's Password Update a user's password. ### Endpoint - **URL:** `api/users/password` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | -------------------------------------- | | `oldPassword` | string | Optional | Parameter for Update A User's Password | | `newPassword` | string | Optional | Parameter for Update A User's Password | ### Input Example `{"json_body":{"oldPassword":"string","newPassword":"string"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Update AD-Object Deviance History Instance Update ad-object-deviance-history instance. ### Endpoint - **URL:** `api/infrastructures/{{infrastructureId}}/directories/{{directoryId}}/deviances/{{id}}` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------- | -------- | ------------ | -------------------------------------------------------------------- | | `path_parameters.infrastructureId` | string | Required | Parameters for the Update AD-Object Deviance History Instance action | | `path_parameters.directoryId` | string | Required | Parameters for the Update AD-Object Deviance History Instance action | | `path_parameters.id` | string | Required | Parameters for the Update AD-Object Deviance History Instance action | | `ignoreUntil` | string | Optional | Parameter for Update AD-Object Deviance History Instance | ### Input Example `{"json_body":{"ignoreUntil":"2023-08-01T05:47:38.860Z"},"path_parameters":{"infrastructureId":"0","directoryId":"0","id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------------------ | -------- | -------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `directoryId` | number | Unique identifier | | `checkerId` | number | Unique identifier | | `profileId` | number | Unique identifier | | `adObjectId` | number | Unique identifier | | `reasonId` | number | Unique identifier | | `resolvedAt` | string | Output field: resolvedAt | | `eventDate` | string | Date value | | `ignoreUntil` | string | Output field: ignoreUntil | | `devianceProviderId` | string | Unique identifier | | `attributes` | array | Output field: attributes | | `attributes.name` | string | Name of the resource | | `attributes.value` | string | Value for the parameter | | `description` | object | Output field: description | | `description.template` | string | Output field: description.template | | `description.replacements` | array | Output field: description.replacements | | `description.replacements.name` | string | Name of the resource | | `description.replacements.valueType` | string | Type of the resource | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"directoryId":0,"checkerId":0,"profileId":0,"adObjectId":0,"reasonId":0,"resolvedAt":"2023-08-01T05:47:38.860Z","eventDate":"2023-08-01T05:47:38.860Z","ignoreUntil":"2023-08-01T05:47:38.860Z","devianceProviderId":"string","attributes":[{}],"description":{"template":"string","replacements":[]}}}` ## Update Alert Instance Update alert instance. ### Endpoint - **URL:** `api/alerts/{{id}}` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ----------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Update Alert Instance action | | `archived` | boolean | Optional | Parameter for Update Alert Instance | | `read` | boolean | Optional | Parameter for Update Alert Instance | ### Input Example `{"json_body":{"archived":true,"read":true},"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------ | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `devianceId` | number | Unique identifier | | `archived` | boolean | Output field: archived | | `read` | boolean | Output field: read | | `date` | string | Date value | | `directoryId` | number | Unique identifier | | `infrastructureId` | number | Unique identifier | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"devianceId":0,"archived":false,"read":false,"date":"2023-08-01T05:47:38.860Z","directoryId":0,"infrastructureId":0}}` ## Update Alerts For One Profile Update alerts for one profile. ### Endpoint - **URL:** `api/profiles/{{profileId}}/alerts` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | --------------------------- | -------- | ------------ | ------------------------------------------------------- | | `path_parameters.profileId` | string | Required | Parameters for the Update Alerts For One Profile action | | `archived` | boolean | Optional | Parameter for Update Alerts For One Profile | | `read` | boolean | Optional | Parameter for Update Alerts For One Profile | ### Input Example `{"json_body":{"archived":true,"read":true},"path_parameters":{"profileId":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Update Dashboard Instance Update dashboard instance. ### Endpoint - **URL:** `api/dashboards/{{id}}` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | --------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Update Dashboard Instance action | | `name` | string | Optional | Name of the resource | | `order` | number | Optional | Parameter for Update Dashboard Instance | ### Input Example `{"json_body":{"name":"string","order":0},"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `name` | string | Name of the resource | | `order` | number | Output field: order | | `userId` | number | Unique identifier | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"name":"string","order":0,"userId":0}}` ## Update Directory Instance Update directory instance. ### Endpoint - **URL:** `api/infrastructures/{{infrastructureId}}/directories/{{id}}` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------- | -------- | ------------ | --------------------------------------------------- | | `path_parameters.infrastructureId` | string | Required | Parameters for the Update Directory Instance action | | `path_parameters.id` | string | Required | Parameters for the Update Directory Instance action | | `name` | string | Optional | Name of the resource | | `ip` | string | Optional | Parameter for Update Directory Instance | | `type` | string | Optional | Type of the resource | | `ldapPort` | number | Optional | Parameter for Update Directory Instance | | `globalCatalogPort` | number | Optional | Parameter for Update Directory Instance | | `smbPort` | number | Optional | Parameter for Update Directory Instance | | `dns` | string | Optional | Parameter for Update Directory Instance | | `relayId` | string | Optional | Unique identifier | ### Input Example `{"json_body":{"name":"string","ip":"string","type":"ADDS","ldapPort":0,"globalCatalogPort":0,"smbPort":0,"dns":"string","relayId":"string"},"path_parameters":{"infrastructureId":"0","id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------------- | -------- | -------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `name` | string | Name of the resource | | `ip` | string | Output field: ip | | `type` | string | Type of the resource | | `ldapPort` | number | Output field: ldapPort | | `globalCatalogPort` | number | Output field: globalCatalogPort | | `smbPort` | number | Output field: smbPort | | `dns` | string | Output field: dns | | `infrastructureId` | number | Unique identifier | | `ldapCrawlingStatus` | string | Status value | | `sysvolCrawlingStatus` | string | Status value | | `honeyAccountAdObjectId` | number | Unique identifier | | `honeyAccountDistinguishedName` | string | Name of the resource | | `honeyAccountConfigurationStatus` | string | Status value | | `sensitiveDataCollectionIsEnabled` | boolean | Response data | | `sensitiveDataCollectionStatus` | string | Response data | | `ioaProcedureInstalled` | boolean | Output field: ioaProcedureInstalled | | `ioaProcedureFailureReason` | string | Response reason phrase | | `ioaProcedureFailureDescription` | string | Output field: ioaProcedureFailureDescription | ### Output Example `{"status_code":204,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"name":"string","ip":"string","type":"ADDS","ldapPort":0,"globalCatalogPort":0,"smbPort":0,"dns":"string","infrastructureId":0,"ldapCrawlingStatus":"none","sysvolCrawlingStatus":"none","honeyAccountAdObjectId":0,"honeyAccountDistinguishedName":"string","honeyAccountConfigurationStatus":"none","sensitiveDataCollectionIsEnabled":t...` ## Update Email Notifier Instance Update email-notifier instance. ### Endpoint - **URL:** `api/email-notifiers/{{id}}` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | -------------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Update Email Notifier Instance action | | `address` | string | Optional | Parameter for Update Email Notifier Instance | | `criticityThreshold` | number | Optional | Parameter for Update Email Notifier Instance | | `directories` | array | Optional | Parameter for Update Email Notifier Instance | | `description` | string | Optional | Parameter for Update Email Notifier Instance | | `checkers` | array | Optional | Parameter for Update Email Notifier Instance | | `attackTypes` | array | Optional | Type of the resource | | `profiles` | array | Optional | Parameter for Update Email Notifier Instance | | `inputType` | string | Optional | Input data for the action | ### Input Example `{"json_body":{"address":"string","criticityThreshold":0,"directories":[0],"description":"string","checkers":[0],"attackTypes":[0],"profiles":[0],"inputType":"deviances"},"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------------------- | -------- | ---------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `address` | string | Output field: address | | `criticityThreshold` | number | Output field: criticityThreshold | | `directories` | array | Output field: directories | | `description` | string | Output field: description | | `checkers` | array | Output field: checkers | | `attackTypes` | array | Type of the resource | | `profiles` | array | Output field: profiles | | `shouldNotifyOnInitialFullSecurityCheck` | boolean | Output field: shouldNotifyOnInitialFullSecurityCheck | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"address":"string","criticityThreshold":0,"directories":[0],"description":"string","checkers":[0],"attackTypes":[0],"profiles":[0],"shouldNotifyOnInitialFullSecurityCheck":true}}` ## Update Infrastructure Instance Update infrastructure instance. ### Endpoint - **URL:** `api/infrastructures/{{id}}` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | -------------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Update Infrastructure Instance action | | `name` | string | Optional | Name of the resource | | `login` | string | Optional | Parameter for Update Infrastructure Instance | | `password` | string | Optional | Parameter for Update Infrastructure Instance | ### Input Example `{"json_body":{"name":"string","login":"string","password":"string"},"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `name` | string | Name of the resource | | `login` | string | Output field: login | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"name":"string","login":"string"}}` ## Update Instances Matching A CheckerID Update instances matching a checkerID. ### Endpoint - **URL:** `api/profiles/{{profileId}}/checkers/{{checkerId}}/deviances` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | --------------------------- | -------- | ------------ | --------------------------------------------------------------- | | `path_parameters.profileId` | string | Required | Parameters for the Update Instances Matching A CheckerID action | | `path_parameters.checkerId` | string | Required | Parameters for the Update Instances Matching A CheckerID action | | `parameters.profileId` | string | Required | Parameters for the Update Instances Matching A CheckerID action | | `parameters.checkerId` | string | Required | Parameters for the Update Instances Matching A CheckerID action | | `ignoreUntil` | string | Optional | Parameter for Update Instances Matching A CheckerID | ### Input Example `{"parameters":{"profileId":"0","checkerId":"0"},"json_body":{"ignoreUntil":"2023-08-04T04:34:23.521Z"},"path_parameters":{"profileId":"0","checkerId":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":204,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Update Role Instance Update role instance. ### Endpoint - **URL:** `api/roles/{{id}}` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ---------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Update Role Instance action | | `name` | string | Optional | Name of the resource | | `description` | string | Optional | Parameter for Update Role Instance | ### Input Example `{"json_body":{"name":"string","description":"string"},"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------ | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `name` | string | Name of the resource | | `description` | string | Output field: description | | `permissions` | array | Output field: permissions | | `permissions.entityName` | string | Name of the resource | | `permissions.action` | string | Output field: permissions.action | | `permissions.entityIds` | array | Unique identifier | | `permissions.dynamicId` | string | Unique identifier | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"name":"string","description":"string","permissions":[{}]}}` ## Update Saml-Configuration Singleton Update saml-configuration singleton. ### Endpoint - **URL:** `api/saml-configuration` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------------------- | -------- | ------------ | ------------------------------------------------- | | `enabled` | boolean | Optional | Parameter for Update Saml-Configuration Singleton | | `providerLoginUrl` | string | Optional | URL endpoint for the request | | `signatureCertificate` | string | Optional | Parameter for Update Saml-Configuration Singleton | | `activateCreatedUsers` | string | Optional | Parameter for Update Saml-Configuration Singleton | | `allowedGroups` | array | Optional | Parameter for Update Saml-Configuration Singleton | | `allowedGroups.name` | string | Required | Name of the resource | | `allowedGroups.defaultProfileId` | number | Required | Unique identifier | | `allowedGroups.defaultRoleIds` | string | Required | Unique identifier | ### Input Example `{"json_body":{"enabled":true,"providerLoginUrl":"string","signatureCertificate":"string","activateCreatedUsers":"string","allowedGroups":[{"name":"string","defaultProfileId":0,"defaultRoleIds":"[0]"}]}}` ### Output | **Parameter** | **Type** | **Description** | | -------------------------------- | -------- | ----------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `enabled` | boolean | Output field: enabled | | `providerLoginUrl` | string | URL endpoint for the request | | `encryptionCertificate` | string | Output field: encryptionCertificate | | `signatureCertificate` | string | Output field: signatureCertificate | | `serviceProviderUrl` | string | URL endpoint for the request | | `assertEndpoint` | string | Output field: assertEndpoint | | `activateCreatedUsers` | boolean | Output field: activateCreatedUsers | | `allowedGroups` | array | Output field: allowedGroups | | `allowedGroups.name` | string | Name of the resource | | `allowedGroups.defaultProfileId` | number | Unique identifier | | `allowedGroups.defaultRoleIds` | array | Unique identifier | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"enabled":true,"providerLoginUrl":"string","encryptionCertificate":"string","signatureCertificate":"string","serviceProviderUrl":"string","assertEndpoint":"string","activateCreatedUsers":true,"allowedGroups":[{}]}}` ## Update Syslog Instance Update syslog instance. ### Endpoint - **URL:** `api/syslogs/{{id}}` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ------------------------------------------------ | | `path_parameters.id` | string | Required | Parameters for the Update Syslog Instance action | | `ip` | string | Optional | Parameter for Update Syslog Instance | | `port` | string | Optional | Parameter for Update Syslog Instance | | `protocol` | string | Optional | Parameter for Update Syslog Instance | | `tls` | boolean | Optional | Parameter for Update Syslog Instance | | `criticityThreshold` | number | Optional | Parameter for Update Syslog Instance | | `description` | string | Optional | Parameter for Update Syslog Instance | | `filterExpression` | object | Optional | Parameter for Update Syslog Instance | | `inputType` | string | Optional | Input data for the action | | `directories` | array | Optional | Parameter for Update Syslog Instance | | `checkers` | array | Optional | Parameter for Update Syslog Instance | | `profiles` | array | Optional | Parameter for Update Syslog Instance | | `attackTypes` | array | Optional | Type of the resource | ### Input Example `{"json_body":{"ip":"string","port":"string","protocol":"string","tls":true,"criticityThreshold":0,"description":"string","filterExpression":{},"inputType":"string","directories":[0],"checkers":[0],"profiles":[0],"attackTypes":[0]},"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------------------- | -------- | ---------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `ip` | string | Output field: ip | | `port` | number | Output field: port | | `protocol` | string | Output field: protocol | | `tls` | boolean | Output field: tls | | `criticityThreshold` | number | Output field: criticityThreshold | | `description` | string | Output field: description | | `filterExpression` | object | Output field: filterExpression | | `inputType` | string | Input data for the action | | `directories` | array | Output field: directories | | `checkers` | array | Output field: checkers | | `attackTypes` | array | Type of the resource | | `profiles` | array | Output field: profiles | | `shouldNotifyOnInitialFullSecurityCheck` | boolean | Output field: shouldNotifyOnInitialFullSecurityCheck | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"ip":"string","port":0,"protocol":"UDP","tls":true,"criticityThreshold":0,"description":"string","filterExpression":{},"inputType":"deviances","directories":[0],"checkers":[0],"attackTypes":[0],"profiles":[0],"shouldNotifyOnInitialFullSecurityCheck":true}}` ## Update The Application Settings Update the application settings. ### Endpoint - **URL:** `api/application-settings` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------------------------- | -------- | ------------ | --------------------------------------------- | | `userRegistration` | boolean | Optional | Parameter for Update The Application Settings | | `activityLogsIsActive` | boolean | Optional | Parameter for Update The Application Settings | | `activityLogsRetentionDurationInMonth` | number | Optional | Parameter for Update The Application Settings | | `smtpServerAddress` | string | Optional | Parameter for Update The Application Settings | | `smtpServerPort` | number | Optional | Parameter for Update The Application Settings | | `smtpAccount` | string | Optional | Count value | | `smtpAccountPassword` | string | Optional | Parameter for Update The Application Settings | | `smtpUseStartTLS` | boolean | Optional | Parameter for Update The Application Settings | | `tls` | boolean | Optional | Parameter for Update The Application Settings | | `emailSender` | string | Optional | Parameter for Update The Application Settings | | `defaultRoleIds` | array | Optional | Unique identifier | | `defaultProfileId` | number | Optional | Unique identifier | | `internalCertificate` | string | Optional | Parameter for Update The Application Settings | | `telemetryEnabled` | boolean | Optional | Parameter for Update The Application Settings | | `ioaAutomaticConfiguration` | boolean | Optional | Parameter for Update The Application Settings | ### Input Example `{"json_body":{"userRegistration":true,"activityLogsIsActive":true,"activityLogsRetentionDurationInMonth":1,"smtpServerAddress":"string","smtpServerPort":0,"smtpAccount":"string","smtpAccountPassword":"string","smtpUseStartTLS":true,"tls":true,"emailSender":"string","defaultRoleIds":[0],"defaultProfileId":0,"internalCertificate":"string","telemetryEnabled":true,"ioaAutomaticConfiguration":true}}` ### Output | **Parameter** | **Type** | **Description** | | -------------------------------------- | -------- | -------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `userRegistration` | boolean | Output field: userRegistration | | `activityLogsIsActive` | boolean | Output field: activityLogsIsActive | | `activityLogsRetentionDurationInMonth` | number | Output field: activityLogsRetentionDurationInMonth | | `smtpServerAddress` | string | Output field: smtpServerAddress | | `smtpServerPort` | number | Output field: smtpServerPort | | `smtpAccount` | string | Count value | | `smtpAccountPassword` | string | Output field: smtpAccountPassword | | `smtpUseStartTLS` | boolean | Output field: smtpUseStartTLS | | `tls` | boolean | Output field: tls | | `emailSender` | string | Output field: emailSender | | `defaultRoleIds` | array | Unique identifier | | `defaultProfileId` | number | Unique identifier | | `internalCertificate` | string | Output field: internalCertificate | | `telemetryEnabled` | boolean | Output field: telemetryEnabled | | `ioaAutomaticConfiguration` | boolean | Output field: ioaAutomaticConfiguration | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"userRegistration":true,"activityLogsIsActive":true,"activityLogsRetentionDurationInMonth":1,"smtpServerAddress":"string","smtpServerPort":0,"smtpAccount":"string","smtpAccountPassword":"string","smtpUseStartTLS":true,"tls":true,"emailSender":"string","defaultRoleIds":[0],"defaultProfileId":0,"internalCertificate":"string","telemetryEn...` ## Update The Attack Type Configuration And Workload Update the attack type configuration and the workload quota. ### Endpoint - **URL:** `api/attack-type-configuration` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------- | -------- | ------------ | --------------------------------------------------------------- | | `configuration` | array | Optional | Parameter for Update The Attack Type Configuration And Workload | | `configuration.attackTypeId` | number | Required | Unique identifier | | `configuration.directoryId` | number | Required | Unique identifier | | `maxWorkloadQuota` | number | Optional | Parameter for Update The Attack Type Configuration And Workload | ### Input Example `{"json_body":{"configuration":[{"attackTypeId":0,"directoryId":0}],"maxWorkloadQuota":0}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":204,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Update The Deviances Emitted AD-Object And Checker Update the deviances emitted on a specific AD object and for a specific checker. ### Endpoint - **URL:** `api/profiles/{{profileId}}/checkers/{{checkerId}}/ad-objects/{{adObjectId}}/deviances` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------- | -------- | ------------ | ---------------------------------------------------------------------------- | | `path_parameters.profileId` | string | Required | Parameters for the Update The Deviances Emitted AD-Object And Checker action | | `path_parameters.checkerId` | string | Required | Parameters for the Update The Deviances Emitted AD-Object And Checker action | | `path_parameters.adObjectId` | string | Required | Parameters for the Update The Deviances Emitted AD-Object And Checker action | | `parameters.profileId` | string | Required | Parameters for the Update The Deviances Emitted AD-Object And Checker action | | `parameters.checkerId` | string | Required | Parameters for the Update The Deviances Emitted AD-Object And Checker action | | `parameters.adObjectId` | string | Required | Parameters for the Update The Deviances Emitted AD-Object And Checker action | | `ignoreUntil` | string | Optional | Parameter for Update The Deviances Emitted AD-Object And Checker | ### Input Example `{"parameters":{"profileId":"0","checkerId":"0","adObjectId":"0"},"json_body":{"ignoreUntil":"2023-08-04T04:34:23.521Z"},"path_parameters":{"profileId":"0","checkerId":"0","adObjectId":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":204,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Update The Lockout Policy Update the lockout policy. ### Endpoint - **URL:** `api/lockout-policy` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------ | -------- | ------------ | --------------------------------------- | | `enabled` | boolean | Optional | Parameter for Update The Lockout Policy | | `lockoutDuration` | number | Optional | Parameter for Update The Lockout Policy | | `failedAttemptThreshold` | number | Optional | Parameter for Update The Lockout Policy | | `failedAttemptPeriod` | number | Optional | Parameter for Update The Lockout Policy | ### Input Example `{"json_body":{"enabled":true,"lockoutDuration":0,"failedAttemptThreshold":0,"failedAttemptPeriod":0}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}` ## Update User Instance Update user instance. ### Endpoint - **URL:** `api/users/{{id}}` - **Method:** `PATCH` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ---------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Update User Instance action | | `surname` | string | Optional | Name of the resource | | `name` | string | Optional | Name of the resource | | `password` | string | Optional | Parameter for Update User Instance | | `email` | string | Optional | Parameter for Update User Instance | | `department` | string | Optional | Parameter for Update User Instance | | `description` | string | Optional | Parameter for Update User Instance | | `biography` | string | Optional | Parameter for Update User Instance | | `active` | boolean | Optional | Parameter for Update User Instance | | `lockedOut` | boolean | Optional | Parameter for Update User Instance | | `picture` | array | Optional | Parameter for Update User Instance | ### Input Example `{"json_body":{"surname":"string","name":"string","password":"string","email":"string","department":"string","description":"string","biography":"string","active":true,"lockedOut":true,"picture":[0]},"path_parameters":{"id":"0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `id` | number | Unique identifier | | `surname` | string | Name of the resource | | `name` | string | Name of the resource | | `email` | string | Output field: email | | `lockedOut` | boolean | Output field: lockedOut | | `department` | string | Output field: department | | `biography` | string | Output field: biography | | `active` | boolean | Output field: active | | `picture` | array | Output field: picture | | `roles` | array | Output field: roles | | `identifier` | string | Unique identifier | | `provider` | string | Unique identifier | | `eulaVersion` | number | Output field: eulaVersion | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{"id":0,"surname":"string","name":"string","email":"string","lockedOut":true,"department":"string","biography":"string","active":true,"picture":[0],"roles":[0],"identifier":"string","provider":"tenable","eulaVersion":0}}` # Response Headers | **Header** | **Description** | **Example** | | -------------- | ----------------------------------------------------- | ----------------------------- | | content-length | The length of the response body in bytes | 140 | | content-type | The media type of the resource | application/json | | Date | The date and time at which the message was originated | Mon, 10 Jul 2023 20:37:23 GMT |