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 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