Tenable Identity Exposure

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 input argument name type required description profileid string required unique identifier attacktypeid string required unique identifier codename string required name of the resource directoryid number optional unique identifier value string required value for the parameter valuetype string required type of the resource output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] create dashboard instance create dashboard instance endpoint url api/dashboards method post input argument name type required description input argument name type required description name string required name of the resource order number required parameter for create dashboard instance output parameter type description 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 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 input argument name type required description infrastructureid number required unique identifier name string required name of the resource ip string required 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 required parameter for create directory instance sensitivedatacollectionisenabled boolean optional response data relayid string optional unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] create email notifier instance create email notifier instance endpoint url api/email notifiers method post input argument name type required description input argument name type required description checkers array optional parameter for create email notifier instance profiles array required 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 output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] create infrastructure instance create infrastructure instance endpoint url api/infrastructures method post input argument name type required description input argument name type required description name string required name of the resource login string required parameter for create infrastructure instance password string required parameter for create infrastructure instance output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] create role instance create role instance endpoint url api/roles method post input argument name type required description input argument name type required description name string required name of the resource description string required parameter for create role instance output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] create syslog instance create syslog instance endpoint url api/syslogs method post input argument name type required description input argument name type required description checkers array optional parameter for create syslog instance profiles array required parameter for create syslog instance attacktypes array optional type of the resource ip string optional parameter for create syslog instance port number optional parameter for create syslog instance protocol string optional parameter for create syslog instance tls boolean optional parameter for create syslog instance criticitythreshold number optional parameter for create syslog instance description string optional parameter for create syslog instance filterexpression object optional parameter for create syslog instance inputtype string optional input data for the action directories array optional parameter for create syslog instance shouldnotifyoninitialfullsecuritycheck boolean optional parameter for create syslog instance output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] create user instance create user instance endpoint url api/users method post input argument name type required description input argument name type required description surname string optional name of the resource name string required name of the resource email string required parameter for create user instance password boolean required parameter for create user instance department string optional parameter for create user instance biography string optional parameter for create user instance active boolean optional parameter for create user instance picture array optional parameter for create user instance output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] 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 input argument name type required description fromid string required unique identifier name string required name of the resource output parameter type description 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 entityname string name of the resource action string output field action entityids array unique identifier dynamicid string unique identifier 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 input argument name type required description id string required unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 input argument name type required description infrastructureid string required unique identifier id string required unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 input argument name type required description id string required unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 input argument name type required description id string required unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 input argument name type required description id string required unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 input argument name type required description id string required unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 input argument name type required description id string required unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 output parameter type description status code number http status code of the response reason string response reason phrase encryptioncertificate string output field encryptioncertificate 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 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 id number unique identifier name string name of the resource description string output field description permissions array output field permissions entityname string name of the resource action string output field action entityids array unique identifier 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 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" \[], "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 input argument name type required description infrastructureid string required unique identifier directoryid string required unique identifier id string required unique identifier output parameter type description 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 name string name of the resource value string value for the parameter description object output field description template string output field template replacements array output field replacements name string name of the resource valuetype string type of the resource 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 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 input argument name type required description directoryid string required unique identifier infrastructureid string required unique identifier id string required unique identifier output parameter type description 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 name string name of the resource value string value for the parameter valuetype string type of the resource 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 input argument name type required description id string required unique identifier output parameter type description 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 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 input argument name type required description profileid string required unique identifier attacktypeid string required unique identifier staged string optional parameter for get all attack type options related to a profile output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] get all attacks get all attacks endpoint url api/profiles/{{profileid}}/attacks method get input argument name type required description input argument name type required description profileid string required unique identifier attacktypeids array optional unique identifier dateend string optional parameter for get all attacks datestart string optional parameter for get all attacks includeclosed string optional parameter for get all attacks limit string optional parameter for get all attacks order string optional parameter for get all attacks resourcetype string required type of the resource resourcevalue string required value for the parameter search string optional parameter for get all attacks output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] 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 input argument name type required description profileid string required unique identifier checkerid string required unique identifier perpage string optional parameter for get all deviances by checker page string optional parameter for get all deviances by checker batchsize string optional parameter for get all deviances by checker lastidentifierseen string optional unique identifier expression object required parameter for get all deviances by checker output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] 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 input argument name type required description profileid string required unique identifier infrastructureid string required unique identifier directoryid string required unique identifier eventid string required unique identifier perpage string optional parameter for get all deviances by eventid page string optional parameter for get all deviances by eventid checkers array required parameter for get all deviances by eventid reasons array required response reason phrase output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] 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 input argument name type required description profileid string required unique identifier infrastructureid string required unique identifier directoryid string required unique identifier checkerid string required unique identifier perpage string optional parameter for get all deviances by single directory and checker page string optional parameter for get all deviances by single directory and checker output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] 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 input argument name type required description directoryid string required unique identifier infrastructureid string required unique identifier page string optional parameter for get all deviances for a directory perpage string optional parameter for get all deviances for a directory batchsize string optional parameter for get all deviances for a directory lastidentifierseen string optional unique identifier resolved string optional parameter for get all deviances for a directory output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] 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 output parameter type description status code number http status code of the response reason string response reason phrase embedded object output field embedded deviance array output field deviance 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 name string name of the resource value string value for the parameter description object output field description template string output field template replacements array output field replacements name string name of the resource valuetype string type of the resource 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" {} } } ] 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 input argument name type required description infrastructureid string required unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] get all users get all users endpoint url api/users method get output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] get attack type configuration get the attack type configuration endpoint url api/attack type configuration method get output parameter type description 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 attacktypeid number unique identifier directoryid number unique identifier detectedevents boolean output field detectedevents autodisabledforperfat string output field autodisabledforperfat permissions object output field permissions canedit boolean output field canedit 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" {} } } ] get attack types get attack types endpoint url api/attack types method get output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] get category instance by id get category instance by id endpoint url api/categories/{{id}} method get input argument name type required description input argument name type required description id string required unique identifier output parameter type description 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 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 input argument name type required description id string required unique identifier output parameter type description 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 detail string output field detail attackerknowntools array output field attackerknowntools name string name of the resource url string url endpoint for the request author string output field author resources array output field resources name string name of the resource url string url endpoint for the request type string type of the resource recommendation object output field recommendation name string name of the resource description string output field description execsummary string output field execsummary detail string output field detail 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" {}, "attackerknowntools" \[], "resources" \[], "recommendation" {} } } ] get dashboard instance by id get dashboard instance by id endpoint url api/dashboards/{{id}} method get input argument name type required description input argument name type required description id string required unique identifier output parameter type description 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 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 input argument name type required description infrastructureid string required unique identifier id string required unique identifier output parameter type description 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 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" true } } ] 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 input argument name type required description infrastructureid string required unique identifier id string required unique identifier output parameter type description 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 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" true } } ] 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 input argument name type required description id string required unique identifier output parameter type description 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 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 } } ] 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 input argument name type required description infrastructureid string required unique identifier directoryid string required unique identifier id string required unique identifier output parameter type description 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 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 input argument name type required description id string required unique identifier output parameter type description 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 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" \[] } } ] 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 input argument name type required description directoryid string required unique identifier infrastructureid string required unique identifier id string required unique identifier eventid string required unique identifier output parameter type description 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 name string name of the resource value string value for the parameter valuetype string type of the resource 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 input argument name type required description infrastructureid string required unique identifier directoryid string required unique identifier eventid string required unique identifier id string required unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] get role instance by id get role instance by id endpoint url api/roles/{{id}} method get input argument name type required description input argument name type required description id string required unique identifier output parameter type description 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 entityname string name of the resource action string output field action entityids array unique identifier dynamicid string unique identifier 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 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 name string name of the resource defaultprofileid number unique identifier defaultroleids array unique identifier 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 input argument name type required description id string required unique identifier output parameter type description 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 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 } } ] get the application settings get the application settings endpoint url api/application settings method get output parameter type description 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 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" \[], "defaultprofileid" 0, "internalcertificate" "string", "telemetryenabled" true, "ioaautomaticconfiguration" true } } ] 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 input argument name type required description id string required unique identifier output parameter type description 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 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 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 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 input argument name type required description id string required unique identifier output parameter type description 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 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 } } ] logs in a user logs in a user endpoint url api/login method post input argument name type required description input argument name type required description password string required parameter for logs in a user email string required parameter for logs in a user output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase authtoken string output field authtoken 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 output parameter type description status code number http status code of the response reason string response reason phrase 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 input argument name type required description id string required unique identifier entityname string required name of the resource action string required parameter for replace permission list for a role entityids array required unique identifier dynamicid string optional unique identifier output parameter type description 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 entityname string name of the resource action string output field action entityids array unique identifier dynamicid string unique identifier 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 input argument name type required description id string required unique identifier roles array required parameter for replace role list for a user output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase roles array output field roles 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" \[] } } ] retrieve all alert instances retrieve all alert instances endpoint url api/profiles/{{profileid}}/alerts method get input argument name type required description input argument name type required description profileid string required unique identifier archived boolean optional parameter for retrieve all alert instances read boolean optional parameter for retrieve all alert instances perpage string optional parameter for retrieve all alert instances page string optional parameter for retrieve all alert instances output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] retrieve all category instances retrieve all category instances endpoint url api/categories method get output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] retrieve all checker instances retrieve all checker instances endpoint url api/checkers method get output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] retrieve all dashboard instances retrieve all dashboard instances endpoint url api/dashboards method get output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] retrieve all directory instances retrieve all directory instances endpoint url api/directories method get output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] retrieve all email notifier instances retrieve all email notifier instances endpoint url api/email notifiers method get output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] retrieve all infrastructure instances retrieve all infrastructure instances endpoint url api/infrastructures method get output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] retrieve all role instances retrieve all role instances endpoint url api/roles method get output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] retrieve all syslog instances retrieve all syslog instances endpoint url api/syslogs method get output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] 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 input argument name type required description profileid string required unique identifier checkerid string required unique identifier id string required unique identifier showignored string optional parameter for retrieve an ad object by id profile and checker output parameter type description 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 name string name of the resource value string value for the parameter valuetype string type of the resource reasons array response reason phrase 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" \[] } } ] 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 output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] 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 output parameter type description status code number http status code of the response reason string response reason phrase embedded object output field embedded ad object array output field ad object id number unique identifier directoryid number unique identifier objectid string unique identifier type string type of the resource objectattributes array output field objectattributes name string name of the resource value string value for the parameter valuetype string type of the resource links object output field links next string output field next additionalprop object output field additionalprop 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" {}, " links" {} } } ] 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 input argument name type required description profileid string required unique identifier checkerid string required unique identifier perpage string optional parameter for search all ad objects by profile by checker page string optional parameter for search all ad objects by profile by checker expression object required parameter for search all ad objects by profile by checker directories array required parameter for search all ad objects by profile by checker reasons array required 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 required parameter for search all ad objects by profile by checker output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] 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 input argument name type required description profileid string required unique identifier checkerid string required unique identifier adobjectid string required unique identifier perpage string optional parameter for search all deviances by profile by checker page string optional parameter for search all deviances by profile by checker 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 required parameter for search all deviances by profile by checker output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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" \[ {} ] } ] search events instances search events instances endpoint url api/events/search method get input argument name type required description input argument name type required description expression object required parameter for search events instances order object optional parameter for search events instances column string optional parameter for search events instances direction string optional parameter for search events instances profileid number required unique identifier directoryids array required unique identifier datestart string required parameter for search events instances dateend string required parameter for search events instances output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 send a test email notification endpoint url api/email notifiers/test message method post input argument name type required description 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 required 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 output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 input argument name type required description id string required unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 input argument name type required description checkers array optional parameter for send a test syslog notification profiles array required 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 output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 input argument name type required description id string required unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 input argument name type required description oldpassword string required parameter for update a user's password newpassword string required parameter for update a user's password output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 input argument name type required description infrastructureid string required unique identifier directoryid string required unique identifier id string required unique identifier ignoreuntil string optional parameter for update ad object deviance history instance output parameter type description 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 name string name of the resource value string value for the parameter description object output field description template string output field template replacements array output field replacements name string name of the resource valuetype string type of the resource 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" {} } } ] update alert instance update alert instance endpoint url api/alerts/{{id}} method patch input argument name type required description input argument name type required description id string required unique identifier archived boolean optional parameter for update alert instance read boolean optional parameter for update alert instance output parameter type description 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 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 input argument name type required description profileid string required unique identifier archived boolean optional parameter for update alerts for one profile read boolean optional parameter for update alerts for one profile output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 input argument name type required description id string required unique identifier name string optional name of the resource order number optional parameter for update dashboard instance output parameter type description 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 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 input argument name type required description infrastructureid string required unique identifier id string required unique identifier 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 output parameter type description 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 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" true } } ] update email notifier instance update email notifier instance endpoint url api/email notifiers/{{id}} method patch input argument name type required description input argument name type required description id string required unique identifier 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 output parameter type description 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 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 } } ] update infrastructure instance update infrastructure instance endpoint url api/infrastructures/{{id}} method patch input argument name type required description input argument name type required description id string required unique identifier name string optional name of the resource login string optional parameter for update infrastructure instance password string optional parameter for update infrastructure instance output parameter type description 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 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 input argument name type required description profileid string required unique identifier checkerid string required unique identifier profileid string required unique identifier checkerid string required unique identifier ignoreuntil string required parameter for update instances matching a checkerid output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 input argument name type required description id string required unique identifier name string optional name of the resource description string optional parameter for update role instance output parameter type description 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 entityname string name of the resource action string output field action entityids array unique identifier dynamicid string unique identifier 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 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 name string required name of the resource defaultprofileid number required unique identifier defaultroleids string required unique identifier output parameter type description 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 name string name of the resource defaultprofileid number unique identifier defaultroleids array unique identifier 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 input argument name type required description id string required unique identifier 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 output parameter type description 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 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 } } ] update the application settings update the application settings endpoint url api/application settings method patch input argument name type required description 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 output parameter type description 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 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" \[], "defaultprofileid" 0, "internalcertificate" "string", "telemetryenabled" true, "ioaautomaticconfiguration" true } } ] 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 input argument name type required description configuration array optional parameter for update the attack type configuration and workload attacktypeid number required unique identifier directoryid number required unique identifier maxworkloadquota number optional parameter for update the attack type configuration and workload output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 input argument name type required description profileid string required unique identifier checkerid string required unique identifier adobjectid string required unique identifier profileid string required unique identifier checkerid string required unique identifier adobjectid string required unique identifier ignoreuntil string required parameter for update the deviances emitted ad object and checker output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 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 output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase 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 input argument name type required description id string required unique identifier 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 output parameter type description 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 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 } } ] 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