Cyera

cyera is a data security platform that provides visibility and control over sensitive data across various environments cyera is a comprehensive data security platform that helps organizations manage and protect their sensitive data across various environments the cyera connector for swimlane turbine enables seamless integration to automate data security and compliance tasks with this integration, users can efficiently manage datastore ownership, retrieve and update classifications, and handle issues related to data security this empowers security teams to enhance their data protection strategies and streamline operations within the swimlane turbine platform limitations none to date supported versions this cyera connector uses the version 1 and 3 api prerequisites before you can use the cyera connector for turbine, you'll need access to the cyera api this requires the following authentication using client id and secret url the endpoint url for accessing cyera's api client id a unique identifier for your application to authenticate with cyera secret a secret key used in conjunction with the client id for authentication authentication methods url the endpoint url for the cyera api client id the api key your unique identifier to authenticate with the cyera api secret the api secret associated with your client id for secure access capabilities this cyera connector provides the following capabilities add datastore owner datastore classifications datastore objects get all objects for a specific issue get classifications for a specific issue get issues identity classifications identity datastores issue classifications issue identities issue objects list datastores list identities remove datastore owner send to scan and so on get all objects for a specific issue retrieves all objects associated with a specific issue in cyera, using the issue's unique identifier and supports pagination with limit and offset cyera's documentation for this action can be found here https //api cyera io/#/issues/issuecontroller findobjects get classifications for a specific issue retrieve all classifications for a given issue in cyera, specified by uid with optional limit and offset parameters cyera's documentation for this action can be found here https //api cyera io/#/issues/issuecontroller findclassifications get issues retrieves a list of issues from cyera with optional limit and offset parameters to control pagination cyera's documentation for this action can be found here https //api cyera io/#/issues/issuecontroller findallv3 additional documentation cyera connector documentation https //docs swimlane com/connectors/cyeracyera api documentation https //api cyera io/#/authentication/authcontroller login configurations cyera api authentication authentication using client id and secret configuration parameters parameter description type required url a url to the target host string required clientid the api key string required secret the api secret string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions add datastore owner assign a new owner to a specific datastore in cyera requires a json body with the 'items' parameter endpoint url v1/datastore owners method post input argument name type required description items array optional parameter for add datastore owner items email string required the email of the owner items ownertype string required the type of owner items datastoreuid string required the uid of the datastore input example {"json body" {"items" \[{"email" "john doe\@example com","ownertype" "application owner","datastoreuid" "02e98ba7 92d8 4107 b7bf 13fc301aa874"}]}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text output example {"status code" 201,"response headers" {},"reason" "created","response text" ""} datastore classifications retrieve classifications for a specific datastore in cyera using the unique identifier (uid) as a path parameter endpoint url /v1/datastores/{{uid}}/classifications method get input argument name type required description parameters limit number optional limit the number of results (min 1, max 1000) parameters offset number optional offset within total existing results (min 0) path parameters uid string required related datastore uuid input example {"parameters" {"limit" 10,"offset" 0},"path parameters" {"uid" "3b4d83a8 1fe3 498d b3d6 8cb15feceabc"}} output parameter type description status code number http status code of the response reason string response reason phrase limit number output field limit offset number output field offset total number output field total results array result of the operation results dataclassname string response data results classificationname string name of the resource results datacategory string response data results collections array result of the operation results customcollections array result of the operation results uid string unique identifier results sensitivity string result of the operation results sensitivitydisplayname string name of the resource results defaultsensitivity string result of the operation results defaultsensitivitydisplayname string name of the resource results context object result of the operation results context role string result of the operation results context tokenization string result of the operation results context geolocations array result of the operation results context synthetic boolean result of the operation results context datasubjectage string response data results context businesscontext array result of the operation results context businesscontext key string result of the operation results context businesscontext value string value for the parameter output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"limit" 10,"offset" 0,"total" 1,"results" \[{}]}} datastore objects retrieve all supported objects for a specific datastore in cyera, including unclassified objects requires the uid as a path parameter endpoint url /v2/datastores/{{uid}}/objects method get input argument name type required description parameters limit number optional limit the number of results (min 1, max 1000) parameters offset number optional offset within total existing results (min 0) parameters filename string optional search by text that contained inside the filename or the relativepath parameters returnfilesignatures boolean optional return file signatures for the objects path parameters uid string required related datastore uuid input example {"parameters" {"limit" 10,"offset" 0,"filename" "test txt","returnfilesignatures"\ true},"path parameters" {"uid" "3b4d83a8 1fe3 498d b3d6 8cb15feceabc"}} output parameter type description status code number http status code of the response reason string response reason phrase type string type of the resource results array result of the operation results uid string unique identifier results name string name of the resource results rowcount number result of the operation results sensitiverecordscount number result of the operation results dbname string name of the resource results creationdate object result of the operation results tablelevelclassifications array result of the operation results tablelevelclassifications file name string name of the resource results tablelevelclassifications file string result of the operation results sensitivity string result of the operation results sensitivitydisplayname string name of the resource results classifications array result of the operation results classifications uid string unique identifier results classifications name string name of the resource results classifications sensitivity string result of the operation results classifications sensitivitydisplayname string name of the resource results classifications defaultsensitivity string result of the operation results classifications defaultsensitivitydisplayname string name of the resource results classifications context object result of the operation results classifications context role object result of the operation results classifications context tokenization string result of the operation output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"type" "tables","results" \[{}],"offset" 0,"limit" 100,"total" 156}} get all objects for a specific issue retrieve all objects linked to a specific issue in cyera using its unique id supports pagination with limit and offset parameters endpoint url /v1/issues/{{uid}}/objects method get input argument name type required description path parameters uid string required uuid parameters limit number required limit the number of results (min 1, max 500) parameters offset number required offset within total existing results (min 0) parameters filename string optional search by text that contained inside the filename or the relativepath parameters classificationuid string optional search objects which contain the classification uid input example {"parameters" {"limit" 10,"offset" 0,"filename" "","classificationuid" ""},"path parameters" {"uid" "02e98ba7 92d8 4107 b7bf 13fc301aa874"}} output parameter type description status code number http status code of the response reason string response reason phrase offset number output field offset limit number output field limit results array result of the operation results type string type of the resource results results array result of the operation results results uid string unique identifier results results name string name of the resource results results rowcount number result of the operation results results sensitiverecordscount number result of the operation results results dbname string name of the resource results results creationdate string result of the operation results results tablelevelclassifications array result of the operation results results tablelevelclassifications uid string unique identifier results results tablelevelclassifications classificationname string name of the resource results results tablelevelclassifications defaultsensitivity string result of the operation results results tablelevelclassifications sensitivity string result of the operation results results sensitivity string result of the operation results results classifications array result of the operation results results classifications uid string unique identifier results results classifications classificationname string name of the resource results results classifications defaultsensitivity string result of the operation results results classifications sensitivity string result of the operation results results classifications recordscount number result of the operation output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "fri, 25 apr 2025 20 37 23 gmt"},"reason" "ok","json body" {"offset" 0,"limit" 10,"results" \[{}]}} get classifications for a specific issue retrieve classifications for a specific issue in cyera using the uid, with options to limit and offset results endpoint url /v1/issues/{{uid}}/classifications method get input argument name type required description path parameters uid string required uuid parameters limit number required limit the number of results (min 1, max 100) parameters offset number required offset within total existing results (min 0) input example {"parameters" {"limit" 10,"offset" 0},"path parameters" {"uid" "02e98ba7 92d8 4107 b7bf 13fc301aa874"}} output parameter type description status code number http status code of the response reason string response reason phrase limit number output field limit offset number output field offset total number output field total results array result of the operation results datacategory string response data results collections array result of the operation results customcollections array result of the operation results uid string unique identifier results name string name of the resource results sensitivity string result of the operation results sensitivitydisplayname string name of the resource results defaultsensitivity string result of the operation results defaultsensitivitydisplayname string name of the resource results context object result of the operation results context role string result of the operation results context tokenization string result of the operation results context geolocations array result of the operation results context synthetic boolean result of the operation results context datasubjectage string response data results context businesscontext array result of the operation results context businesscontext key string result of the operation results context businesscontext value string value for the parameter results context identified boolean unique identifier output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "fri, 25 apr 2025 20 37 23 gmt"},"reason" "ok","json body" {"limit" 10,"offset" 0,"total" 1,"results" \[{}]}} get issues retrieve a paginated list of issues from cyera using 'limit' and 'offset' parameters to control the volume of results endpoint url /v3/issues method get input argument name type required description parameters limit number required limit the number of results (min 1, max 100) parameters offset number required offset within total existing results (min 0) parameters datastoreuid string optional related datastore uid parameters createddate string optional issue's creation time (equals to, or later than) parameters updateddate string optional issue's last update time (equals to, or later than) parameters severity string optional issue's severity parameters status string optional issue status input example {"parameters" {"limit" 10,"offset" 0,"datastoreuid" "379661c3 ad91 4691 ab58 8704ff5f6a9e","createddate" "2024 01 01t00 00 00 000z","updateddate" "2024 02 01t00 00 00 000z","severity" "high","status" "open"}} output parameter type description status code number http status code of the response reason string response reason phrase limit number output field limit offset number output field offset total number output field total results array result of the operation results provider string unique identifier results infrastructure string result of the operation results engine string result of the operation results regions array result of the operation results owner string result of the operation results account object result of the operation results account inplatformidentifier string unique identifier results account name string name of the resource results classificationgroups array result of the operation results cloudprovidertags array unique identifier results cloudprovidertags key string unique identifier results cloudprovidertags value string unique identifier results uid string unique identifier results name string name of the resource results severity string result of the operation results createddate string result of the operation results updateddate string result of the operation results status string status value results riskstatus string status value output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "fri, 25 apr 2025 20 37 23 gmt"},"reason" "ok","json body" {"limit" 10,"offset" 0,"total" 1,"results" \[{}]}} identity classifications return the classifications for a specific identity in cyera using the unique identifier (uid) as a path parameter endpoint url /v1/identities/{{uid}}/classifications method get input argument name type required description parameters limit number optional limit the number of results (min 1, max 1000) parameters offset number optional offset within total existing results (min 0) path parameters uid string required identity uuid input example {"parameters" {"limit" 10,"offset" 0},"path parameters" {"uid" "3b4d83a8 1fe3 498d b3d6 8cb15feceabc"}} output parameter type description status code number http status code of the response reason string response reason phrase limit number output field limit offset number output field offset total number output field total results array result of the operation results uid string unique identifier results name string name of the resource results sensitivity string result of the operation results sensitivitydisplayname string name of the resource results defaultsensitivity string result of the operation results defaultsensitivitydisplayname string name of the resource results context object result of the operation results context role string result of the operation results context tokenization string result of the operation results context geolocations array result of the operation results context synthetic boolean result of the operation results context datasubjectage string response data results context businesscontext array result of the operation results context businesscontext file name string name of the resource results context businesscontext file string result of the operation results context identified boolean unique identifier results context identifiability string unique identifier results classificationgroup string result of the operation results datacategory string response data output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"limit" 12,"offset" 0,"total" 1033,"results" \[{"uid" "a1b2c3d4 e5f6 7890 abcd 111111111111","name" "bank account number","sensitivity" "sensitive","sensitivitydisplayname" "confidential","defaultsensitivity" "sensitive","defaultsensitivitydisplayname" "confidential","context" {"role"\ null,"tokenization" "plain","geolocations" \["canada"],"synthetic"\ false,"datasubjectage" "none","businesscontext" \[],"identified"\ true,"identifiabi identity datastores return datastores accessible to an identity with access scoped sensitive data information, including privileges, accessible sensitive records count, and data classifications requires uid as a path parameter endpoint url /v1/identities/{{uid}}/datastores method get input argument name type required description parameters limit integer optional limit the number of results (min 1, max 1000) parameters offset integer optional offset within total existing results (min 0) parameters searchterm string optional search term for datastore name (includes operator, case insensitive) parameters cloudproviders string optional list of cloud providers (delimited by comma separator ",") valid values aws, azure, gcp, snowflake, microsoft365, atlas, mongo atlas, salesforce, box, google workspace, oci, databricks, dropbox, jira, github, dlp, workday, on prem, cockroachdb, yugabyte aeon, yugabyte anywhere, okta, servicenow, airtable, confluence, netskope, zscaler, purview, copilotstudio parameters infrastructures string optional filter by infrastructure types (delimited by comma separator ",") valid values ec2, rds, s3, on prem, elastic cache, dynamo db, bigquery, gcp storage, gcp cloud sql, google drive, exchange online mailbox, azure sql database, azure blob storage, azure file share, azure sql managed instance, cloud sql, azure vm sql, azure database server, redshift, onedrive, snowflake, atlas cluster, azure vm, opensearch, databricks, cosmos db, azure redis cache, on prem file share, netapp on prem smb file share, powerscale on prem smb file share, on prem nfs file share, box, crdb, yugabyte aeon, yugabyte anywhere, salesforce unstructured, salesforce structured, salesforce object, service now table, oracle autonomous database, confluence space, jira project parameters sensitivities string optional filter by sensitivities (delimited by comma separator ",") valid values verysensitive, sensitive, internal, notsensitive, unclassified parameters classificationgroups string optional filter by classification groups (delimited by comma separator ",") valid values personal, health, financial, it & security, business & ip parameters regions string optional filter by regions (delimited by comma separator ",") path parameters uid string required identity unique identifier input example {"parameters" {"limit" 10,"offset" 0,"searchterm" "prod db","cloudproviders" "aws","infrastructures" "rds","sensitivities" "verysensitive","classificationgroups" "personal","regions" "us east 1"},"path parameters" {"uid" "3b4d83a8 1fe3 498d b3d6 8cb15feceabc"}} output parameter type description status code number http status code of the response reason string response reason phrase limit number output field limit offset number output field offset total number output field total results array result of the operation results uid string unique identifier results name string name of the resource results type string type of the resource results datatype string response data results infrastructure string result of the operation results engine string result of the operation results regions array result of the operation results provider string unique identifier results account object result of the operation results account uid string unique identifier results account name string name of the resource results account platform string result of the operation results discovereddate string result of the operation results createddate string result of the operation results ghost boolean result of the operation results permissions array result of the operation results sensitiverecords number result of the operation results sensitivity string result of the operation results sensitivitydisplayname string name of the resource output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"limit" 10,"offset" 0,"total" 1,"results" \[{}]}} issue classifications return all classifications for a specific issue in cyera using the unique identifier (uid) as a path parameter endpoint url v1/issues/{{uid}}/classifications method get input argument name type required description parameters limit number optional limit the number of results (min 1, max 100) parameters offset number optional offset within total existing results (min 0) path parameters uid string required uuid input example {"parameters" {"limit" 10,"offset" 0},"path parameters" {"uid" "02e98ba7 92d8 4107 b7bf 13fc301aa874"}} output parameter type description status code number http status code of the response reason string response reason phrase limit number output field limit offset number output field offset total number output field total results array result of the operation results dataclassname string response data results classificationname string name of the resource results datacategory string response data results collections array result of the operation results customcollections array result of the operation results uid string unique identifier results sensitivity string result of the operation results sensitivitydisplayname string name of the resource results defaultsensitivity string result of the operation results defaultsensitivitydisplayname string name of the resource results context object result of the operation results context role string result of the operation results context tokenization string result of the operation results context geolocations array result of the operation results context synthetic boolean result of the operation results context datasubjectage string response data results context businesscontext array result of the operation results context businesscontext key string result of the operation results context businesscontext value string value for the parameter output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"limit" 10,"offset" 0,"total" 1,"results" \[{}]}} issue identities get identities associated with a specific issue in cyera using the unique identifier (uid) as a path parameter endpoint url /v1/issues/{{uid}}/identities method get input argument name type required description parameters limit number optional limit the number of results (min 1, max 1000) parameters offset number optional offset within total existing results (min 0) parameters identityname string optional identity name (includes operator, case insensitive) parameters identitytypes string optional identity types (delimited by comma separator ",") valid values user, role, group, account, tenant, localdbuser, app, managed, global, serviceaccount, domain parameters identitytrustlevels string optional identity trust levels (delimited by comma separator ",") valid values trusted, externaltrusted, external, public parameters identityproviders string optional identity providers (delimited by comma separator ",") valid values atlas, awsiam, microsoftentraid, googlesuite, snowflake, anonymous, external, sharepoint, box, googlecloudproject, okta, awssso, activedirectory, aiasset, salesforce, confluence parameters isstaleidentity string optional is the identity stale (i e , not active in the last 90 days)? parameters isdisabledidentity string optional is the identity disabled? parameters isrisky string optional is the identity marked as risky? parameters identitydepartments string optional identity's organizational info department (delimited by comma separator ',') parameters identityofficelocations string optional identity's organizational info office location (delimited by comma separator ',') parameters identitycountries string optional identity's organizational info country (delimited by comma separator ',') parameters identityjobtitles string optional identity's organizational info job title (delimited by comma separator ',') parameters mfastatus string optional identity multi factor authentication status parameters m365copilotstatus string optional microsoft 365 copilot access status parameters datastorecloudproviders string optional list of datastore cloud providers (delimited by comma separator ",") valid values aws, azure, gcp, snowflake, microsoft365, atlas, mongo atlas, salesforce, box, google workspace, oci, databricks, dropbox, jira, github, dlp, workday, on prem, cockroachdb, yugabyte aeon, yugabyte anywhere, okta, servicenow, airtable, confluence, netskope, zscaler, purview, copilotstudio parameters datastoreinfrastructures string optional list of infrastructures (delimited by comma separator ",") valid values ec2, rds, s3, on prem, elastic cache, dynamo db, bigquery, gcp storage, gcp cloud sql, google drive, exchange online mailbox, azure sql database, azure blob storage, azure file share, azure sql managed instance, cloud sql, azure vm sql, azure database server, redshift, onedrive, snowflake, atlas cluster, azure vm, opensearch, databricks, cosmos db, azure redis cache, on prem file share, netapp on prem smb file share, powerscale on prem smb file share, on prem nfs file share, box, crdb, yugabyte aeon, yugabyte anywhere, salesforce unstructured, salesforce structured, salesforce object, service now table, oracle autonomous database, confluence space, jira project parameters datastorename string optional datastore name ("includes" operator, case insensitive) parameters accountinplatformidentifiers string optional account's platform identifier (e g aws account id) parameters classificationsensitivities string optional sensitivities of classifications the identity has access to (delimited by comma separator ",") valid values verysensitive, sensitive, internal, notsensitive, unclassified parameters classificationsnames string optional data classes the identity has access to (delimited by comma separator ',') parameters classificationgroups string optional categories of classifications the identity has access to (delimited by comma separator ",") valid values personal, health, financial, it & security, business & ip parameters classificationroles string optional roles of classifications the identity has access to (delimited by comma separator ",") parameters classificationgeolocation string optional geolocation of classifications the identity has access to (delimited by comma separator ",") parameters groupmember string optional group member (includes operator, case insensitive) input example {"parameters" {"limit" 10,"offset" 0,"identityname" "john doe","identitytypes" "managed","identitytrustlevels" "trusted","identityproviders" "okta","isstaleidentity" "true","isdisabledidentity" "true","isrisky" "true","identitydepartments" "","identityofficelocations" "","identitycountries" "","identityjobtitles" "","mfastatus" "'enabled' | 'disabled' | 'unknown'","m365copilotstatus" "'enabled' | 'disabled'","datastorecloudproviders" "aws","datastoreinfrastructures" "s3","datastorename" "mysqldb","accountinplatformidentifiers" "012345678901","classificationsensitivities" "verysensitive","classificationsnames" "","classificationgroups" "health","classificationroles" "","classificationgeolocation" "","groupmember" "group uid 123","groupincludes" "identity uid 123","groupsizegte" "100","groupsizelte" "1000","creationdategte" "2024 01 01t00 00 00 000z","creationdatelt" "2024 01 01t00 00 00 000z","passwordrotationgte" "2024 01 01t00 00 00 000z","passwordrotationlt" "2024 01 01t00 00 00 000z","isdeleted" "true","deletiondategte" "2024 01 01t00 00 00 000z","deletiondatelt" "2024 01 01t00 00 00 000z","disabledategte" "2024 01 01t00 00 00 000z","disabledatelt" "2024 01 01t00 00 00 000z"},"path parameters" {"uid" "02e98ba7 92d8 4107 b7bf 13fc301aa874"}} output parameter type description status code number http status code of the response reason string response reason phrase limit number output field limit offset number output field offset total number output field total results array result of the operation results uid string unique identifier results displayname string name of the resource results displayid string unique identifier results category string result of the operation results trustlevel string result of the operation results scopenamespace string name of the resource results scopedisplayname string name of the resource results scopeid string unique identifier results isstale boolean result of the operation results isenabled boolean result of the operation results hascopilot boolean result of the operation results hasmultipleparents boolean result of the operation results memberscount number result of the operation results reportsto string result of the operation results managerid string unique identifier results multifactorauthenticationstatus string status value results lastactivetime string result of the operation results creationtime string result of the operation results lastpasswordupdatetime string result of the operation output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"limit" 10,"offset" 0,"total" 1,"results" \[{}]}} issue objects return all supported objects for a specific issue in cyera, including unclassified objects requires the unique identifier (uid) as a path parameter endpoint url /v1/issues/{{uid}}/objects method get input argument name type required description parameters limit number optional limit the number of results (min 1, max 500) parameters offset number optional offset within total existing results (min 0) parameters filename string optional search by text that contained inside the filename or the relativepath parameters classificationuid string optional search objects which contain the classification uid parameters returnfilesignatures boolean optional return file signatures for the objects path parameters uid string required uuid input example {"parameters" {"limit" 10,"offset" 0,"filename" "test txt","classificationuid" "3b4d83a8 1fe3 498d b3d6 8cb15feceabc","returnfilesignatures"\ true},"path parameters" {"uid" "02e98ba7 92d8 4107 b7bf 13fc301aa874"}} output parameter type description status code number http status code of the response reason string response reason phrase limit number output field limit offset number output field offset total number output field total results array result of the operation results uid string unique identifier results name string name of the resource results rowcount number result of the operation results sensitiverecordscount number result of the operation results creationdate string result of the operation results sensitivity string result of the operation results sensitivitydisplayname string name of the resource results dbname string name of the resource results schemaname string name of the resource results tablelevelclassifications array result of the operation results tablelevelclassifications dataclassname string response data results tablelevelclassifications classificationname string name of the resource results tablelevelclassifications datacategory string response data results tablelevelclassifications collections array result of the operation results tablelevelclassifications customcollections array result of the operation results tablelevelclassifications uid string unique identifier results tablelevelclassifications sensitivity string result of the operation results tablelevelclassifications sensitivitydisplayname string name of the resource results tablelevelclassifications defaultsensitivity string result of the operation output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"limit" 10,"offset" 0,"total" 1,"results" \[{}],"type" "tables"}} list datastores return a list of datastores in cyera based on the specified filters endpoint url v2/datastores method get input argument name type required description parameters limit integer optional limit the number of results (min 1, max 1000) parameters offset integer optional offset within total existing results (min 0) parameters provider string optional account platform parameters infrastructure string optional list of infrastructures (delimited by comma separator ",") parameters scanningstatestatus string optional list of scanning state status (delimited by comma separator ",") parameters lastdatarefreshgte string optional the start time of the latest datascan greater than or equal to parameters lastdatarefreshlte string optional the start time of the latest datascan less than or equal to parameters lastmodifiedtimegte string optional last modified time greater than or equal to parameters lastmodifiedtimelte string optional last modified time less than or equal to parameters discovereddategte string optional discovered date greater than or equal to parameters discovereddatelte string optional discovered date less than or equal to parameters name string optional datastore name ("includes" operator, case insensitive) parameters regions string optional list of regions (delimited by comma separator ",") parameters datatype string optional datastore data type parameters createddate string optional date where datastore was created (equals to, or later than) parameters cloudproviderurl string optional cloud provider url parameters datastoresizeingib number optional the total size of the data in gib (applies to unstructured datastores only) parameters projectids string optional list of project ids (delimited by comma separator ",") parameters inplatformidentifier string optional account's platform identifier (e g aws account id) parameters nameregex string optional a case insensitive datastore name regex pattern; for example, use "^(?! test)" to exclude names containing test or "test" to include them, and if both name and nameregex are provided, name takes precedence parameters uid string optional datastore uids (delimited by comma separator ",") parameters engine string optional list of engines (delimited by comma separator ",") parameters wasscanned boolean optional filter datastores that were scanned (true) or not scanned (false) parameters includesoftdeleteddatastores boolean optional include datastores that were previously discovered but are now deleted input example {"parameters" {"limit" 123,"offset" 123,"provider" "string","infrastructure" "string","scanningstatestatus" "active","lastdatarefreshgte" "string","lastdatarefreshlte" "string","lastmodifiedtimegte" "string","lastmodifiedtimelte" "string","discovereddategte" "string","discovereddatelte" "string","name" "example name","regions" "string","datatype" "string","createddate" "string","cloudproviderurl" "string","datastoresizeingib" 123,"projectids" "string","inplatformidentifier" "string","nameregex" "example name","uid" "string","engine" "string","wasscanned"\ true,"includesoftdeleteddatastores"\ true}} output parameter type description status code number http status code of the response reason string response reason phrase limit number output field limit offset number output field offset total number output field total results array result of the operation results name string name of the resource results discovereddate string result of the operation results provider string unique identifier results uid string unique identifier results type string type of the resource results datatype string response data results infrastructure string result of the operation results engine string result of the operation results cloudproviderurl string url endpoint for the request results scanningstate string result of the operation results ghost boolean result of the operation results vpc string result of the operation results owner object result of the operation results cloudprovidertags array unique identifier results cloudprovidertags file name string unique identifier results cloudprovidertags file string unique identifier results collections array result of the operation results collections file name string name of the resource results collections file string result of the operation output example {"limit" 123,"offset" 123,"total" 123,"results" \[{"name" "example name","discovereddate" "string","provider" "string","uid" "string","type" "string","datatype" "string","infrastructure" "string","engine" "string","cloudproviderurl" "string","scanningstate" "string","ghost"\ true,"vpc" "string","owner" {},"cloudprovidertags" \[],"collections" \[]}]} list identities return a list of identities in cyera based on the specified filters endpoint url /v1/identities method get input argument name type required description parameters limit integer optional limit the number of results (min 1, max 1000) parameters offset integer optional offset within total existing results (min 0) parameters identityname string optional identity names ("includes" operator, case insensitive) parameters identitytypes string optional identity types (delimited by comma separator ",") valid values user, role, group, account, tenant, localdbuser, app, managed, global, serviceaccount, domain parameters identitytrustlevels string optional identity trust levels (delimited by comma separator ",") valid values trusted, externaltrusted, external, public parameters identityproviders string optional identity providers (delimited by comma separator ",") valid values atlas, awsiam, microsoftentraid, googlesuite, snowflake, anonymous, external, sharepoint, box, googlecloudproject, okta, awssso, activedirectory, aiasset, salesforce, confluence parameters isstaleidentity string optional is the identity stale (i e , not active in the last 90 days)? parameters isdisabledidentity string optional is the identity disabled? parameters isrisky string optional is the identity marked as risky? parameters identitydepartments string optional identity's organizational info department (delimited by comma separator ',') parameters identityofficelocations string optional identity's organizational info office location (delimited by comma separator ',') parameters identitycountries string optional identity's organizational info country (delimited by comma separator ',') parameters identityjobtitles string optional identity's organizational info job title (delimited by comma separator ',') parameters mfastatus string optional identity multi factor authentication status parameters m365copilotstatus string optional microsoft 365 copilot access status parameters datastorecloudproviders string optional list of datastore cloud providers (delimited by comma separator ",") valid values aws, azure, gcp, snowflake, microsoft365, atlas, mongo atlas, salesforce, box, google workspace, oci, databricks, dropbox, jira, github, dlp, workday, on prem, cockroachdb, yugabyte aeon, yugabyte anywhere, okta, servicenow, airtable, confluence, netskope, zscaler, purview, copilotstudio parameters datastoreinfrastructures string optional list of infrastructures (delimited by comma separator ",") valid values ec2, rds, s3, on prem, elastic cache, dynamo db, bigquery, gcp storage, gcp cloud sql, google drive, exchange online mailbox, azure sql database, azure blob storage, azure file share, azure sql managed instance, cloud sql, azure vm sql, azure database server, redshift, onedrive, snowflake, atlas cluster, azure vm, opensearch, databricks, cosmos db, azure redis cache, on prem file share, netapp on prem smb file share, powerscale on prem smb file share, on prem nfs file share, box, crdb, yugabyte aeon, yugabyte anywhere, salesforce unstructured, salesforce structured, salesforce object, service now table, oracle autonomous database, confluence space, jira project parameters datastorename string optional datastore name ("includes" operator, case insensitive) parameters accountinplatformidentifiers string optional account's platform identifier (e g aws account id) parameters classificationsensitivities string optional sensitivities of classifications the identity has access to (delimited by comma separator ",") valid values verysensitive, sensitive, internal, notsensitive, unclassified parameters classificationsnames string optional data classes the identity has access to (delimited by comma separator ',') parameters classificationgroups string optional categories of classifications the identity has access to (delimited by comma separator ",") valid values personal, health, financial, it & security, business & ip parameters classificationroles string optional roles of classifications the identity has access to (delimited by comma separator ',') parameters classificationgeolocation string optional subject residency of classifications the identity has access to (delimited by comma separator ',') parameters groupmember string optional filter identities that are members of a specific group identity by uid input example {"parameters" {"limit" 10,"offset" 0,"identityname" "john doe","identitytypes" "managed","identitytrustlevels" "trusted","identityproviders" "okta","isstaleidentity" "true","isdisabledidentity" "true","isrisky" "true","identitydepartments" "","identityofficelocations" "","identitycountries" "","identityjobtitles" "","mfastatus" "'enabled' | 'disabled' | 'unknown'","m365copilotstatus" "'enabled' | 'disabled'","datastorecloudproviders" "aws","datastoreinfrastructures" "s3","datastorename" "mysqldb","accountinplatformidentifiers" "012345678901","classificationsensitivities" "verysensitive","classificationsnames" "","classificationgroups" "health","classificationroles" "","classificationgeolocation" "","groupmember" "group uid 123","groupincludes" "identity uid 123","groupsizegte" "100","groupsizelte" "1000","creationdategte" "2024 01 01t00 00 00 000z","creationdatelt" "2024 01 01t00 00 00 000z","passwordrotationgte" "2024 01 01t00 00 00 000z","passwordrotationlt" "2024 01 01t00 00 00 000z","isdeleted" "true","deletiondategte" "2024 01 01t00 00 00 000z","deletiondatelt" "2024 01 01t00 00 00 000z","disabledategte" "2024 01 01t00 00 00 000z","disabledatelt" "2024 01 01t00 00 00 000z"}} output parameter type description status code number http status code of the response reason string response reason phrase limit number output field limit offset number output field offset total number output field total results array result of the operation results uid string unique identifier results displayname string name of the resource results displayid string unique identifier results category string result of the operation results trustlevel string result of the operation results scopenamespace string name of the resource results scopedisplayname string name of the resource results scopeid string unique identifier results isstale boolean result of the operation results isenabled boolean result of the operation results hascopilot boolean result of the operation results hasmultipleparents boolean result of the operation results memberscount number result of the operation results reportsto string result of the operation results managerid string unique identifier results multifactorauthenticationstatus string status value results lastactivetime string result of the operation results creationtime string result of the operation results lastpasswordupdatetime string result of the operation output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"limit" 10,"offset" 0,"total" 1,"results" \[{}]}} remove datastore owner delete manually assigned datastore owners in cyera using the owner's email address endpoint url v1/datastore owners method delete input argument name type required description email string optional the email of the owner ownertype string optional owner type if undefined, will remove owners regardless of owner type; if null, will only remove owners with null owner type datastoreuids array optional datastore uids if not provided, will remove from all datastores input example {"json body" {"email" "some\@admin com","ownertype" "application owner","datastoreuids" \["02e98ba7 92d8 4107 b7bf 13fc301aa874"]}} output parameter type description status code number http status code of the response reason string response reason phrase deletedowners array output field deletedowners deletedowners email string output field deletedowners email deletedowners ownertype string type of the resource deletedowners datastoreuid string response data deletedowners datastoreowneruid string response data output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"deletedowners" \[{}]}} send to scan send a datastore identified by uid to be scanned in cyera requires json body with datastoreuids endpoint url /v1/datastores/send to scan method post input argument name type required description datastoreuids array optional list of datastore uuids ignorenotfounduids boolean optional ignore datastore uuids that are not found input example {"json body" {"datastoreuids" \["e6eba3bb 8337 935e de31 b0c1412534c8","5f50a103 7b7d 47d0 a01c 221e9b9c66dd"],"ignorenotfounduids"\ true}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text output example {"status code" 200,"response headers" {},"reason" "ok","response text" ""} update datastore owners assign a datastore owner in cyera using the owner's email and ownertype requires uid as path parameter and email in json body endpoint url /v1/datastores/{{uid}}/datastore owners method post input argument name type required description path parameters uid string required related datastore uuid email string optional the email of the owner ownertype string optional the type of owner input example {"json body" {"email" "some\@admin com","ownertype" "application owner"},"path parameters" {"uid" "02e98ba7 92d8 4107 b7bf 13fc301aa874"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text output example {"status code" 201,"response headers" {},"reason" "created","response text" ""} update issue status update the status of a specific issue in cyera using uid and new status endpoint url /v1/issues/{{uid}}/status method put input argument name type required description path parameters uid string required related issue uuid status string optional the new status of the issue resolution string optional issue resolution reason, in case the issue is closed resolutionnote string optional issue resolution note, in case the issue is closed input example {"json body" {"status" "closed","resolution" "acceptrisk","resolutionnote" "the issue closed in version 2 13 0"},"path parameters" {"uid" "3b4d83a8 1fe3 498d b3d6 8cb15feceabc"}} output parameter type description status code number http status code of the response reason string response reason phrase uid string unique identifier output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"uid" "2ad24f34 b859 d1a5 501f 630ad018514a"}} update user tags add or remove user tags from a datastore in cyera using the uid and usertaguid parameters endpoint url /v1/datastores/{{uid}}/user tags method post input argument name type required description path parameters uid string required related datastore uuid usertaguid string optional related user tag uuid input example {"json body" {"usertaguid" "d0d033c7 5cca 48d2 a270 f6848443f4a9"},"path parameters" {"uid" "3b4d83a8 1fe3 498d b3d6 8cb15feceabc"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text output example {"status code" 201,"response headers" {},"reason" "created","response text" ""} 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 thu, 01 jan 2024 00 00 00 gmt