Template:APITester: Difference between revisions

Line 1:

<html>

var spec = {"openapi":"3.0.3","info":{"title":"BigID API Documentation","description":"The BigID API allows you to access all system functions from an external system or a BigID App. This specification contains the BigID APIs that have been publically released, and we have committed to supporting them long-term. If you find something else within BigID that you want, you're free to use that API as well. Just know that only the APIs within this document are guaranteed to not change between versions.","version":"1.0.0","contact":{"name":"BigID","url":"https://docs.bigid.com","email":"[email protected]"}},"servers":[{"url":"{environment}/api/v1","variables":{"environment":{"default":"https://sandbox.apps.mybigid.com","description":"BigID installation hostname"}}}],"security":[{"ApiKeyAuth":[]}],"tags":[{"name":"Collection Streaming","description":"This API returns a stream with a filter and by pagination."},{"name":"Data Categories","description":"Use the Data Categories API to obtain the full list of attribute categories, as defined in the Business Glossary. The API response includes all data categories and their characteristics.","externalDocs":{"url":"https://www.docs.bigid.com/bigid/docs/identity-lineage#section-categories"}}],"paths":{"/scans":{"get":{"tags":["Data Source Scans"],"summary":"get a list of scans","description":"This API provides a list of BigID scans and their completion status","parameters":[{"name":"filter","in":"query","description":"filter scans","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScanResult"}}}}},"401":{"description":"Unauthorized","content":{}}}},"post":{"tags":["Data Source Scans"],"summary":"invoke scan profile name with the relevant profile name","description":"This API allows you to initate a scan using a given scan profile.","requestBody":{"description":"Scan details to invoke","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanInvoke"}}},"required":true},"responses":{"401":{"description":"Unauthorized","content":{}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/scans/{subScanId}/requestStop":{"put":{"tags":["Data Source Scans"],"summary":"stop a specific scan","description":"Given a scan ID, stop that scan from running. Note that this will not happen immediately. Using the /scans endpoint can tell you the status.","parameters":[{"name":"subScanId","in":"path","description":"bbb","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized","content":{}}}}},"/scanProfiles":{"get":{"tags":["Data Source Scans"],"summary":"get all scan profiles","description":"Get a listing of all scan profiles for you to run scans against.","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScanProfile"}}},"Simple Scan Profile":{"example":{"_id":"5a0d86459f6841001178d209","created_at":"2017-11-16T12:36:21.867Z","updated_at":"2017-11-16T12:36:21.867Z","scanType":"dsScan","allEnabledIdSor":false,"allEnabledDs":false,"name":"aws-mysql-data1m","description":"aws-mysql-data1m","isCustomScanProfile":true,"active":false,"dataSourceList":["Data source 1","Data source 2"],"idsorList":["Identites 1"]}},"Scheduled Scan Profile":{"example":{"_id":"5a0db10caf83d60012a3be39","created_at":"2017-11-16T12:36:21.867Z","updated_at":"2017-11-16T12:36:21.867Z","scanType":"dsScan","allEnabledIdSor":false,"allEnabledDs":false,"name":"aws-mysql-data1m","description":"aws-mysql-data1m","isCustomScanProfile":true,"active":false,"schedule":"0 22 * * *","dataSourceList":["Data source 1","Data source 2"],"idsorList":["Identites 1"]}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]},"post":{"tags":["Data Source Scans"],"summary":"create a scan profile","description":"Create a scan profile to run a scan against","requestBody":{"description":"Scan details to invoke","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanProfile"}}},"required":false},"responses":{"401":{"description":"Unauthorized","content":{}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/ds_connections":{"get":{"tags":["Data Sources"],"summary":"get a list of all ds connections","description":"Returns a list of all Data Source Connections within the system. Data sources are the systems that BigID is set up to scan.","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DsConnection"}}},"_id":{"example":"5826d66c0424c72e4cd7e9d5"},"id":{"example":"My Database"},"name":{"example":"MS-SQL"},"rdb_url":{"example":"aws-mssql.xxxxxxxxx.us-west-2.rds.amazonaws.com"},"rdb_name":{"example":"bigid"},"username":{"example":"bigid"},"password":{"example":"xxxxxxxxxxx"},"location":{"example":"Germany"},"type":{"example":"rdb-mssql"},"security_tier":{"example":"1"},"enabled":{"example":"yes"},"differential":{"example":true},"last_scan_at":{"example":1507014884865},"rdb_is_sample_data":{"example":true},"rdb_sample_data_max_size":{"example":"200"}}},"401":{"description":"Unauthorized","content":{}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]},"post":{"tags":["Data Sources"],"summary":"create ds connection","description":"Create a new data source connection for BigID to scan. This will just create the connection. You will need to manually run a scan or wait for one to occur to gain insight about this data source.","requestBody":{"description":"Scan details to invoke","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DsConnection"}}},"required":true},"responses":{"200":{"description":"success","content":{}},"401":{"description":"Unauthorized","content":{}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/ds_connections/{connectionName}":{"put":{"tags":["Data Sources"],"summary":"update Ds Connection","description":"Update the details about a data source. This could mean just updating the IP address to a new system or more.","parameters":[{"name":"connectionName","in":"path","description":"bbb","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"DS conection details to update","content":{"schema":{"schema":{"$ref":"#/components/schemas/DsConnection"}}},"required":true},"responses":{"200":{"description":"OK","content":{}}},"x-codegen-request-body-name":"body"}},"/correlation-set-connections":{"get":{"tags":["Correlation Sets"],"summary":"get a list of all correlation learning sets","description":"Returns a list of all Correleation Learning Sets within the system. Correlation Learning Sets are the tables of known entities that BigID will use as the starting point of correlation","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CLRConnection"}}},"_id":{"example":"5826d66c0424c72e4cd7e9d5"},"id":{"example":"My Database"},"name":{"example":"MS-SQL"},"rdb_url":{"example":"aws-mssql.xxxxxxxxx.us-west-2.rds.amazonaws.com"},"rdb_name":{"example":"bigid"},"username":{"example":"bigid"},"password":{"example":"xxxxxxxxxxx"},"location":{"example":"Germany"},"type":{"example":"rdb-mssql"},"security_tier":{"example":"1"},"enabled":{"example":"yes"},"differential":{"example":true},"last_scan_at":{"example":1507014884865},"rdb_is_sample_data":{"example":true},"rdb_sample_data_max_size":{"example":"200"}}},"401":{"description":"Unauthorized","content":{}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]},"post":{"tags":["Correlation Sets"],"summary":"create ds connection","description":"Create a new data source connection for BigID to scan. This will just create the connection. You will need to manually run a scan or wait for one to occur to gain insight about this data source.","requestBody":{"description":"Scan details to invoke","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DsConnection"}}},"required":true},"responses":{"200":{"description":"success","content":{}},"401":{"description":"Unauthorized","content":{}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/identityLocations":{"get":{"tags":["Metadata"],"summary":"get identity locations","description":"Get the real world locations of the entities within your systems. This requires you've set up a location field in your correleation learning sets.","responses":{"200":{"description":"success","content":{"schema":{"schema":{"type":"object","properties":{"identity_locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"number"},"avg":{"type":"number"},"max":{"type":"number"}}}}}}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/systemLocations":{"get":{"tags":["Metadata"],"summary":"get system locations","description":"Get the physical locations for your data sources as specified in their data source configuration.","responses":{"200":{"description":"success","content":{"schema":{"schema":{"type":"object","properties":{"system_locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"number"},"avg":{"type":"number"},"max":{"type":"number"},"systems":{"type":"array","items":{"type":"string"}}}}}}}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/sourceRisks":{"get":{"tags":["Metadata"],"summary":"get source risks","description":"Get the risk score for your data sources. This risk score is user configurable within the Risk Configuration application.","responses":{"200":{"description":"success","content":{"schema":{"schema":{"type":"object","properties":{"source_risks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"number"},"avg":{"type":"number"},"max":{"type":"number"}}}}}}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/piiInvestigationsCount":{"get":{"tags":["Metadata"],"summary":"get pii investigation count","description":"Get a count of the number of entities with cached data","responses":{"200":{"description":"success","content":{"schema":{"schema":{"type":"object","properties":{"piiInvestigationCount":{"type":"number"}}}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/riskTrends":{"get":{"tags":["Metadata"],"summary":"get risk trends","description":"Get a reporting of the risk score for given search criteria","responses":{"200":{"description":"success","content":{"schema":{"schema":{"type":"object","properties":{"risk_trends":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"risk":{"type":"number"},"count":{"type":"number"},"date":{"type":"string"}}}}}}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/scanner-status/":{"get":{"tags":["Scanner Status"],"summary":"Get scanner status","description":"Get statuses of all the scanners in the system.\nREQUEST: No parameters. Status filter optional.\nRESPONSE: Full list of the scanners in the system and their status.","parameters":[{"name":"status","in":"query","description":"Filter scanner list by status (active, idle).","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of all the scanners in the system, filtered by status (if applied)","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"scanner_id":{"type":"string"},"scanner_name":{"type":"string"},"scanner_group":{"type":"string"}}}},"example":[{"scanner_id":"be5f0515-c8bc-4b79-9fb1-6de0ddca5dda","scanner_name":"defaultHostName","scanner_group":"default"},{"scanner_id":"ec5f0515-c8ac-4b12-9fc1-6de0ddcaabcd","scanner_name":"MyhHostName","scanner_group":"default"}]}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}}}}},"/scanner-status/{scanner_id}/":{"get":{"tags":["Scanner Status"],"summary":"Get scanner details","description":"Get scanner details.\nREQUEST: scanner ID.\nRESPONSE: Number of running scans, total number of scans.","parameters":[{"name":"scanner_id","in":"path","description":"scanner_id","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Scanner details ","content":{"application/json":{"schema":{"type":"object","properties":{"scanner_id":{"type":"string"},"message":{"type":"string"},"running":{"type":"integer"},"total":{"type":"integer"}}},"example":[{"scanner_id":"be5f0515-c8bc-4b79-9fb1-6de0ddca5dda","message":"","running":3,"total":65}]}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}}}}},"/scanner_jobs/":{"get":{"tags":["Scanner Jobs"],"summary":"Pending scanner jobs counter","description":"Get count and information on pending scanner jobs.\nREQUEST: No parameters.\nRESPONSE: Information on pending scanner jobs, including: Scanner group, total number of tasks, count of each task type.","responses":{"200":{"description":"Pending scanner jobs counter","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"group":{"type":"string"},"total":{"type":"integer"},"types":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"count":{"type":"integer"}}}}}}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/stream-collections/{collection_name}":{"get":{"tags":["Collection Streaming"],"summary":"Get collection stream","description":"Get stream of collection records. User must be assigned to root scope and have the Export Collection permission.","parameters":[{"name":"collection_name","in":"path","description":"Name of collection","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum records return from the API call","schema":{"type":"number"}},{"name":"offset","in":"query","description":"records offset for pagination use","schema":{"type":"number"}},{"name":"filter","in":"query","description":"filter the records by attributes","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Stream collection was successful","content":{"application/json":{"schema":{"additionalProperties":false,"type":"array","items":{"type":"object"}}}}},"400":{"description":"Bad values for limit/Offset","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validationResponse"}}}},"403":{"description":"The user is not under root scope, asccess is forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"},"example":{"statusCode":403,"status":"error","message":"Only admin has access to this collection","errors":[]}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/data-catalog/":{"get":{"tags":["Objects"],"summary":"Get all objects","description":"Get a full list of all data objects and their characteristics. \nREQUEST: Format (json/csv), pagination parameters, filter by object characteristic.\nRESPONSE: Full list of objects in the system, sorted by fullyQualifiedName (= source.schema.table), in json (array) or csv (string) format. \nThe response limit for the json response is 10,000 rows.","parameters":[{"name":"format","in":"query","description":"Response format `json` or `csv`","required":true,"schema":{"type":"string"}},{"name":"requireTotalCount","in":"query","description":"Include total count of objects (`estimatedCount`) in response?","schema":{"type":"boolean"}},{"name":"offset","in":"query","description":"Number of rows to skip before starting to count rows, for pagination","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Maximum number of data rows to return, for pagination. Maximum value for json = 10,000.","schema":{"type":"integer"}},{"name":"filter","in":"query","description":"Filter the result set by object characteristic","schema":{"type":"string","enum":["source","attribute","metadata.file","metadata.access_rights","contains_pi"]}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of all the objects and their characteristics in the system. `Json` format is returned as array, `csv` format is returned as string.","content":{"application/json":{"schema":{"type":"object","properties":{"estimatedCount":{"type":"integer"},"totalRowsCounter":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"type":{"type":"string"},"containerName":{"type":"string"},"objectName":{"type":"string"},"fullyQualifiedNames":{"type":"string"},"fullObjectName":{"type":"string"},"total_pii_count":{"type":"number"},"scanner_type_group":{"type":"string"},"objectType":{"type":"string"},"attribute_original_name":{"type":"array","items":{"type":"string"}},"open_access":{"type":"string"},"Document Classifier":{"type":"string"},"Language":{"type":"string"},"Size (in bytes)":{"type":"string"},"Owner":{"type":"string"},"Modified":{"type":"string"},"Last scanned":{"type":"string"},"Location":{"type":"string"},"application_name":{"type":"array","items":{"type":"string"}}}}}}},"example":{"results":[{"fullyQualifiedName":"Oracle IT.INTEGRATION_TEST_1.SOME_TABLE_1","scanner_type_group":"structured","total_pii_count":111,"id":"5de3baf352ac28d369963810","source":"Oracle IT","type":"rdb-oracle","attribute_original_name":["ZFULL_NAME","FULL_NAME","FULLNAME","ZZIPCODE","SSN","full_name","ZSSN","ZIPCODE","ZID","DATE_OF_BIRTH"],"objectType":"rdb","open_access":"","fullObjectName":"INTEGRATION_TEST_1.SOME_TABLE_1","objectName":"SOME_TABLE_1","containerName":"INTEGRATION_TEST_1","attribute":["ZFULL_NAME","FULL_NAME","FULLNAME","ZZIPCODE","SSN","full_name","ZSSN","ZIPCODE","ZID","DATE_OF_BIRTH"],"application_name":["SAP","Marketing"]}],"totalRowsCounter":3,"estimatedCount":3,"Document Classifier":"","Language":"English","Size (in bytes)":"56","Owner":"Admin","Modified":"2015120117:33:21..","Last scanned":"2015120117:33:21..","Location":"USA"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/file-download/export/":{"get":{"tags":["Objects"],"summary":"Get all objects as CSV","description":"Download a full list of data objects and their characteristics, as CSV file.\nREQUEST: Pagination parameters, filter by object characteristics.\nRESPONSE: Full list of objects in the system, in CSV format. ","parameters":[{"name":"offset","in":"query","description":"Number of rows to skip before starting to collect the result set, for pagination","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Maximum numbers of data rows to return, for pagination","schema":{"type":"integer"}},{"name":"filter","in":"query","description":"Filter the result set by object characteristic","schema":{"type":"string","enum":["source","attribute","metadata.file","metadata.access_rights","contains_pi"]}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Download of Catalog Objects list, as CSV file. ","content":{"attachment/octet-stream":{"schema":{"$ref":"#/components/schemas/CatalogObjects"}}}},"400":{"description":"Bad request","content":{"attachment/octet-stream":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"attachment/octet-stream":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/object-details/":{"get":{"tags":["Objects"],"summary":"Get object details","description":"Get a full list of details of a requested object.\nREQUEST: Object name.\nRESPONSE: Full list of object details.","parameters":[{"name":"object_name","in":"query","description":"Name of the item in the data catalog for which to return details","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of object full details","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"source":{"type":"string"},"type":{"type":"string"},"containerName":{"type":"string"},"objectName":{"type":"string"},"fullyQualifiedNames":{"type":"string"},"fullObjectName":{"type":"string"},"total_pii_count":{"type":"number"},"scanner_type_group":{"type":"string"},"objectType":{"type":"string"},"ds_location":{"type":"string"},"attribute":{"type":"array","items":{"type":"string"}},"open_access":{"type":"string"},"created_date":{"type":"string"},"modified_date":{"type":"string"},"ds":{"type":"object","properties":{"location":{"type":"string"},"owners":{"type":"array","items":{"type":"string"}}},"description":"Data source info"},"owner":{"type":"string","description":"file owner"}}}}},"example":{"data":{"_id":"5de3baf352ac28d369963810","fullyQualifiedName":"Oracle IT.INTEGRATION_TEST_1.SOME_TABLE_1","scanId":"5de3a3af52ac28d36927d49c","source":"Oracle IT","isEncrypted":false,"created_date":"2019-12-01T13:06:59.145Z","scanStatus":"Completed","columnOrFieldOccurrencesCounter":[{"fieldName":"COUNTRY","fieldType":"VARCHAR2","isPrimary":false,"fieldCount":5,"findingCount":4,"fieldClassifications":[]},{"fieldName":"ZIPCODE","fieldType":"VARCHAR2","isPrimary":false,"fieldCount":5,"findingCount":5,"fieldClassifications":[]},{"fieldName":"FULL_NAME","fieldType":"VARCHAR2","isPrimary":false,"fieldCount":5,"findingCount":5,"fieldClassifications":[]},{"fieldName":"ID","fieldType":"NUMBER","isPrimary":false,"fieldCount":5,"findingCount":5,"fieldClassifications":[]},{"fieldName":"DATE_OF_BIRTH","fieldType":"VARCHAR2","isPrimary":false,"fieldCount":5,"findingCount":5,"fieldClassifications":[]},{"fieldName":"SSN","fieldType":"VARCHAR2","isPrimary":false,"fieldCount":5,"findingCount":5,"fieldClassifications":[]}],"scanPartId":"0","totalFindings":35,"dataSourceName":"Oracle IT","containerName":"INTEGRATION_TEST_1","objectName":"SOME_TABLE_1","scannerType":"rdb-oracle","collectionOrTableName":"SOME_TABLE_1","totalRowsWithFindings":5,"totalRows":5,"totalEnrichmentFindings":0,"correlation_status":"Completed","scanner_type_group":"structured","update_date":"2019-12-01T14:45:18.657Z","type":"rdb","total_findings_inserted":35,"total_pii_count":111,"attribute":["ZFULL_NAME","FULL_NAME","FULLNAME","ZZIPCODE","SSN","full_name","ZSSN","ZIPCODE","ZID","DATE_OF_BIRTH"],"id_source":["AthenaIDs","MySQL IDs Qualitest","EDS","MySQL IDSoR","SAP Test IDs","Postgres IDs","MySQLID","EDS2","Test Big_Table","Amazon Postgres"],"country":[],"num_identities":13,"max_pii_count":43,"ds":[{"_id":"5ddfcd2435c54b756cba962b","owners":[],"differential":false,"password":"bqukiqx3BOEIBSau0VmW6aUjRUFcDvzutBhicH6GNPQ=","name":"Oracle IT","credential_id":"","rdb_is_sample_data":true,"rdb_url":"bigid-aws-oracle.cj48rpb9opef.us-west-2.rds.amazonaws.com:1521/ORCL","username":"integration_test_1","updatedPasswords":[],"type":"rdb-oracle","security_tier":"1","scanner_strategy":"SCAN_ALL","enabled":"yes","is_idsor_supported":true,"custom_fields":[{"field_name":"shouldPrintSensitiveData","field_type":"clear","field_value":"true"}],"last_scan_at":1575199663399,"scan_is_success":true,"scan_timestamp":"2019-07-03T13:40:53.295Z","scan_num_of_objects":1,"test_is_success":true,"test_timestamp":"2019-07-03T13:37:48.855Z","connectionStatusTest":{"is_success":true,"last_connection":"2019-11-21T11:51:21.022Z","num_of_object":0},"connectionStatusScan":{"is_success":true,"last_connection":"2019-11-26T15:43:02.715Z","num_of_object":1}}],"open_access":"","fullObjectName":"INTEGRATION_TEST_1.SOME_TABLE_1"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/object-details/attributes/":{"get":{"tags":["Attributes"],"summary":"Get attribute details for object","description":"Get a full list of attribute details for a requested object.\nREQUEST: Object name.\nRESPONSE: Full list of the object's attribute details.","parameters":[{"name":"object_name","in":"query","description":"Name of the item in the data catalog for which to return attribute details","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of all object attribute details","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"attribute_name":{"type":"string"},"attribute_type":{"type":"string"},"attribute_original_name":{"type":"string"},"description":{"type":"string"},"categories":{"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string"}}}},"attribute_id":{"type":"string"},"investigation_scan_id_list":{"type":"array","items":{"type":"string"}},"is_support_investigation":{"type":"boolean"},"business_flow":{"type":"array","items":{"type":"string"}},"column_list":{"type":"array","items":{"type":"object","properties":{"column_name":{"type":"string"},"calc_confidence_level":{"type":"number","format":"double"},"rank":{"type":"string"}}}}}}}}},"example":{"data":[{"source":"Oracle IT","attribute_original_name":"DATE_OF_BIRTH","description":"day of born","categories":"Identify data","column_list":[{"column_name":"DATE_OF_BIRTH","rank":"Medium","calc_confidence_level":0.57}],"attribute_name":"B-Day","attribute_type":"IDSoR Attribute","business_flow":["send gift card"],"attribute_id":"dbf3160e2daaba72caac4c73724ad2cd","is_support_investigation":true,"investigation_scan_id_list":["1441894879"]}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/object-details/columns/":{"get":{"tags":["Columns"],"summary":"Get structured object column details","description":"Get a full list of columns and the attributes they contain, of a structured object.\nREQUEST: Object name, number of items to skip, item limitation.\nRESPONSE: Full list of object columns, their details and attributes they contain.","parameters":[{"name":"object_name","in":"query","description":"Name of the item in the data catalog for which to return column details","required":true,"schema":{"type":"string"}},{"name":"skip","in":"query","description":"The number of items to skip before starting to collect the result set","schema":{"type":"integer","default":0}},{"name":"limit","in":"query","description":"The numbers of items to return (-1 = return all)","schema":{"type":"integer","default":-1}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of all the column details of the object","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"column_name":{"type":"string"},"fieldType":{"type":"string"},"isPrimary":{"type":"boolean"},"linkedColumns":{"type":"number"},"attribute_list":{"type":"array","items":{"type":"object","properties":{"attribute_name":{"type":"string"},"attribute_id":{"type":"string"},"attribute_type":{"type":"string"},"calc_confidence_level":{"type":"number","format":"double"},"rank":{"type":"string"}}}}}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/fetch-clear-value/":{"post":{"tags":["Investigate"],"summary":"Investigate attribute","description":"Launch an investigation into a specified attribute.\nREQUEST: Attribute identification.\nRESPONSE: Investigation IDs.","requestBody":{"description":"Attribute identification. fullyQualifiedName = source.schema.table","content":{"application/json":{"schema":{"required":["attribute_name","attribute_type","fullyQualifiedName"],"type":"object","properties":{"attribute_name":{"type":"string"},"attribute_type":{"type":"string"},"fullyQualifiedName":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"piiInvestigationId":{"type":"string"},"piiInvestigationFullScanId":{"type":"string"}}},"example":{"piiInvestigationId":123456789,"piiInvestigationFullScanId":"987654321!"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/data-catalog/manual-fields/":{"post":{"tags":["Attributes"],"summary":"Update attribute manually","description":"Update attribute catalog characteristics manually.\nREQUEST: Parameters to update.\nRESPONSE: Count of updated parameters.","requestBody":{"description":"Parameters to update for attribute in file or table","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"required":["fullyQualifiedName","type","value"],"type":"object","properties":{"fullyQualifiedName":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"},"fieldName":{"type":"string"},"attribute_type":{"type":"string"},"attribute_original_type":{"type":"string"},"isNewAttribute":{"type":"boolean"},"confLevel":{"type":"string"}}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"customTypeCountUpdated":{"type":"integer","description":"amount of manual fields updated"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/data-catalog/manual-fields/attributes-list/":{"get":{"tags":["Attributes"],"summary":"Get all attributes","description":"Get a full list of all the attributes in the system and their characteristics.\nREQUEST: No parameters.\nRESPONSE: Full list of attributes.","responses":{"200":{"description":"Listing of all the attributes in the system, and their characteristics.","content":{"application/json":{"schema":{"type":"object","properties":{"attributesList":{"type":"array","items":{"type":"object","properties":{"attribute_name":{"type":"string"},"attribute_id":{"type":"string"},"attribute_original_name":{"type":"string"},"attribute_type":{"type":"string"}}}},"objectAttributeList":{"type":"array","items":{"type":"object","properties":{"attribute_id":{"type":"string"},"attribute_name":{"type":"string"},"attribute_original_name":{"type":"string"},"attribute_type":{"type":"string"}}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/data-catalog/object-details/columns/column-profile/":{"get":{"tags":["Columns"],"summary":"Get column profile","description":"Get the full profile of a specific column within a structured object.\nREQUEST: Object name, column name.\nRESPONSE: All the aggregate and statistical information about the data in the requested column.","parameters":[{"name":"object_name","in":"query","description":"Name of the item in the data catalog for which to return column profile","required":true,"schema":{"type":"string"}},{"name":"field_name","in":"query","description":"The field (column) for which to return profile","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Full column profile","content":{"application/json":{"schema":{"type":"object","properties":{"inferredDataType":{"type":"string"},"fieldCount":{"type":"integer"},"avgNum":{"type":"string"},"minNum":{"type":"string"},"maxNum":{"type":"string"},"numCnt":{"type":"integer"},"avgLen":{"type":"integer"},"numDev":{"type":"string"},"avgStrLen":{"type":"integer"},"minStrLen":{"type":"integer"},"maxStrLen":{"type":"integer"},"strDev":{"type":"string"},"maxStr":{"type":"string"},"minStr":{"type":"string"},"maxLexStr":{"type":"string"},"minLexStr":{"type":"string"},"emptyPct":{"type":"integer"},"distinctPct":{"type":"integer"}}},"example":{"fieldCount":5,"inferredDataType":"Numeric","avgNum":"47545","minNum":"196","maxNum":"18596","numCnt":5,"avgLen":86867,"numDev":"24306.971","avgStrLen":5,"minStrLen":5,"maxStrLen":5,"strDev":"0","maxStr":"54478","minStr":"54478","maxLexStr":"zzf","minLexStr":"abcaaa","emptyPct":0,"distinctPct":100}}}},"418":{"description":"Data unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/object-details/columns/count":{"get":{"tags":["Columns"],"summary":"Get column count for structured object","description":"Get the number of columns in a structured object.\nREQUEST: Object name.\nRESPONSE: Number of columns in the object.","parameters":[{"name":"object_name","in":"query","description":"Name of the item in the data catalog for which to return column count","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Column count for specified object","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"count":{"type":"number"}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/distinct-values/{field_name}/":{"get":{"tags":["Attributes"],"summary":"Get distinct field values","description":"Get a list of all distinct values of a specified field.\nREQUEST: Field name, free text query filter optional.\nRESPONSE: Full or filtered list of attribute values.","parameters":[{"name":"field_name","in":"path","description":"Name of the field for which to return values","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Free text query filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of distinct field values","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}}}}}},"example":{"results":[{"value":"SSN"},{"value":"FIRST_NAME"}]}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/insights/":{"get":{"tags":["Insights"],"summary":"Get Data Catalog highlights","description":"Get the following Data Catalog highlights: Top data sources containing PI, total number of scanned data sources, and total number of scanned data sources containing PI.\nREQUEST: Result limit.\nRESPONSE: Top data sources containing PI, total number of scanned data sources, and total number of scanned data sources containing PI.","parameters":[{"name":"limit","in":"query","description":"Maximum number of top data sources containing PI to return","schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of Data Catalog highlights","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"totalDsScanned":{"type":"number"},"totalDsWithPi":{"type":"number"},"topDsByPiCount":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"totalObjectsWithPii":{"type":"number"}}}}}}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/tables/":{"get":{"tags":["Objects"],"summary":"Get all table information","description":"Get all information on the tables in the system.\nREQUEST: Pagination parameters, filter by object name.\nRESPONSE: Full list of tables in the system, sorted by fullyQualifiedName.","parameters":[{"name":"offset","in":"query","description":"Number of items to skip before starting to collect the result set, for pagination","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Numbers of items to return, for pagination","schema":{"type":"integer"}},{"name":"filter","in":"query","description":"Filter the result set by objectName=starting with, for example: objectName=s for all tables that start with S.","schema":{"type":"string","enum":["objectName"]}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of all the tables in the system","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"fullyQualifiedName":{"type":"string"},"source":{"type":"string"},"containerName":{"type":"string"},"objectName":{"type":"string"}}}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/objects-with-pii/{source}/":{"get":{"tags":["Objects"],"summary":"Get PII objects per data source","description":"Get a list of all objects containing PII in a specified data source.\nREQUEST: Name of data source.\nRESPONSE: String list of objects that contain PII.","parameters":[{"name":"source","in":"path","description":"Name of data source","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"List of objects (fullyQulifiedName) with PII","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/searchable-attribute/{object_name}/":{"get":{"tags":["Objects"],"summary":"Get Cartesian multiplication of attributes per column","description":"Get a searchable Cartesian multiplication of attributes per column.\nREQUEST: Object name.\nRESPONSE: List of attributes per columns, including details for DSAR flow.","parameters":[{"name":"object_name","in":"path","description":"Object name (fullyQulifiedName)","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"List of attributes per columns","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"shortFieldName":{"type":"string"},"attribute":{"type":"string"},"attributePii":{"type":"number"},"corrStatus":{"type":"string"},"isFullMatch":{"type":"boolean"},"countMatches":{"type":"string"},"countPos0":{"type":"number"},"isCompositeKey":{"type":"boolean"},"countSureMatch":{"type":"number"}}}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/system-attributes/":{"get":{"tags":["Attributes"],"summary":"Get all attributes","description":"Get a full list of the attributes in the system.\nREQUEST: No parameters required, free text query filter optional.\nRESPONSE: Full list of the attributes in the system.","parameters":[{"name":"filter","in":"query","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of all the attributes in the system","content":{"application/json":{"schema":{"type":"object","properties":{"systemAttributeList":{"type":"array","items":{"$ref":"#/components/schemas/systemAttribute"}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/active-system-attributes/":{"get":{"tags":["Attributes"],"summary":"Get all active attributes","description":"Get a full list of attributes that are linked to at least one object in the system.\nREQUEST: No parameters required. Data sources to filter by (optional), correlation set to filter by (optional, relevant to IDSoR attributes only).\nRESPONSE: Full list of the active attributes in the system, including attribute details.","parameters":[{"name":"dataSourceList","in":"query","description":"List of data sources to filter by","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"correlationSetList","in":"query","description":"List of correlation sets to filter by, relevant to IDSoR attirbutes only","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"withPurpose","in":"query","schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of all the active attributes and their details in the system","content":{"application/json":{"schema":{"type":"object","properties":{"activeAttributeList":{"type":"array","items":{"$ref":"#/components/schemas/systemAttribute"}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data_categories/":{"get":{"tags":["Data Categories"],"summary":"Get All Data Categories","description":"Get a full list of all data categories.","responses":{"200":{"description":"Get all Data Categories","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"color":{"type":"string"},"dc":{"type":"array","items":{"type":"object","properties":{"color":{"type":"string"},"description":{"type":"string"},"display_name":{"type":"string"},"unique_name":{"type":"string"}}}},"description":{"type":"string"},"display_name":{"type":"string"},"glossary_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"example":[{"color":"#FF0000","dc":[{"color":"#FF0000","description":"555","display_name":"category1","unique_name":"NewIntegrationTest2"}],"description":"555","display_name":"category1","glossary_id":"NewIntegrationTest2","name":"category1","type":"Personal Data Category"}]}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]},"post":{"tags":["Data Categories"],"summary":"Create Data Category","description":"The API receives Data Category object, saves it and returns a glossary_id. The Business Glossary defines certain terms and categories used in various contexts throughout the BigID system.","operationId":"createDataCategory","requestBody":{"description":"Data Categories","content":{"application/json":{"schema":{"required":["unique_name"],"type":"object","properties":{"unique_name":{"type":"string"},"description":{"type":"string"},"display_name":{"type":"string"},"color":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"required":["glossary_id"],"type":"object","properties":{"glossary_id":{"type":"string"},"success":{"type":"boolean"}}},"example":{"success":true,"glossary_id":"sensitive"}}}},"400":{"description":"Bad POST body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/lineage/attributes/":{"get":{"tags":["Lineage Attribute"],"summary":"Get Lineage Attribute","description":"Get Lineage Attribute. show classifications, enrichment_attributes and ds attributes (idsor_attributes)","responses":{"200":{"description":"Get all Lineage Attribute","content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"classifications":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"attribute_type":{"type":"string"},"collections":{"type":"array","items":{"type":"string"}},"friendly_name":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"glossary_id":{"type":"string"}}}},"enrichment_attributes":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"attribute_type":{"type":"string"},"collections":{"type":"array","items":{"type":"string"}},"friendly_name":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"glossary_id":{"type":"string"}}}},"idsor_attributes":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"attribute_type":{"type":"string"},"collections":{"type":"array","items":{"type":"string"}},"friendly_name":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"glossary_id":{"type":"string"},"identifiability":{"type":"number"},"overrideSureMatch":{"type":"boolean"}}}}}}},"identifiability_threshold":{"type":"number"}}},"example":{"attributes":[{"classifications":[{"_id":"Email","attribute_type":"Classification","collections":["Oracle Lineage DS.LINEAGE_TESTS.TEST_USERS"],"friendly_name":"Email"}],"enrichment_attributes":[{"_id":"enrich_field.ACTIVITY_ID","attribute_type":"Enrichment Attribute","collections":["Oracle Lineage DS.LINEAGE_TESTS.TEST_ACTIVITIES"],"friendly_name":"enrich_field.ACTIVITY_ID"}],"idsor_attributes":[{"_id":"USER_ID","attribute_type":"IDSoR Attribute","collections":["Oracle Lineage DS.LINEAGE_TESTS.TEST_ACTIVITIES","Oracle Lineage DS.LINEAGE_TESTS.TEST_USERS"],"friendly_name":"USER_ID","identifiability":1.5,"overrideSureMatch":false}]}],"identifiability_threshold":0.5}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/lineage/manual/connection":{"get":{"tags":["Manual Referential Integrity"],"summary":"Get connections","description":"Get referential integrity and manual connections for specified nodes.\nREQUEST: Manual or referential integrity nodes.\nRESPONSE: List of referential integrity and manual connections, sorted by table name.","parameters":[{"name":"nodes","in":"query","description":"One or more nodes, separated by a comma. For example: collection_1, collection_2, collection_3.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of referential integrity and manual connections","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/successMsgLineageNode"}},"example":{"status":"success","statusCode":200,"data":[{"_id":"collection_2","lineage_details":{"_id":"collection_2","connected_collections":["collection_3","collection_1"],"connections":[{"linked_collection":"collection_3","connection_fields":[{"local_field":"collection_2_3","foreign_field":"collection_3_1","manual":true}]},{"linked_collection":"collection_1","connection_fields":[{"local_field":"collection_2_2","foreign_field":"collection_1_2","manual":true},{"local_field":"collection_2_1","foreign_field":"collection_1_1","manual":true}]}]}},{"_id":"collection_1","lineage_details":{"_id":"collection_1","connected_collections":["collection_3","collection_2"],"connections":[{"linked_collection":"collection_3","connection_fields":[{"local_field":"collection_1_3","foreign_field":"collection_3_3","manual":true},{"local_field":"collection_1_3","foreign_field":"collection_3_1","manual":true}]},{"linked_collection":"collection_2","connection_fields":[{"local_field":"collection_1_2","foreign_field":"collection_2_2","manual":true},{"local_field":"collection_1_1","foreign_field":"collection_2_1","manual":true}]}]}}]}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}}}},"post":{"tags":["Manual Referential Integrity"],"summary":"Insert connection","description":"Manually insert a referential integrity or manual connection. All nodes must be validated for the operation to be successful.\nREQUEST: Node characteristics.\nRESPONSE: Success/ fail.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/manualConnectionData"}}},"required":true},"responses":{"200":{"description":"OK, all nodes validated","content":{"application/json":{"schema":{"type":"object"},"example":{"status":"success","statusCode":200,"data":[]}}}},"400":{"description":"Bad request, no valid nodes","content":{"application/json":{"schema":{"type":"object"},"example":{"status":"error","statusCode":400,"message":"The provided request has invalid payload","errors":[{"type":"PAYLOAD_VALIDATION","title":"Payload Validation Error","details":"Expected a value of type '{data}' for 'undefined' but received '[object Object],[object Object]'."}]}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/sar/search/entity-sources":{"get":{"tags":["Search for Individual"],"summary":"Search for individual by name or ID (synchronous).","description":"Search entity sources defined in profile for individual, using userName or userID (synchronous) \n \n REQUEST: Specify username or userID. \n RESPONSE: Returns a list of individuals found in entity sources matching the search criteria, with whatever personal information attributes were found for each individual (response fields depend on entity sources). Use these attributes to run DSAR scan of selected individual (/sar/reports). \nMultiple values returned for a single attribute are separated by `|`.","parameters":[{"name":"profileId","in":"query","description":"Profile ID defining connected entity sources. Use /sar/profiles to see full list of available profiles. If not specified, default profile will be applied.","schema":{"type":"string"}},{"name":"userName","in":"query","description":"Name of the individual you are searching for","schema":{"type":"string"}},{"name":"userId","in":"query","description":"Unique ID of the individual you are searching for","schema":{"type":"string"}},{"name":"allAttributes","in":"query","description":"get allAttributes","schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"usersMap":{"type":"object","properties":{"uniqueId":{"type":"object","properties":{"userId":{"type":"string"},"attributes":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"residency":{"type":"string"},"risk":{"type":"string"},"isOptOut":{"type":"string"},"optOutDate":{"type":"string"},"idSourceName":{"type":"string"},"attributesMap":{"type":"object","properties":{"field1":{"type":"number"},"field2":{"type":"string"},"field3":{"type":"boolean"}}},"unique_id":{"type":"string"}}}}}}},"errMessages":{"type":"object","properties":{}}}},"example":{"usersMap":{"uniqueId":{"userId":123456789,"attributes":{"id":2468,"name":"DATE_OF_BIRTH","residency":"Spain","risk":61,"isOptOut":true,"optOutDate":"25/5/2018","idSourceName":"HR-sybase","attributesMap":{"field2":"25/5/1966"},"unique_id":"123-34-4567"}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/search/entity-sources/async":{"post":{"tags":["Search for Individual"],"summary":"Search for individual by name or ID (asynchronous).","description":"REQUEST: Search entity sources defined in profile for individual, using userName or userID (asynchronous - must include callback and SSL parameters) \n RESPONSE: Returns a list of individuals found in entity sources matching the search criteria, with whatever personal information attributes were found for each individual (response example shown below). Use these attributes to run DSAR scan of selected individual (/sar/reports).\nMultiple values returned for a single attribute are separated by `|`","parameters":[{"name":"callbackUrl","in":"query","description":"POST request URL called on completion of search scan","schema":{"type":"string"}},{"name":"ssl_trust_store_path","in":"query","description":"Path of certificate to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_store_password","in":"query","description":"Password (if exists) to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_self_signed","in":"query","description":"Should callback trust self-signed certificates? (TRUE/FALSE)","schema":{"type":"string"}},{"name":"headers","in":"query","description":"If needed, specify headers for POST request here. Syntax `\"ThisHeader\"=\"HeaderValue\"`","schema":{"type":"string"}},{"name":"profileId","in":"query","description":"Profile ID defining connected entity sources. Use /sar/profiles to see full list of available profiles. If not specified, default profile will be applied.","required":true,"schema":{"type":"string"}},{"name":"userName","in":"query","description":"Name of the individual you are searching for","schema":{"type":"string"}},{"name":"userId","in":"query","description":"Unique ID of the individual you are searching for","schema":{"type":"string"}},{"name":"allAttributes","in":"query","description":"get allAttributes","schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"Callback properties","content":{"schema":{"schema":{"type":"object","properties":{"callbackUrl":{"type":"string","example":"http://www.example.com"},"callbackUrlProperties":{"type":"object","properties":{"ssl_trust_store_path":{"type":"string","example":".../folder1/folder2"},"ssl_trust_store_password":{"type":"string","example":"mypassword123"},"ssl_trust_self_signed":{"type":"boolean","example":true},"headers":{"type":"object","properties":{"authorization":{"type":"string","example":"ffff"}}}}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"usersMap":{"type":"object","properties":{"uniqueId":{"type":"object","properties":{"userId":{"type":"string"},"attributes":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"residency":{"type":"string"},"risk":{"type":"string"},"isOptOut":{"type":"string"},"optOutDate":{"type":"string"},"idSourceName":{"type":"string"},"attributesMap":{"type":"object","properties":{"field1":{"type":"number"},"field2":{"type":"string"},"field3":{"type":"boolean"}}},"unique_id":{"type":"string"}}}}}}}}},"errMessages":{"type":"object","properties":{}}}},"example":{"results":{"usersMap":{"uniqueId":{"userId":123456789,"attributes":{"id":2468,"name":"DATE_OF_BIRTH","residency":"Spain","risk":61,"isOptOut":true,"optOutDate":"25/5/2018","idSourceName":"HR-sybase","attributesMap":{"field2":"25/5/1966"},"unique_id":"123-34-4567"}}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"x-codegen-request-body-name":"body"}},"/sar/search/entity-sources/{id_connection}":{"get":{"tags":["Search for Individual"],"summary":"Search for individual by specified attribute(s) (synchronous).","description":"REQUEST: Search specified entity sources for individual, using specified attributes (synchronous). \n RESPONSE: Returns a list of individuals found in entity sources matching the search criteria, with whatever personal information attributes were found for each individual (response example shown below). Use these attributes to run DSAR scan of selected individual (/sar/reports).\nMultiple values returned for a single attribute are separated by `|`","parameters":[{"name":"id_connection","in":"path","description":"Entity source name","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Query with attributes by which to search for individual. Syntax: `filter=<attribute_name>=<attribute_value>` (append additional attributes using AND). Example: `filter=SSN=123-45-6789 AND COUNTRY=USA`.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"usersMap":{"type":"object","properties":{"uniqueId":{"type":"object","properties":{"userId":{"type":"string"},"attributes":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"residency":{"type":"string"},"risk":{"type":"string"},"isOptOut":{"type":"string"},"optOutDate":{"type":"string"},"idSourceName":{"type":"string"},"attributesMap":{"type":"object","properties":{"field1":{"type":"number"},"field2":{"type":"string"},"field3":{"type":"boolean"}}},"unique_id":{"type":"string"}}}}}}},"errMessages":{"type":"object","properties":{}}}},"example":{"usersMap":{"uniqueId":{"userId":123456789,"attributes":{"id":2468,"name":"DATE_OF_BIRTH","residency":"Spain","risk":61,"isOptOut":true,"optOutDate":"25/5/2018","idSourceName":"HR-sybase","attributesMap":{"field2":"25/5/1966"},"unique_id":"123-34-4567"}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/search/entity-sources/async/{id_connection}":{"post":{"tags":["Search for Individual"],"summary":"Search for individual by specified attribute(s) (asynchronous).","description":"REQUEST: Search specified entity sources for individual, using specified attributes (asynchronous - must include callback and SSL parameters). \n RESPONSE: Returns a list of individuals found in entity sources matching the search criteria, with whatever personal information attributes were found for each individual (response example shown below). Use these attributes to run DSAR scan of selected individual (/sar/reports).\nMultiple values returned for a single attribute are separated by `|`","parameters":[{"name":"id_connection","in":"path","description":"Entity source name","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Query with attributes by which to search for individual. Syntax: `filter=<attribute_name>=<attribute_value>` (append additional attributes using AND). Example: `filter=SSN=123-45-6789 AND COUNTRY=USA`.","required":true,"schema":{"type":"string"}},{"name":"callbackUrl","in":"query","description":"POST request URL called on completion of search scan","schema":{"type":"string"}},{"name":"ssl_trust_store_path","in":"query","description":"Path of certificate to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_store_password","in":"query","description":"Password (if exists) to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_self_signed","in":"query","description":"Should callback trust self-signed certificates? (TRUE/FALSE)","schema":{"type":"string"}},{"name":"headers","in":"query","description":"If needed, specify headers for POST request here. Syntax `\"ThisHeader\"=\"HeaderValue\"`","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"Callback properties","content":{"schema":{"schema":{"type":"object","properties":{"callbackUrl":{"type":"string","example":"http://www.example.com"},"callbackUrlProperties":{"type":"object","properties":{"ssl_trust_store_path":{"type":"string","example":".../folder1/folder2"},"ssl_trust_store_password":{"type":"string","example":"mypassword123"},"ssl_trust_self_signed":{"type":"boolean","example":true},"headers":{"type":"object","properties":{"authorization":{"type":"string","example":"ffff"}}}}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"usersMap":{"type":"object","properties":{"uniqueId":{"type":"object","properties":{"userId":{"type":"string"},"attributes":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"residency":{"type":"string"},"risk":{"type":"string"},"isOptOut":{"type":"string"},"optOutDate":{"type":"string"},"idSourceName":{"type":"string"},"attributesMap":{"type":"object","properties":{"field1":{"type":"number"},"field2":{"type":"string"},"field3":{"type":"boolean"}}},"unique_id":{"type":"string"}}}}}}}}},"errMessages":{"type":"object","properties":{}}}},"example":{"results":{"usersMap":{"uniqueId":{"userId":123456789,"attributes":{"id":2468,"name":"DATE_OF_BIRTH","residency":"Spain","risk":61,"isOptOut":true,"optOutDate":"25/5/2018","idSourceName":"HR-sybase","attributesMap":{"field2":"25/5/1966"},"unique_id":"123-34-4567"}}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"x-codegen-request-body-name":"body"}},"/sar/attributes":{"get":{"tags":["Search for Individual"],"summary":"Get a list of attributes","description":"REQUEST: Specify Profile ID. \n RESPONSE: Get a list of identifying attributes available in specified profile. Returned attributes are categorized as searchable (can be used to search for an individual) or non-searchable (cannot be used to search for an individual).","parameters":[{"name":"profileId","in":"query","description":"Profile ID. Use /sar/profiles to see a listing of all existing profiles.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"idsor_attributes":{"type":"array","items":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"glossary_id":{"type":"number"},"friendly_name":{"type":"string"},"identifiability":{"type":"number"},"overrideSureMatch":{"type":"boolean"},"searchable":{"type":"boolean"},"searchable_classification":{"type":"boolean"},"_id":{"type":"string"}}}}}}},"classifications":{"type":"array","items":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"glossary_id":{"type":"number"},"friendly_name":{"type":"string"},"searchable":{"type":"boolean"},"searchable_classification":{"type":"boolean"},"_id":{"type":"string"}}}},"identifiability_threshold":{"type":"number"}}},"example":{"attributes":[{"idsor_attributes":[{"categories":["Mailing|Financial"],"description":"Date of Birth","glossary_id":2468,"friendly_name":"Birth Date","identifiability":50,"overrideSureMatch":false,"searchable":true,"searchable_classification":true,"_id":888888}],"classifications":[{"categories":["Mailing|Financial"],"description":"Date of Birth","glossary_id":2468,"friendly_name":"Birth Date","searchable":true,"searchable_classification":true,"_id":888888}]}],"identifiability_threshold":30}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/reports":{"post":{"tags":["Run DSAR"],"summary":"Run DSAR scan","description":"REQUEST: Run DSAR scan for individual specified by userId, name, and whatever additional identifying attributes can be used for correlating data found in entity sources and data sources.\n RESPONSE: Scan ID of DSAR parent scan.","parameters":[{"name":"profileId","in":"query","description":"Profile ID, defining which entity sources and data sources to scan","schema":{"type":"string"}},{"name":"callbackUrl","in":"query","description":"POST request URL called on completion of search scan","schema":{"type":"string"}},{"name":"ssl_trust_store_path","in":"query","description":"Path of certificate to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_store_password","in":"query","description":"Password (if exists) to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_self_signed","in":"query","description":"Should callback trust self-signed certificates? (TRUE/FALSE)","schema":{"type":"string"}},{"name":"headers","in":"query","description":"If needed, specify headers for POST request here. Syntax `\"ThisHeader\"=\"HeaderValue\"`","schema":{"type":"string"}},{"name":"userId","in":"query","description":"Unique ID of the individual to run the DSAR scan on","required":true,"schema":{"type":"string"}},{"name":"displayName","in":"query","description":"Name of the individual to run the DSAR scan on","required":true,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"Optional. If not specified, scan will automatically extract all relevant attributes from allowed entity sources. If specified, scan will use these attributes to correlate additional fields. Syntax `<attribute_name>:<attribute_value>`.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"A JSON payload containing the Unique ID, Display Name and whatever other identifying attributes of the requested individual are known.","content":{"schema":{"schema":{"required":["userDetails"],"type":"object","properties":{"profileId":{"type":"string","example":"123456"},"callbackUrl":{"type":"string","example":"http://www.example.com"},"callbackUrlProperties":{"type":"object","properties":{"ssl_trust_store_path":{"type":"string","example":".../folder1/folder2"},"ssl_trust_store_password":{"type":"string","example":"mypassword123"},"ssl_trust_self_signed":{"type":"boolean","example":true},"headers":{"type":"object","properties":{"authorization":{"type":"string","example":"ffff"}}}}},"userDetails":{"required":["displayName","userId"],"type":"object","properties":{"userId":{"type":"string","example":"123456789"},"displayName":{"type":"string","example":"Thomas Banks"},"attributes":{"type":"object","properties":{"attribute1":{"type":"number"},"attribute2":{"type":"string","example":"[email protected]"}}}}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"report_id":{"type":"string"},"requestId":{"type":"string"},"userId":{"type":"string"}}},"example":{"report_id":321321321,"requestId":321321321,"userId":"11-111-11"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"x-codegen-request-body-name":"body"}},"/sar/reports/{requestId}/retry-failed-objects":{"post":{"tags":["Run DSAR"],"summary":"Retry DSAR scan","description":"Run DSAR scan of failed subscans or failed objects within subscans. \nREQUEST: Scan IDs of parent scan and subscans to retry. \n RESPONSE: Scan IDs of subscans with failures that are now being rescanned.","parameters":[{"name":"requestId","in":"path","description":"Scan ID of DSAR parent scan","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"A JSON payload containing the Scan IDs of subscans to retry","content":{"schema":{"schema":{"required":["subScanIds"],"type":"object","properties":{"subScanIds":{"type":"array","example":["123456","456789"],"items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"subScanIds":{"type":"array","items":{"type":"string"}}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":[{"subScanIds":["123456","456789"]}],"status":"success","statusCode":200,"massage":"successful operation"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}},"x-codegen-request-body-name":"body"}},"/sar/reports/{requestId}":{"get":{"tags":["Reports"],"summary":"Get DSAR report as JSON/CSV","description":"Get full report of personal information attributes and values for requested individual, in JSON or CSV format. \n REQUEST: Scan ID of DSAR parent scan, report format, parameters for pagination of results.\n RESPONSE: Returns all found personal information records - attributes and values - in JSON or CSV format.","parameters":[{"name":"requestId","in":"path","description":"Scan ID of DSAR parent scan","required":true,"schema":{"type":"number"}},{"name":"format","in":"query","description":"JSON or CSV. Default = JSON.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of data rows to return","schema":{"type":"number"}},{"name":"offset","in":"query","description":"Number of rows to skip before starting to count rows","schema":{"type":"number"}},{"name":"excludeObjects","in":"query","description":"Exclude objects from report? Default = include objects","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"identity_unique_id":{"type":"string","example":"829-00-2162"},"row_type":{"type":"string","example":"rdb - record"},"detected_at":{"type":"string","example":"2019-04-30T13:17:54.075Z"},"value":{"type":"string","example":"25/5/1966"},"attribute":{"type":"string","example":"DATE_OF_BIRTH"},"attr_original_name":{"type":"string","example":"DATE_OF_BIRTH"},"scan_id":{"type":"string"},"source":{"type":"string","example":"Sybase"},"fullObjectName":{"type":"string","example":"probe.basic_test"},"shortFieldName":{"type":"string"},"proximityId":{"type":"string"}}}},"objects":{"type":"array","items":{"type":"object","properties":{"identity_unique_id":{"type":"string","example":"829-00-2162"},"row_type":{"type":"string","example":"rdb - object"},"detected_at":{"type":"string","example":"2019-04-30T13:17:54.075Z"},"value":{"type":"string","example":"25/5/1966"},"attribute":{"type":"string","example":"DATE_OF_BIRTH"},"attr_original_name":{"type":"string","example":"DATE_OF_BIRTH"},"scan_id":{"type":"string"},"source":{"type":"string","example":"Sybase"},"fullObjectName":{"type":"string","example":"probe.basic_test"},"shortFieldName":{"type":"string"},"proximityId":{"type":"string"}}}},"offset":{"type":"string","description":"pointer to the next block"},"limit":{"type":"string","description":"max records to show in the result"}}},"example":{"records":[{"identity_unique_id":"829-00-2162","row_type":"rdb-record","detected_at":"2019-04-30T13:17:54.075Z","value":"25/5/1966","attribute":"Date of Birth","attr_original_name":"DATE_OF_BIRTH","scan_id":321321321,"source":"HRsybase","fullObjectName":"probe.basic_test","shortFieldName":"BirthDate","proximityId":7777777}],"objects":[{"identity_unique_id":"829-00-2162","row_type":"rdb-record","detected_at":"2019-04-30T13:17:54.075Z","value":"25/5/1966","attribute":"Date of Birth","attr_original_name":"DATE_OF_BIRTH","scan_id":321321321,"source":"HRsybase","fullObjectName":"probe.basic_test","shortFieldName":"BirthDate","proximityId":7777777}],"offset":50,"limit":200}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}},"delete":{"tags":["Reports"],"summary":"Delete DSAR report","description":"Delete all records in DSAR report. \n REQUEST: Scan ID of DSAR parent scan.\n RESPONSE: Confirmation details","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"isDeletedPersonalInfo":{"type":"boolean"},"isDeletedSarConfiguration":{"type":"boolean"},"isDeletedSarFailedObjects":{"type":"boolean"},"numberJITRecordsRemoved":{"type":"number"},"numberScansExpired":{"type":"number"}}},"example":{"isDeletedPersonalInfo":true,"isDeletedSarConfiguration":true,"isDeletedSarFailedObjects":true,"numberJITRecordsRemoved":0,"numberScansExpired":0}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/reports/{requestId}/short-report":{"get":{"tags":["Reports"],"summary":"Get short/personal report","description":"Get Data Subject Short Report in JSON or CSV format or Personal Info PDF Report for requested individual. See <a href=\"https://www.docs.bigid.com/docs/subject-access-request#section-reports\" target=\"_blank\">Access Request Reports</a> for more information.\n REQUEST: Scan ID of DSAR parent scan.\n RESPONSE: Data Subject Short Report in JSON/CSV format or Personal Info Report in PDF format.\n","parameters":[{"name":"requestId","in":"path","description":"Scan ID of DSAR parent scan","required":true,"schema":{"type":"string"}},{"name":"format","in":"query","description":"Specify requested report:\n * `json` - Data Subject Short Report in JSON format\n * `csv` - Data Subject Short Report in CSV format\n * `pdf` - Personal Info Report in PDF format\n","schema":{"type":"string","default":"json","enum":["json","csv","pdf"]}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","example":"25/5/1966"},"attribute":{"type":"string","example":"DATE_OF_BIRTH"},"att_friendly_name":{"type":"string","example":"Birth Date"},"mask_it":{"type":"boolean","example":false},"purpose_of_use":{"type":"string","example":"Age verification"},"sar_category":{"type":"string","example":""}}}},"example":[{"value":"25/5/1966","attribute":"Date of Birth","att_friendly_name":"Birth Date","mask_it":false,"purpose_of_use":"Age verification","sar_category":""}]},"text/csv":{"schema":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","example":"25/5/1966"},"attribute":{"type":"string","example":"DATE_OF_BIRTH"},"att_friendly_name":{"type":"string","example":"Birth Date"},"mask_it":{"type":"boolean","example":false},"purpose_of_use":{"type":"string","example":"Age verification"},"sar_category":{"type":"string","example":""}}}},"example":"\"Attribute\",\"Value\",\"Purpose Of Use\",\"Category\"\n\"FULLNAME\",\"Thomas U. Banks\",\"\",\"\"\n\"DATE_OF_BIRTH\",\"25/5/1966\",\"\",\"\"\n\"ZIPCODE\",\"25253\",\"\",\"\"\n"},"application/pdf":{"schema":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","example":"25/5/1966"},"attribute":{"type":"string","example":"DATE_OF_BIRTH"},"att_friendly_name":{"type":"string","example":"Birth Date"},"mask_it":{"type":"boolean","example":false},"purpose_of_use":{"type":"string","example":"Age verification"},"sar_category":{"type":"string","example":""}}}},"example":"Personal Info Report PDF\n"}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}},"text/csv":{"schema":{"$ref":"#/components/schemas/errorRbac403"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}},"text/csv":{"schema":{"$ref":"#/components/schemas/errorResponse1"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/reports/{requestId}/summary-report":{"get":{"tags":["Reports"],"summary":"Get Personal Info Report as PDF","description":"Get Personal Info PDF Report for requested individual. See <a href=\"https://www.docs.bigid.com/docs/subject-access-request#section-reports\" target=\"_blank\">Access Request Reports</a> for more information.\n REQUEST: Scan ID of DSAR parent scan.\n RESPONSE: Personal Info Report in PDF format.\n","parameters":[{"name":"requestId","in":"path","description":"Scan ID of DSAR parent scan","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed","content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}}}},"/sar/reports/{requestId}/request-for-remove":{"post":{"tags":["Delete Individual"],"summary":"Request to delete individual's data","description":"Create tasks for data administrator and data source owners to delete personal information records for the specified individual. \n REQUEST: Specify parent scan ID of DSAR run on individual to delete, and ID of user requesting deletion.\n RESPONSE: Returns IDs of tasks created for data administrator (single) and data source owners (array).","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"auth_user","in":"header","description":"Requester username or email","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"SUCCESS"},"taskId":{"type":"string"},"taskIds":{"type":"array","items":{"type":"string"}}}},"example":{"status":"SUCCESS","taskID":778899,"tasksIDs":[112233,445566,665544]}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"FAILURE"},"message":{"type":"string"}}}}}}}}},"/sar/deletion-validations":{"get":{"tags":["Delete Individual"],"summary":"Get all delete requests","description":"Get a list of all currently active deletion validation requests.\nREQUEST: No parameters.\n RESPONSE: Array of currently active deletion validation request details.","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"sarDeletionValidation":{"type":"array","items":{"type":"object","properties":{"created_at":{"type":"string"},"displayName":{"type":"string"},"lastScan":{"type":"string"},"owner":{"type":"string"},"profileId":{"type":"string"},"profileName":{"type":"string"},"requestId":{"type":"string"},"requestIdObj":{"type":"string"},"uniqueId":{"type":"string"},"updated_at":{"type":"string"},"_id":{"type":"string"}}}},"offset":{"type":"number"},"total":{"type":"number"}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":{"sarDeletionValidations":{"created_at":"2020-07-16T14:21:27.721Z","displayName":"Thomas U. Banks","lastScan":"2020-07-16T14:21:27.721Z","owner":"bigid","profileId":"5f0f1592daf5e1a8566b99c2","profileName":"Default Profile","requestId":"5f0f231fdaf5e1a8566bbdbd","requestIdObj":"5f0f231fdaf5e1a8566bbdbd","uniqueId":"829-00-2162","updated_at":"2020-07-16T14:21:27.721Z","_id":"5f106267daf5e1a8566c5b0b"},"offset":2,"total":100},"status":"success","statusCode":200,"massage":"successful operation"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/sar/deletion-validation/{requestId}":{"delete":{"tags":["Delete Individual"],"summary":"Cancel deletion request","description":"Remove request to delete individual's personal data. \n REQUEST: DSAR parent scan ID\n RESPONSE: success(true)/fail(false)","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"deleted":{"type":"boolean"}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":[{"deleted":true}],"status":"success","statusCode":200,"massage":"successful operation"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}}}},"/sar/reports/{requestId}/personal-info":{"get":{"tags":["Reports"],"summary":"Get personal info report","description":"Get Personal Info report for requested individual, including personal information attributes, consent records, and data source information. \n REQUEST: Parent DSAR scan Request ID.\n RESPONSE: Returns Personal Info attributes/values, data sources, consent events and report configuration","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"att_friendly_name":{"type":"string"},"attribute":{"type":"string"},"attribute_value":{"type":"string"},"mask_it":{"type":"boolean"},"purpose_of_use":{"type":"string"},"sar_category":{"type":"string"}}}},"consent":{"type":"array","items":{"type":"object","properties":{"agreement":{"type":"string"},"agreement_version":{"type":"string"},"application_id":{"type":"string"},"date":{"type":"string"},"name":{"type":"string"},"parentScanId":{"type":"string"},"raw":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"timestamp":{"type":"string"},"type_of_consent":{"type":"string"},"unique_id":{"type":"string"}}}},"data_sources":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"report_config":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"is_enabled":{"type":"boolean"}}}},"extended_attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"is_enabled":{"type":"boolean"}}}},"requestId":{"type":"string"},"type":{"type":"string"},"_id":{"type":"string"}}}},"agreementConsentAttributes":{"type":"object","properties":{"attributeNotUnderConsentTypeInAgreement":{"type":"array","items":{"type":"object","properties":{"friendly_name":{"type":"string"},"original_name":{"type":"string"}}}},"attributeUnderConsentTypeInAgreement":{"type":"array","items":{"type":"object","properties":{"friendly_name":{"type":"string"},"original_name":{"type":"string"}}}}}}}},"example":{"attributes":[{"att_friendly_name":"Birth Date","attribute":"DATE_OF_BIRTH","attribute_value":"25/5/1966","mask_it":false,"purpose_of_use":"for test","sar_category":"Yellow"}],"consent":[{"agreement":"Employee contract","agreement_version":2.2,"application_id":"HR-DB","date":"1/1/2005","parentScanId":321321321,"raw":["For internal use only"],"timestamp":"2019-04-30T13:17:54.075Z","type_of_consent":"signature","unique_id":123456789}],"data_sources":[{"location":"USA","name":"HRsybase","type":"sybase"}],"report_config":[{"requestId":123456789,"type":"personal_info_attributes","_id":987654321,"attributes":[{"name":"Birth date","is_enabled":true}],"extended_attributes":[{"name":"Birth date","is_enabled":false}]}],"agreementConsentAttributes":{"attributeNotUnderConsentTypeInAgreement":[{"friendly_name":"residency","original_name":"COUNTRY"}],"attributeUnderConsentTypeInAgreement":[{"friendly_name":"Birth Date","original_name":"DATE_OF_BIRTH"}]}}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/reports/{requestId}/extended-info":{"get":{"tags":["Reports"],"summary":"Get extended info report","description":"Get Extended Info report for requested individual, which includes Personal Information (PI) - these are attributes that are personal information but do not uniquely identify the individual. \n REQUEST: Parent DSAR scan Request ID.\n RESPONSE: Returns PI attributes/values and report settings","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"limit","in":"query","description":"Maximum number of data rows to return (default=1000)","schema":{"type":"number"}},{"name":"offset","in":"query","description":"Number of rows to skip before starting to count rows (default=0)","schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"extended_attributes":{"type":"array","items":{"type":"object","properties":{"att_friendly_name":{"type":"string"},"attribute":{"type":"string"},"value":{"type":"string"},"mask_it":{"type":"boolean"},"purpose_of_use":{"type":"string"},"sar_category":{"type":"string"}}}},"report_config":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"is_enabled":{"type":"boolean"}}}},"extended_attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"is_enabled":{"type":"boolean"}}}},"requestId":{"type":"string"},"type":{"type":"string"},"_id":{"type":"string"}}}},"offset":{"type":"number"}}},"example":{"extended_attributes":[{"att_friendly_name":"Birth Date","attribute":"DATE_OF_BIRTH","attribute_value":"25/5/1966","mask_it":false,"purpose_of_use":"for test","sar_category":"Yellow"}],"report_config":[{"requestId":123456789,"type":"personal_info_attributes","_id":987654321,"attributes":[{"name":"Birth date","is_enabled":true}],"extended_attributes":[{"name":"Birth date","is_enabled":false}]}],"offset":5}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/reports/{requestId}/personal-info/config":{"put":{"tags":["Reports"],"summary":"Configure personal info report","description":"Configure which attributes to include in the Personal Info report for a specified DSAR request. \n REQUEST: DSAR parent scan ID, list of attributes to enable/disable in personal info report.\n RESPONSE: Returns list of attributes enabled/disabled successfully","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"Array containing list of attributes to enable/disable for personal info report","content":{"schema":{"schema":{"type":"object","properties":{"name":{"type":"string"},"is_enabled":{"type":"boolean"},"type":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"isModified":{"type":"boolean"},"name":{"type":"string"}}},"example":{"isModified":true,"name":"DATE_OF_BIRTH"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"x-codegen-request-body-name":"body"}},"/sar/profiles":{"get":{"tags":["Profiles"],"summary":"Get DSAR profiles","description":"Get a list of existing DSAR profile IDs and names. \n REQUEST: No parameters \n RESPONSE: Array of DSAR profile IDs and names.","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}}}}}}},"example":{"profiles":[{"_id":123456,"name":"HRprofile","scopes":["5f9e5f11bfd614fa1cd51535"]},{"_id":11112,"name":"default","scopes":["root"]}]}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]},"post":{"tags":["Profiles"],"summary":"Create DSAR profile","description":"REQUEST: Name for new profile, connection flags \n(use `POST /sar/profiles/{profileId}/connections` to create list of specified data sources and correlation sets for the profile). \n RESPONSE: Profile ID","requestBody":{"description":"A JSON payload containing initial settings for the new profile:\n`name` name for the new profile \n`allEnabledDs` flag to scan all enabled data sources (true) or only data sources specified for the profile (false). \n`allEnabledEs` flag to scan all enabled correlation sets (true) or only correlation sets specified for the profile (false).","content":{"schema":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"OnlineCustomers"},"allEnabledDs":{"type":"boolean"},"allEnabledEs":{"type":"boolean"},"scopes":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"profileId":{"type":"string"}}},"example":{"profileId":123456}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/sar/profiles/{profileId}":{"get":{"tags":["Profiles"],"summary":"Get profile connections","description":"Get a listing of connection settings for a specified profile. \nREQUEST: Profile ID \n RESPONSE: (1) Connection flags specifying whether to scan all enabled data sources and correlation sets (`true`) or only data sources and correlation sets specified for this profile (`false`). (2) list of data sources and correlation sets specified for this profile.","parameters":[{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"_id":{"type":"string"},"updated_at":{"type":"string"},"created_at":{"type":"string"},"name":{"type":"string"},"allEnabledEs":{"type":"boolean"},"allEnabledDs":{"type":"boolean"},"scopes":{"type":"array","items":{"type":"string"}},"dsConnections":{"type":"array","items":{"type":"object","properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"id":{"type":"string"},"connectionStatusScan":{"type":"object","properties":{"is_success":{"type":"boolean"},"last_connection":{"type":"string"},"num_of_object":{"type":"string"}}}}}},"esConnections":{"type":"array","items":{"type":"object","properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"id":{"type":"string"},"connectionStatusScan":{"type":"object","properties":{"is_success":{"type":"boolean"},"last_connection":{"type":"string"},"num_of_object":{"type":"string"}}}}}}}},"example":{"_id":123456,"updated_at":"2019-04-30T13:17:54.075Z","created_at":"2019-04-30T13:17:54.075Z","name":"HRprofile","scopes":["root"],"allEnabledEs":true,"allEnabledDs":true,"dsConnections":[{"enabled":true,"name":"HRsybase","type":"sybase","id":5566,"connectionStatusScan":{"is_success":true,"last_connection":"2019-04-30T13:17:54.075Z","num_of_object":24}}],"esConnections":[{"enabled":true,"name":"HRSybase","type":"sybase","id":560,"connectionStatusScan":{"is_success":true,"last_connection":"2019-04-30T13:17:54.075Z","num_of_object":12}}]}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}},"put":{"tags":["Profiles"],"summary":"Set profile connection flags ","description":"REQUEST: Profile ID, profile name, connection flags specifying whether to scan all enabled data sources and correlation sets (`true`) or only data sources and correlation sets specified for this profile (`false`). \n RESPONSE: Success/fail","parameters":[{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"A JSON payload containing profile name and connection flags to update.","content":{"schema":{"schema":{"type":"object","properties":{"name":{"type":"string"},"allEnabledDs":{"type":"boolean"},"allEnabledEs":{"type":"boolean"},"scopes":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"isModified":{"type":"boolean"}}},"example":{"isModified":true}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"x-codegen-request-body-name":"body"},"delete":{"tags":["Profiles"],"summary":"Delete profile","description":"REQUEST: Profile ID to delete \n RESPONSE: Success/fail","parameters":[{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"isDeleted":{"type":"boolean"}}},"example":{"isDeleted":true}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/profiles/{profileId}/connections":{"post":{"tags":["Profiles"],"summary":"Specify profile connections","description":"Specify a list of data sources and correlation sets for a specified profile. This list is applied only when `allEnabledDs=false` and/or `allEnabledEs=false` (see `PUT /sar/profiles/{profileId}`). \nREQUEST: Profile ID. \n RESPONSE: Success/fail","parameters":[{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"Array of data source and correlation set connections for the profile","content":{"schema":{"schema":{"type":"object","properties":{"connections":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"sourceType":{"type":"string"},"enabled":{"type":"boolean"},"isCaseInSensitiveSupported":{"type":"boolean"},"isReferentialIntegrity":{"type":"boolean"},"isExactMatch":{"type":"boolean"}}}},"profileId":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"isModified":{"type":"boolean"}}}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"x-codegen-request-body-name":"body"},"delete":{"tags":["Profiles"],"summary":"Delete profile connections","description":"Delete list of specific data source and correlation set connections configured for specified profile.\nREQUEST: Profile ID. \n RESPONSE: Success/fail","parameters":[{"name":"profileId","in":"path","description":"Profile id","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"isModified":{"type":"boolean"}}}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/profiles/duplicate":{"post":{"tags":["Profiles"],"summary":"Duplicate profile","description":"REQUEST: Profile ID to duplicate, name for new profile. \n RESPONSE: Success/fail","requestBody":{"description":"A JSON payload containing the ID of the profile being duplicated and the name of the new duplicate profile.","content":{"schema":{"schema":{"type":"object","properties":{"profileIdToDuplicate":{"type":"string","example":"123456"},"name":{"type":"string","example":"NewProfile"}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"profileId":{"type":"string"}}},"example":{"name":"NewProfile","profileId":654321}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/sar/profiles/{profileId}}/fields":{"post":{"tags":["Profiles"],"summary":"Update profile field settings","description":"Update profile field settings, including friendly name, purpose of use, category, mask it and include in reports.\nREQUEST: Profile ID, array of field settings.\n RESPONSE: Count of updated rows. ","parameters":[{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"Array of profile field settings","content":{"schema":{"schema":{"required":["data","query"],"type":"object","properties":{"data":{"type":"object","properties":{"mask_it":{"type":"boolean"},"is_included_in_report":{"type":"string"},"friendly_name_glossary_id":{"type":"string"},"category_glossary_id":{"type":"string"},"purpose_glossary_id":{"type":"string"}}},"query":{"type":"object","properties":{"filter":{"type":"array","items":{"type":"object","properties":{"field":{"type":"boolean"},"operator":{"type":"string"},"value":{"type":"array","items":{"type":"string"}}}}}}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"updatedRows":{"type":"number"}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":[{"updatedRows":2}],"status":"success","statusCode":200,"massage":"successful operation"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}},"x-codegen-request-body-name":"body"}},"/sar/reports/bulk/csv-format":{"get":{"tags":["Bulk Request"],"summary":"Get bulk template","description":"Get CSV file template for bulk request. \nREQUEST: Profile ID for bulk request. \nRESPONSE: CSV template, in string format","parameters":[{"name":"profileId","in":"query","description":"Profile ID to use for bulk request","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"text/csv":{"schema":{"type":"object","properties":{"data":{"type":"string"}}}},"application/json":{"example":{"data":"string"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"text/csv":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"text/csv":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/sar/reports/bulk-from-csv":{"post":{"tags":["Bulk Request"],"summary":"Run bulk DSAR from CSV file","description":"Upload CSV bulk file and execute DSAR requests. \nREQUEST: Profile ID, CSV bulk request, callback information for asynchronous progress update \nRESPONSE: (synchronous) array of request IDs and user IDs","parameters":[{"name":"profileId","in":"query","description":"Profile ID to use for bulk request","schema":{"type":"string"}},{"name":"callbackUrl","in":"query","description":"POST request URL called on completion of search scan","schema":{"type":"string"}},{"name":"ssl_trust_store_path","in":"query","description":"Path of certificate to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_store_password","in":"query","description":"Password (if exists) to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_self_signed","in":"query","description":"Should callback trust self-signed certificates? (TRUE/FALSE)","schema":{"type":"string"}},{"name":"headers","in":"query","description":"If needed, specify headers for POST request here. Syntax `\"ThisHeader\"=\"HeaderValue\"`","schema":{"type":"string"}},{"name":"groupCallbackResponse","in":"query","description":"decide if should group all the callbacks","schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"text/csv":{"schema":{"type":"object","properties":{"jitFullScanIds":{"type":"array","items":{"type":"string"}},"requests":{"type":"array","items":{"type":"object","properties":{"requestId":{"type":"string"},"userId":{"type":"string"}}}}}}},"application/json":{"example":{"jitFullScanIds":["dfg"]}}}},"500":{"description":"Failed operation","content":{"text/csv":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/sar/reports/bulk":{"post":{"tags":["Bulk Request"],"summary":"Run JSON bulk DSAR","description":"Execute DSAR scans for individuals specified in JSON payload. \nREQUEST: Profile ID, JSON payload, callback information for asynchronous progress update \nRESPONSE: Array of DSAR scan IDs","parameters":[{"name":"profileId","in":"query","description":"Profile ID, defining which entity sources and data sources to scan","schema":{"type":"string"}},{"name":"callbackUrl","in":"query","description":"POST request URL called on completion of search scan","schema":{"type":"string"}},{"name":"ssl_trust_store_path","in":"query","description":"Path of certificate to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_store_password","in":"query","description":"Password (if exists) to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_self_signed","in":"query","description":"Should callback trust self-signed certificates? (TRUE/FALSE)","schema":{"type":"string"}},{"name":"headers","in":"query","description":"If needed, specify headers for POST request here. Syntax `\"ThisHeader\"=\"HeaderValue\"`","schema":{"type":"string"}},{"name":"userId","in":"query","description":"Unique ID of the individual to run the DSAR scan on","required":true,"schema":{"type":"string"}},{"name":"displayName","in":"query","description":"Name of the individual to run the DSAR scan on","required":true,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"Optional. If not specified, scan will automatically extract all relevant attributes from allowed entity sources. If specified, scan will use these attributes to correlate additional fields. Syntax `<attribute_name>:<attribute_value>`.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"A JSON payload containing the Unique ID, Display Name and whatever other identifying attributes of the requested individual are known.","content":{"multipart/form-data":{"schema":{"required":["usersDetails"],"type":"object","properties":{"profileId":{"type":"string","example":"123456"},"callbackUrl":{"type":"string","example":"http://www.example.com"},"groupCallbackResponse":{"type":"boolean"},"callbackUrlProperties":{"type":"object","properties":{"ssl_trust_store_path":{"type":"string","example":".../folder1/folder2"},"ssl_trust_store_password":{"type":"string","example":"mypassword123"},"ssl_trust_self_signed":{"type":"boolean","example":true},"headers":{"type":"object","properties":{"authorization":{"type":"string","example":"ffff"}}}}},"usersDetails":{"type":"array","items":{"required":["displayName","userId"],"type":"object","properties":{"userId":{"type":"string","example":"123456789"},"displayName":{"type":"string","example":"Thomas Banks"},"attributes":{"type":"object","properties":{"attribute1":{"type":"number"},"attribute2":{"type":"string","example":"[email protected]"}}}}}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"text/csv":{"schema":{"type":"object","properties":{"jitFullScanIds":{"type":"array","items":{"type":"string"}}}}},"application/json":{"example":{"jitFullScanIds":["dfg"]}}}},"500":{"description":"Failed operation","content":{"text/csv":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"x-codegen-request-body-name":"body"}},"/sar/config/file-download/config-report":{"get":{"tags":["Reports"],"summary":"Get short report settings CSV","description":"Download DSAR Short Report settings, in CSV file.\nREQUEST: Profile ID \nRESPONSE: String listing attributes enabled in this profile for Short Report.","parameters":[{"name":"profileId","in":"query","description":"Profile ID for which to get short report settings","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"attachment/octet-stream":{"schema":{"type":"string","format":"binary"}},"application/json":{"example":{"message":"string"}}}},"500":{"description":"Failed operation","content":{"attachment/octet-stream":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/sar/config":{"get":{"tags":["Reports"],"summary":"Get report settings","description":"Get report settings in an array listing attributes and configurations.\n REQUEST: Paramaters for paginating result set.\nRESPONSE: Return report settings","parameters":[{"name":"limit","in":"query","description":"Maximum number of data rows to return","schema":{"type":"number"}},{"name":"offset","in":"query","description":"Number of rows to skip before starting to count rows","schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sarFieldsConf":{"type":"object","properties":{"_id":{"type":"string"},"attribute_type":{"type":"string"},"field_name":{"type":"string"},"is_primary":{"type":"boolean"},"fully_qualified_name":{"type":"string"},"data_source":{"type":"string"},"schema":{"type":"string"},"table":{"type":"string"},"attribute_name":{"type":"string"},"correlation_id":{"type":"string"},"sample_values":{"type":"string"},"field_name_lower":{"type":"string"},"is_included_in_report":{"type":"boolean"},"mask_it":{"type":"boolean"},"category":{"type":"string"},"purpose_of_use":{"type":"string"}}},"offset":{"type":"number"}}},"example":{"sarFieldsConf":[{"_id":"5f14327adaf5e1a8566d48c7","attribute_type":"Correlation","field_name":"COUNTRY","is_primary":false,"fully_qualified_name":"Sybase.probe.basic_test","data_source":"Sybase","schema":"probe","table":"basic_test","attribute_name":"country","correlation_id":"5f143268daf5e1a8566d474b","sample_values":"RU","field_name_lower":"country","is_included_in_report":true,"mask_it":false,"field_friendly_name":"","category":"","purpose_of_use":""}],"offset":1}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}}}},"/sar/reports/{requestId}/failed-objects":{"get":{"tags":["Reports"],"summary":"Get failed objects report","description":"Get a list of objects that failed to scan in a specified DSAR scan, in JSON/CSV file.\nREQUEST: Request ID, report format \nRESPONSE: Array of failed object details and error messages.","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"format","in":"query","description":"JSON or CSV. Default = JSON.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"failedObject":{"type":"array","items":{"type":"object","properties":{"updated_at":{"type":"string"},"scanId":{"type":"string"},"source":{"type":"string"},"fullyQualifiedName":{"type":"string"},"errorMessage":{"type":"string"}}}}}},"example":{"failedObject":[{"updated_at":"25/5/1966","scanId":"5ef0954118a5f148c66287ba","source":"Sybase","fullyQualifiedName":"Sybase.probe.basic_test","errorMessage":"Failed to create connection"}]}},"text/csv":{"schema":{"type":"object","properties":{"failedObject":{"type":"array","items":{"type":"object","properties":{"updated_at":{"type":"string"},"scanId":{"type":"string"},"source":{"type":"string"},"fullyQualifiedName":{"type":"string"},"errorMessage":{"type":"string"}}}}}},"example":"\"Timestamp\",\"Scan ID\",\"Data Source\",\"Object\",\"Failure Reason\"\n\"2020-06-22T11:25:57.518Z\",\"5ef0954118a5f148c66287ba\",\"Sybase\",\"Failed to create connection\"\n\"2020-06-22T11:25:57.518Z\",\"5ef0954118a5f148c66287bb\",\"Sybase\",\"Failed to create connection\"\n"}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}},"text/csv":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}},"text/csv":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/sar/config/import":{"post":{"tags":["Reports"],"summary":"Import short report settings","description":"Import short report settings CSV file for specified profile. \nREQUEST: CSV file listing attributes to include in short report, Profile ID \nRESPONSE: success/operation-queued/fail","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file","profileId"],"properties":{"file":{"type":"string","description":"CSV file containing this profile's short report settings","format":"binary"},"profileId":{"type":"string","description":"Profile ID"}}}}},"required":true},"responses":{"200":{"description":"operation has been initiated successfuly","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"operation has been initiated successfully"}}}},"202":{"description":"operation queued - another process is currently running for this profile ID","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"operation queued - another process is currently running for this profile ID"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/sar/reports/{requestId}/external-records":{"post":{"tags":["Reports"],"summary":"Add external records","description":"Add external records to be included in the individual's DSAR reports. \nREQUEST: Request ID, JSON payload containing array of records to append. \nRESPONSE: Count of records inserted.","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"A JSON payload containing an array of record objects. `source`and `objectName` are required. `fieldName` or `attribute` are required.","content":{"multipart/form-data":{"schema":{"required":["records"],"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"objectName":{"type":"string"},"fieldName":{"type":"string"},"value":{"type":"string"},"proximityId":{"type":"string"},"sourceLocation":{"type":"string"},"attribute":{"type":"string"}}}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"insertedCount":{"type":"number"}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":[{"insertedCount":1}],"status":"success","statusCode":200,"massage":"successful operation"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}},"x-codegen-request-body-name":"body"},"delete":{"tags":["Reports"],"summary":"Delete external records","description":"Delete external records for specified Request ID. \nREQUEST: Request ID \nRESPONSE: Count of records deleted","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"deletedCount":{"type":"number"}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":[{"deletedCount":1}],"status":"success","statusCode":200,"massage":"successful operation"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}}}},"/sar/scans":{"get":{"tags":["Monitoring"],"summary":"Get all DSAR scans history","description":"REQUEST: Get a list of all DSAR scans - can filter by scan state.\n RESPONSE: Returns an array of DSAR scan IDs and summary parameters.","parameters":[{"name":"limit","in":"query","description":"Maximum number of data rows to return","schema":{"type":"number"}},{"name":"offset","in":"query","description":"Number of rows to skip before starting to count rows","schema":{"type":"number"}},{"name":"state","in":"query","description":"Filter returned scans by state (completed/stopped/in progress). If blank, returns all states.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"scans":{"type":"array","items":{"type":"object","properties":{"request_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"scan_progress_status":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"type":{"type":"string"},"state":{"type":"string"},"identity_unique_id":{"type":"string"},"record_count":{"type":"number"},"auth_user":{"type":"string"},"profile_id":{"type":"string"},"profile_name":{"type":"string"},"expires_on":{"type":"string"},"data_expired":{"type":"boolean"},"data_deleted":{"type":"boolean"},"sub_scan_finished":{"type":"number"}}}}}},"example":{"scans":[{"request_id":321321321,"created_at":"2019-04-30T13:17:54.075Z","updated_at":"2019-04-30T13:17:54.075Z","scan_progress_status":["completed"],"name":"JIT Full Scan","type":"JIT sub scan","state":"completed","identity_unique_id":123456789,"record_count":88,"auth_user":"[email protected]","profile_id":123456,"profile_name":"HRprofile","expires_on":"1/1/2020","data_expired":false,"data_deleted":false,"sub_scan_finished":7}]}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/scans/{requestId}":{"get":{"tags":["Monitoring"],"summary":"Get specific DSAR scan history","description":"REQUEST: Specify DSAR parent scan ID. Can also filter by scan state.\n RESPONSE: Returns an array of scan information, including parent and sub-scans.","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"limit","in":"query","description":"Maximum number of data rows to return","schema":{"type":"number"}},{"name":"offset","in":"query","description":"Number of rows to skip before starting to count rows","schema":{"type":"number"}},{"name":"state","in":"query","description":"Filter returned scans by state (completed/stopped/in progress). If blank, returns all states.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"scans":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal unique ID"},"request_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"scan_progress_status":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"type":{"type":"string"},"state":{"type":"string"},"identity_unique_id":{"type":"string"},"record_count":{"type":"number"},"auth_user":{"type":"string"},"profile_id":{"type":"string"},"profile_name":{"type":"string"},"expires_on":{"type":"string"},"data_expired":{"type":"boolean"},"data_deleted":{"type":"boolean"},"sub_scan_finished":{"type":"number"},"totalCount":{"type":"number","description":"Total count of subscans that matched filter criteria","example":4},"sub_scans":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal unique ID"},"sub_scan_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"scan_progress_status":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"type":{"type":"string"},"state":{"type":"string"},"parent_scan_id":{"type":"string"},"ds_connection_name":{"type":"string"},"identity_unique_id":{"type":"string"},"identity_display_name":{"type":"string"},"connectorType":{"type":"string"},"scanner_group":{"type":"string"},"parent_scan_type":{"type":"string"},"is_report_ready":{"type":"boolean"},"is_deletion_validation":{"type":"boolean"},"scannerId":{"type":"string"},"record_count":{"type":"number"},"errorMessage":{"type":"string"},"auth_user":{"type":"string"},"profile_id":{"type":"string"},"profile_name":{"type":"string"},"expires_on":{"type":"string"},"data_expired":{"type":"boolean"},"data_deleted":{"type":"boolean"},"finalCollectionsCount":{"type":"number"},"totalCollections":{"type":"number"},"totalFailedCollections":{"type":"number"},"info":{"type":"string","description":"Scan progress info","example":"Objects scanned: 3, Failures: 1"}}}}}}}}},"example":{"scans":[{"request_id":321321321,"created_at":"2019-04-30T13:17:54.075Z","updated_at":"2019-04-30T13:17:54.075Z","scan_progress_status":["completed"],"name":"JIT - Request ID 123456789","type":"JIT sub scan","state":"completed","identity_unique_id":123456789,"record_count":88,"auth_user":"[email protected]","profile_id":123456,"profile_name":"HRprofile","expires_on":"1/1/2020","data_expired":false,"data_deleted":false,"sub_scan_finished":7,"sub_scans":[{"sub_scan_id":123123123,"created_at":"2019-04-30T13:17:54.075Z","updated_at":"2019-04-30T13:17:54.075Z","scan_progress_status":["completed"],"name":"Sybase1, Unique ID: 829-00-2162","type":"jit sub-scan","state":"completed","parent_scan_id":321321321,"ds_connection_name":"HRsybase","identity_unique_id":123456789,"identity_display_name":"Thomas Banks","connectorType":"sybase","scanner_group":"default","parent_scan_type":"jit scan","is_report_ready":true,"is_deletion_validation":false,"scannerId":12345,"record_count":31,"auth_user":"[email protected]","profile_id":123456,"profile_name":"HRprofile","expires_on":"1/1/2020","data_expired":false,"data_deleted":false,"finalCollectionsCount":10,"totalCollections":12,"totalFailedCollections":2,"info":"Objects scanned: 3, Failures: 1"}]}]}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/jit_scans":{"get":{"tags":["Monitoring"],"summary":"Get DSAR scans history (older version)","description":"REQUEST: Get all or filter by DSAR parent scan ID.\n RESPONSE: Returns an array of DSAR scan information.","parameters":[{"name":"filter","in":"query","description":"DSAR parent scan ID. If blank, return all scans. Can also filter by scan state. Syntax: `state=completed `","schema":{"type":"string"}},{"name":"allScans","in":"query","description":"`TRUE` return all JIT scans. `FALSE` return only non-deleted JIT scans. Default = `FALSE`","schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"create_date":{"type":"string"},"data_deleted":{"type":"boolean"},"data_expired":{"type":"boolean"},"expires_on":{"type":"string"},"identity_display_name":{"type":"string"},"isAllCompleted":{"type":"boolean"},"is_report_ready":{"type":"boolean"},"parent_scan_id":{"type":"string"},"record_count":{"type":"number"},"statuses_set":{"type":"array","items":{"type":"string"}},"statuses_str":{"type":"string"},"stopRequested":{"type":"boolean"},"user_id":{"type":"string"},"profile_id":{"type":"string"},"profile_name":{"type":"string"}}}},"example":[{"create_date":"2019-04-30T13:17:54.075Z","data_deleted":false,"data_expired":false,"expires_on":"1/1/2020","identity_display_name":"Thomas Banks","isAllCompleted":true,"is_report_ready":true,"parent_scan_id":321321321,"record_count":88,"statuses_set":["string"],"stopRequested":false,"user_id":"[email protected]","profile_id":123456,"profile_name":"HRprofile"}]}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"type":"string","example":"Error"}}}}}}},"/sar/reports/{requestId}/searched-attributes":{"get":{"tags":["Monitoring"],"summary":"Get searched attributes","description":"Get a list of attributes that were used to search for the individual in a specified DSAR request. \n REQUEST: DSAR parent scan ID.\n RESPONSE: Returns the list of searched attributes and their values.","parameters":[{"name":"requestId","in":"path","description":"Parent scan ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"searchedAttributes":{"type":"object","properties":{"allAttributes":{"type":"object","properties":{}},"searchableAttributes":{"type":"object","properties":{}}}}}},"example":{"searchedAttributes":{"allAttributes":{"ssn":123344567,"email":"[email protected]","favorite_color":"blue"},"searchableAttributes":{"ssn":123344567,"email":"[email protected]"}}}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}},"delete":{"tags":["Monitoring"],"summary":"Delete searched attributes","description":"Delete the list of attributes and values that were used in a specified DSAR request. \n REQUEST: DSAR parent scan ID.\n RESPONSE: Success/failure","parameters":[{"name":"requestId","in":"path","description":"Parent scan ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/reports/{requestId}/status":{"get":{"tags":["Monitoring"],"summary":"Get individual scan status","description":"Get scan status for specified individual.\n REQUEST: Parent scan ID. \n RESPONSE: Completion status and details of parent scan and subscans.","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"requestId":{"type":"string"},"userId":{"type":"string"},"state":{"type":"string"},"statuses":{"type":"object","properties":{}},"subScansInfo":{"type":"array","items":{"type":"object","properties":{"scanId":{"type":"string"},"dataSourceName":{"type":"string"},"state":{"type":"string"},"scannedObjects":{"type":"number"},"failedObjects":{"type":"number"},"error":{"type":"string"}}}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":{"requestId":"5f156f68daf5e1a8566df122","userId":"829-00-2162","state":"Completed","statuses":{"Completed":2},"subScansInfo":[{"scanId":"5f156fa3daf5e1a8566df19b","dataSourceName":"Sybase","state":"Completed","scannedObjects":1,"failedObjects":0},{"scanId":"5f156f69daf5e1a8566df15b","state":"Completed","scannedObjects":0,"failedObjects":0}]},"status":"success","statusCode":200,"massage":"successful operation"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}}}},"/sar/attributes-enrichment":{"get":{"tags":["Attributes Enrichment"],"summary":"Get all enrichment flow names","description":"Get a list of all enrichment flow names in the system. \nREQUEST: No parameters.\nRESPONSE: List of enrichment flow names.","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"names":{"type":"array","items":{"type":"string"}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":{"names":["name1","name2"],"status":"success","statusCode":200,"message":"successful operation"}}}}},"400":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"Expected a value of type string"}],"status":"error","statusCode":400,"message":"The provided request has invalid payload"}}}},"500":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"internal error"}],"status":"error","statusCode":500,"message":"internal error"}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/sar/attributes-enrichment/{flowName}":{"get":{"tags":["Attributes Enrichment"],"summary":"Get enrichment flow steps","description":"Get a list of steps in the specified enrichment flow.\nREQUEST: Flow name.\nRESPONSE: Listing of steps mapping fields in the enrichment flow - from/to/origin.","parameters":[{"name":"flowName","in":"path","description":"Flow name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"attributesEnrichmentFlow":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"index":{"type":"number"},"source":{"type":"string"},"fieldsMapping":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"source":{"type":"string"}}}}}}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":{"attributesEnrichmentFlow":[{"name":"model"},{"index":0},{"source":"entity source"},{"fieldsMapping":[{"from":"origin attribute"},{"to":"distance attribute"},{"origin":"entity source to take the value from"}]}]},"status":"success","statusCode":200,"message":"successful operation"}}}},"400":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"Expected a value of type string"}],"status":"error","statusCode":400,"message":"The provided request has invalid payload"}}}},"500":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"internal error"}],"status":"error","statusCode":500,"message":"internal error"}}}}}},"post":{"tags":["Attributes Enrichment"],"summary":"Create enrichment flow","description":"Create correlation set field mappings for enrichment flow.\nREQUEST: Flow name, field mappings - from/to/origin.\nRESPONSE: Count of flow steps inserted.","parameters":[{"name":"flowName","in":"path","description":"Flow name to create","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"content":{"schema":{"schema":{"required":["flow"],"type":"object","properties":{"flow":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string","example":"entity source"},"fieldsMapping":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","example":"origin attribute"},"to":{"type":"string","example":"current attribute"},"origin":{"type":"string","example":"the entity source to take the value from"}}}}}}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"name":{"type":"string"},"insertedSteps":{"type":"integer"}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":{"name":"attributes-enrichment-model","insertedSteps":7},"status":"success","statusCode":200,"message":"successful operation"}}}},"400":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"Expected a value of type string"}],"status":"error","statusCode":400,"message":"The provided request has invalid payload"}}}},"500":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"internal error"}],"status":"error","statusCode":500,"message":"internal error"}}}}},"x-codegen-request-body-name":"body"},"delete":{"tags":["Attributes Enrichment"],"summary":"Delete enrichment flow","description":"Delete specified enrichment flow.\nREQUEST: Enrichment flow name.\nRESPONSE: Count of flow steps deleted.","parameters":[{"name":"flowName","in":"path","description":"Flow name to delete","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"deletedSteps":{"type":"integer"},"name":{"type":"string"}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":{"deletedSteps":2,"name":"attribute-enrichment-flow"},"status":"success","statusCode":200,"message":"successful operation"}}}},"400":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"Expected a value of type string"}],"status":"error","statusCode":400,"message":"The provided request has invalid payload"}}}},"500":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"internal error"}],"status":"error","statusCode":500,"message":"internal error"}}}}}}},"/sar/attributes-enrichment/{flowName}/enrich":{"post":{"tags":["Attributes Enrichment"],"summary":"Run enrichment flow","description":"Run specified enrichment flow for specified individual.\nREQUEST: Enrichment flow name, identifying attribute(s) for individual.\nRESPONSE: Array of enrichment attributes and values found for the individual. ","parameters":[{"name":"flowName","in":"path","description":"Enrichment flow name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"Enrichment attributes and values found","content":{"schema":{"schema":{"required":["attributes"],"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"full_name"},"value":{"type":"string","example":"Yair Shkedi"}}}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"attributesEnrichment":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"attributesMap":{"type":"object","properties":{}}}}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":{"attributesEnrichment":{"source":"entity source","attributesMap":[{"fullName":"Yair Shkedi"},{"zipcode":123456},{"id":654321}]}},"status":"success","statusCode":200,"message":"successful operation"}}}},"400":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"Expected a value of type string"}],"status":"error","statusCode":400,"message":"The provided request has invalid payload"}}}},"500":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"internal error"}],"status":"error","statusCode":500,"message":"internal error"}}}}},"x-codegen-request-body-name":"body"}},"/sar/audit":{"get":{"tags":["Audit"],"summary":"Get audit logs","description":"Get all audit logs.\n REQUEST: Pagination parameters, sort criteria. \n RESPONSE: Structured array of log entries.","parameters":[{"name":"limit","in":"query","description":"Maximum number of data rows to return","schema":{"type":"number"}},{"name":"skip","in":"query","description":"Number of rows to skip before starting to count rows","schema":{"type":"number"}},{"name":"requireTotalCount","in":"query","description":"Return count of total records? (default = false)","schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string"},"endpoint":{"type":"string"},"id":{"type":"string"},"requestId":{"type":"string"},"timestamp":{"type":"string"},"uniqueId":{"type":"string"},"user":{"type":"string"},"userAgent":{"type":"string"}}}},"total":{"type":"number"}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":[{"results":[{"action":"GET","endpoint":"/api/v1/sar/...","id":"5f157f12daf5e1a8566e092a","requestId":"5f156f68daf5e1a8566df122","timestamp":"2020-07-20T11:25:06.973Z","uniqueId":"829-00-2162","user":"bigid","userAgent":"Mozilla/5.0"}],"offset":2,"total":100}],"status":"success","statusCode":200,"massage":"successful operation"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}},"x-codegen-request-body-name":"sort"}},"/sar/sar-queries":{"get":{"tags":["Query"],"summary":"Get DSAR queries","description":"Get DSAR queries by filter.\n REQUEST: object name, scan id, parent scan id criterias. \n RESPONSE: Structured array of query objects.","parameters":[{"name":"scanId","in":"query","description":"DSAR sub-request id","schema":{"type":"string"}},{"name":"parentScanId","in":"query","description":"DSAR request id","schema":{"type":"string"}},{"name":"objectName","in":"query","description":"Name of the object","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"scanId":{"type":"string","example":"5f97e32c85f3d92cc16fda98"},"parentScanId":{"type":"string","example":"5f97e32b85f3d92cc16fda76"},"objectName":{"type":"string","example":"TABLE_NAME"},"query":{"type":"string","example":"SELECT column1 FROM TABLE_NAME where column1 = 'A'"}}},"example":{"data":[{"_id":"5f97e34e85f3d92cc16fdbe1","created_at":"2020-10-27T09:07:26.413Z","objectName":"TRANSACTION_DETAILS_1","parentScanId":"5f97e34a85f3d92cc16fdb99","query":"SELECT \"TRANSACTION_ID\" FROM \"instance\".\"schema\".\"table\" WHERE ((TRANSACTION_ID = '100009'))","scanId":"5f97e34a85f3d92cc16fdbaf","updated_at":"2020-10-27T09:07:26.413Z"}],"status":"success","statusCode":200,"massage":"successful operation"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}}},"post":{"tags":["Query"],"summary":"Get DSAR queries","description":"Get DSAR queries by filter.\n REQUEST: object name, scan id, parent scan id criterias. \n RESPONSE: Structured array of query objects.","requestBody":{"description":"A JSON payload containing the Scan ID, Parent Scan ID, Object Name, DSAR Query","content":{"schema":{"schema":{"required":["objectName","parentScanId","query","scanId"],"type":"object","properties":{"parentScanId":{"type":"string","description":"DSAR sub-request id"},"scanId":{"type":"string","description":"DSAR request id"},"objectName":{"type":"string","description":"Name of the object"},"query":{"type":"string","description":"DSAR query"}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"5f97e32c85f3d92cc16fda98"}}},"example":{"data":[{"_id":"5f97e34e85f3d92cc16fdbe1"}],"status":"success","statusCode":200,"massage":"successful operation"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/scan-api/analyze":{"post":{"tags":["Scan API"],"summary":"Scan API (asynchronously)","description":"Scan a payload asynchronously. If data is valid, a 202 (Accepted) status code is returned. This endpoint can be used in two modes:\n - body contains source, channel and payload. This mode is useful for programmatic invocation.\n - body is the payload, source is passed in X-BIGID-SOURCE and chanel is passed in X-BIGID-CHANNEL header.\n This mode is useful for monitoring an API gateway's traffic.","operationId":"asyncScanApi","parameters":[{"name":"X-BIGID-CHANNEL","in":"header","description":"An alternative way to pass a channel. \n If used, message body will be used as the payload, the message body will be used as the payload, channel from X-BIGID-CHANNEL and source will be taken from X-BIGID-SOURCE.","schema":{"type":"string"}},{"name":"X-BIGID-SOURCE","in":"header","description":"An alternative way to pass a source. \n If X-BIGID-CHANNEL is set, the message body will be used as the payload, channel from X-BIGID-CHANNEL and source will be taken from X-BIGID-SOURCE.\n If X-BIGID-CHANNEL is not set - this field will be ignored.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"Source, channel and payload of the scan payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadRequestSchema"}}},"required":true},"responses":{"202":{"description":"Accepted - the scan will be done asynchronously.","content":{"application/json":{"schema":{"required":["status"],"type":"object","properties":{"status":{"type":"string","example":"Accepted"}}}}}},"400":{"description":"No channel or no Payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"403":{"description":"Feature is not enabled on server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"500":{"description":"Unknown server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}}},"x-codegen-request-body-name":"body"}},"/scan-api/classify":{"post":{"tags":["Scan API"],"summary":"Scan payload for classifications (Synchronously).","description":"Scan payload for classifiers (including NER). Return the list of classifiers found.","operationId":"syncScanApiClassify","requestBody":{"description":"Source, channel and payload to the scan payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadRequestSchema"}}},"required":true},"responses":{"200":{"description":"An object which describes all found classifications.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"No channel or no Payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"403":{"description":"Feature is not enabled on server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"500":{"description":"Unknown server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/scan-api/correlate":{"post":{"tags":["Scan API"],"summary":"Get Entity Source (IDSoR) Attribute (not classifiers) synchronously. Return the list of IDSoR Attributes found.","operationId":"syncScanApiCorrelate","requestBody":{"description":"Source, channel and payload to the scan payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadRequestSchema"}}},"required":true},"responses":{"200":{"description":"List of IDSoR Attributes found.","content":{}},"400":{"description":"No channel or no Payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"403":{"description":"Feature is not enabled on server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"500":{"description":"Unknown server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/scan-api/check-policies":{"post":{"tags":["Scan API"],"summary":"Get which policies are violated by this message (synchronously)","operationId":"syncScanApiCheckPolicies","requestBody":{"description":"Source, channel and payload to the scan payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadRequestSchema"}}},"required":true},"responses":{"200":{"description":"List of policies that have violated this message.","content":{}},"400":{"description":"No channel or no Payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"403":{"description":"Feature is not enabled on server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"500":{"description":"Unknown server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/scan-api/entities":{"post":{"tags":["Scan API"],"summary":"Get which entities (identities) have been correlated to this messages (synchronously) (e.g. this message contains Danny’s SSN)","operationId":"syncScanApiEntities","requestBody":{"description":"Source, channel and payload to the scan payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadRequestSchema"}}},"required":true},"responses":{"200":{"description":"List of entities (identities) that have been correlated to this messages (e.g. this message contains Danny’s SSN).","content":{}},"400":{"description":"No channel or no Payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"403":{"description":"Feature is not enabled on server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"500":{"description":"Unknown server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/scan-api/residencies":{"post":{"tags":["Scan API"],"summary":"Synchronously get list of residencies (identities) have been correlated to this messages.","operationId":"syncScanApiResidencies","requestBody":{"description":"Source, channel and payload to the scan payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadRequestSchema"}}},"required":true},"responses":{"200":{"description":"List of residencies (identities) that have been correlated to this messages","content":{}},"400":{"description":"No channel or no Payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"403":{"description":"Feature is not enabled on server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"500":{"description":"Unknown server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/scan-result/stream/json":{"get":{"tags":["Scan results"],"summary":"Get Scan results info","description":"Get Scan results info.","parameters":[{"name":"pageSize","in":"query","description":"page size for pagination use","schema":{"type":"number"}},{"name":"limit","in":"query","description":"maximum records return from the api call","schema":{"type":"number"}},{"name":"offset","in":"query","description":"records offset for pagination use","schema":{"type":"number"}},{"name":"sort","in":"query","description":"gives the user the option to sort the records return by a certain field (accending/decending)","schema":{"type":"string"}},{"name":"skip","in":"query","description":"gives the user the option to skip the first number of records return from the api. if skip = 5 and limit = 100, the api will return the last 95 records","schema":{"type":"number"}},{"name":"filter","in":"query","description":"gives the user the option to filter the records, using bigid query language.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Get Scan results info","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/dataItem"}},"example":[{"_id":"5eb02fc8e0fd6afb73029cef","hashId":"f366703f7150e20a0dd6034d9a370a0b","attribute":"","attributeRecordsCount":1600,"avgRisk":-1,"fieldName":"","object":"","owner":"","source":"mysql-ds-enrichment-tests","update_date":"2020-05-04T15:07:52.350Z","attribute_original_name":"","attribute_name":"","type":"rdb-mysql","location":"Israel","last_scan_at":"2020-05-04T15:06:58.926Z"},{"_id":"5eb02fc8e0fd6afb73029ce0","hashId":"4a89f10bebb9bfe64fb5e2796f4e3560","attribute":"country","attributeRecordsCount":400,"attribute_type":"IDSoR Attribute","avgRisk":-1,"source":"mysql-ds-enrichment-tests","update_date":"2020-05-04T15:07:52.330Z","pii_investigation_join_field":{"attribute":"country","data_source":"mysql-ds-enrichment-tests"},"attribute_original_name":"country","attribute_name":"country","type":"rdb-mysql","location":"Israel","last_scan_at":"2020-05-04T15:06:58.926Z"},{"_id":"5eb02faae0fd6afb73028eab","hashId":"693b4a8ca2072146054708ceed6c9687","att_stat":[{"identification_score":0.13,"overrideSureMatch":false,"stdDevPop_ids_per_value":6.831877941899851,"number_values_count":0,"distinct_ids_with_att_field":100,"distinct_ids_with_att_val":100,"avg_values_length":8.384615384615385,"stdDev_values_length":5.076923076923077,"max_att_pii":100,"avg_identities_per_value":7.6923076923076925,"distinct_field_value_count":13,"_id":"country","max_att_ids":100,"_class":"com.bigid.correlator.correlatordomain.domain.AttributeStatistics"}],"attribute":"country","attributeDistIdsCount":0,"attributeDistValsCount":1,"attributeFindingsCount":1,"attributeRecordsCount":0,"attributeRecordsCountNumbers":0,"attribute_type":"IDSoR Attribute","confidence_level":0,"count_full_match":0,"count_full_sure_match":0,"count_pos0":0,"count_pseudo_match":0,"count_sure_match":0,"fieldCount":1000,"fieldFindingsCount":1,"fieldMaxIds":0,"fieldMaxPii":0,"fieldName":"city","fieldPiiCount":0,"findings_avg_len":6,"findings_full_match":0,"findings_pos0":0,"fullyQualifiedName":"mysql-ds-enrichment-tests.ben.pause_resume_view1","scanId":"5eb02f92e0fd6afb730289a2","source":"mysql-ds-enrichment-tests","totalPiiRecordsCount":400,"update_date":"2020-05-04T15:07:22.743Z","attribute_original_name":"country","attribute_name":"country","rank":"3 - Low","type":"rdb-mysql","location":"Israel","last_scan_at":"2020-05-04T15:06:58.926Z","owner":"ben","object":"pause_resume_view1","calculatedRank":"3 - Low"}]}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg3"}}}}}}},"/sessions":{"post":{"tags":["Session Token"],"summary":"Generate session token","description":"Use this API to generate a session login token. A session login token expires 24 hours after creation.\n Use recieved token in header parameter 'authorization' in every succeeding API call.\n REQUEST: Put username and password. \n RESPONSE: Returns auth_token.","requestBody":{"description":"put user basic authentication credentials.","content":{"schema":{"schema":{"required":["password","username"],"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string","example":"Enjoy your token!"},"auth_token":{"type":"string"},"username":{"type":"string"},"firstName":{"type":"string"},"permissions":{"type":"array","items":{"type":"string","example":"api"}}}},"example":{"success":true,"message":"Enjoyyourtoken!","auth_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJiaWdpZCIsInR5cGUiOiJhY2Nlc3MtdG9rZW4iLCJyb2xlSWRzIjpbIjViYWE0Y2VkNTkxZTc1NzFhOTRlY2I2ZSJdLCJpc0FkbWluIjp0cnVlLCJpYXQiOjE1NzQyNTYwNDUsImV4cCI6MTU3NDM0MjQ0NX0.JebF8nAA5qZ5mCUPOzCO9dkUdR4EqPqplVrX3_ebxJg","username":"bigid","firstName":"BigIDAdmin","permissions":["api"]}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"required":["error"],"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"}}}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/tpa/executions/{executionId}":{"put":{"tags":["Action Progress"],"summary":"Update action progress","description":"Update BigID on the progress of an action being executed.\n \nREQUEST: Execution ID, execution status, percent completed, progress message.\n\n RESPONSE: Success/fail.","parameters":[{"$ref":"#/components/parameters/executionId"},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"content":{"application/form":{"schema":{"type":"object","properties":{"statusEnum":{"description":"Completion status of action in progress.","type":"string","enum":["COMPLETED","IN_PROGRESS","ERROR"]},"progress":{"description":"A number between 0 and 1 representing the percent completion of executing the action.","type":"number","format":"double","example":0.55,"minimum":0,"maximum":1},"message":{"type":"string","example":"Action is 55% complete -or- Processed 55 items out of 100.","description":"A text message describing the progress update."}},"example":{"statusEnum":"IN_PROGRESS","progress":0.55,"message":"Action is 55% complete -or- Processed 55 items out of 100."}}}}},"responses":{"200":{"description":"Synchronous response - update was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/executeResponse"}}}},"500":{"description":"Synchronous response - update failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse2"}}}},"default":{"description":"Unexpected error"}}}},"/tpa/executions/{executionId}/attachment":{"post":{"tags":["Action I/O"],"summary":"Upload file","description":"Upload/overwrite file(s) to save in BigID. Maximum number of files = 3 (fourth file will overwrite the first, fifth file will overwrite the second, etc).\n\nREQUEST: File(s) to upload, execution ID.\n\nRESPONSE: Attachment ID.","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"File(s) to upload, not bigger than 16MB in total"}}}}}},"parameters":[{"$ref":"#/components/parameters/executionId"},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"File(s) uploaded successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/putAttachmentResponse"}}}},"default":{"description":"Unexpected error"}}}},"/tpa/{tpaId}/storage":{"put":{"tags":["Action I/O"],"summary":"Store values.","description":"Store values produced by the action as key-value pairs in BigID. \n\nREQUEST: Array of key-value pairs.\n\nRESPONSE: Success/fail.","parameters":[{"$ref":"#/components/parameters/tpaId"},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"keysValue":{"description":"Key-value pairs to store in BigID.","type":"array","items":{"$ref":"#/components/schemas/keyValue"}}}}}}},"responses":{"200":{"description":"Data saved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/executeResponse"}}}},"default":{"description":"Unexpected error"}}},"get":{"tags":["Action I/O"],"summary":"Get all keys and values","description":"Get a list of all key-value pairs stored in BigID by this application.\n\nREQUEST: Application ID. \n\nRESPONSE: Array of key-value pairs.","parameters":[{"$ref":"#/components/parameters/tpaId"},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Array of all key-value pairs stored in BigID for this application.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/keyValue"},"required":["result"]}}}},"default":{"description":"Unexpected error"}}}},"/tpa/{tpaId}/storage/key/{keyName}":{"get":{"tags":["Action I/O"],"summary":"Get key value","description":"Get the value of a specified key. \n\nREQUEST: Application ID, key name. \n\nRESPONSE: Key value.","parameters":[{"$ref":"#/components/parameters/tpaId"},{"in":"path","name":"keyName","schema":{"type":"string"},"required":true,"description":"Name of the key value to retrieve."},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Value of requested key (or {key: null} if no value is found).","content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/keyValue"}},"required":["result"]}}}},"default":{"description":"Unexpected error"}}}}},"components":{"schemas":{"AuthRequest":{"type":"object","properties":{"username":{"type":"string","example":"some_username"},"password":{"type":"string","example":"some_password"}}},"ScanInvoke":{"type":"object","properties":{"scanType":{"type":"string","example":"dsScan"},"scanProfileName":{"type":"string","example":"scan-profile1"}}},"ScanProfile":{"required":["active","allEnabledDs","allEnabledIdSor","description","isCustomScanProfile","name","scanType"],"type":"object","properties":{"scanType":{"type":"string"},"allEnabledIdSor":{"type":"boolean"},"allEnabledDs":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"isCustomScanProfile":{"type":"boolean"},"active":{"type":"boolean"},"schedule":{"type":"string"},"dataSourceList":{"type":"array","items":{"type":"string"}},"idsorList":{"type":"array","items":{"type":"string"}}}},"ScanResult":{"type":"object","properties":{"name":{"type":"string"},"state":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"noFindingsForCorrelation":{"type":"boolean"},"collectionForCorrelation":{"type":"string"},"identities_scanned":{"type":"integer"}}},"DsConnection":{"type":"object","properties":{"password":{"type":"string"},"name":{"type":"string"},"rdb_is_sample_data":{"type":"boolean"},"rdb_url":{"type":"string"},"rdb_name":{"type":"string","example":"hhhhhh"},"rdb_conn_properties":{"type":"string"},"rdb_comma_sep_table_list":{"type":"string"},"rdb_is_only_user_objects":{"type":"boolean"},"enrichment_is_enabled":{"type":"boolean"},"classification_is_enabled":{"type":"boolean"},"username":{"type":"string"},"type":{"type":"string"},"security_tier":{"type":"string"},"enabled":{"type":"string"},"differntial":{"type":"boolean"},"comment":{"type":"string"}}},"CLRConnection":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"string","example":"ColumnName"}},"columnTypes":{"type":"array","items":{"type":"string","example":"char"}},"custom_query_string":{"type":"string","example":"SELECT * FROM USERS"},"isCustomQueryString":{"type":"boolean"},"location":{"type":"string","example":"United States"},"name":{"type":"string","example":"Users"},"db_table":{"type":"string","example":"Users"},"scanConnectioinTimoutInSeconds":{"type":"number","example":100,"nullable":true},"display_name":{"type":"string","example":"None"},"dsConnection":{"type":"string","example":"Users"},"enabled":{"type":"string","example":"yes"},"identities_force_sample":{"type":"boolean"},"identities_sample_size":{"type":"string","example":1000},"skip_sample_size":{"type":"number","example":100,"nullable":true},"skip_sample_start":{"type":"boolean"},"type":{"type":"string","example":"ds-connection"},"unique_id":{"type":"string","example":"Username"},"unique_id_delimiter":{"type":"string","example":","},"use_random_sampling":{"type":"boolean"}}},"errorMsg":{"required":["error"],"type":"object","properties":{"message":{"type":"string"},"error":{"type":"string"}}},"errorResponse":{"additionalProperties":false,"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}}}},"statusCode":{"type":"number"},"status":{"type":"string"}}},"validationResponse":{"additionalProperties":false,"type":"object","properties":{"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/validationError"}}}},"validationError":{"additionalProperties":false,"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"instance":{"type":"string"},"details":{"type":"string"}}},"systemAttribute":{"required":["attributeOriginalName"],"type":"object","properties":{"attributeId":{"type":"string"},"attributeOriginalName":{"type":"string"},"attributeName":{"type":"string"},"identificationScore":{"type":"number"},"compositeDelimiter":{"type":"string"},"isPartOfComposition":{"type":"boolean"},"description":{"type":"string"},"glossaryId":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"idSource":{"type":"array","items":{"type":"string"}},"attributeType":{"type":"string"},"attributeOriginalType":{"type":"string"},"classifierType":{"type":"string"},"source":{"type":"array","items":{"type":"string"}},"purpose":{"type":"array","items":{"type":"string"}}}},"errorMsg1":{"required":["detail","message","status"],"type":"object","properties":{"message":{"type":"string"},"status":{"type":"number"},"detail":{"type":"string"}}},"CatalogObjects":{"type":"object","properties":{"estimatedCount":{"type":"integer"},"totalRowsCounter":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"type":{"type":"string"},"containerName":{"type":"string"},"objectName":{"type":"string"},"fullyQualifiedNames":{"type":"string"},"fullObjectName":{"type":"string"},"total_pii_count":{"type":"number"},"scanner_type_group":{"type":"string"},"objectType":{"type":"string"},"attribute_original_name":{"type":"array","items":{"type":"string"}},"open_access":{"type":"string"},"Document Classifier":{"type":"string"},"Language":{"type":"string"},"Size (in bytes)":{"type":"string"},"Owner":{"type":"string"},"Modified":{"type":"string"},"Last scanned":{"type":"string"},"Location":{"type":"string"}}}}}},"manualConnectionData":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/manualConnection"}}}},"manualConnection":{"required":["foreign_field","lineage_node","linked_collection","local_field"],"type":"object","properties":{"lineage_node":{"type":"string"},"linked_collection":{"type":"string"},"local_field":{"type":"string"},"foreign_field":{"type":"string"},"type":{"type":"string"},"scanId":{"type":"string"},"data_source":{"type":"string"},"constraint_name":{"type":"string"}}},"lineageNode":{"type":"object","properties":{"_id":{"type":"string"},"lineage_details":{"type":"object","properties":{"_id":{"type":"string"},"connected_collections":{"type":"array","items":{"type":"string"}},"connections":{"type":"array","items":{"$ref":"#/components/schemas/connection"}}}}}},"connection":{"type":"object","properties":{"linked_collection":{"type":"string"},"connection_fields":{"type":"array","items":{"$ref":"#/components/schemas/connection_field"}}}},"connection_field":{"type":"object","properties":{"local_field":{"type":"string"},"foreign_field":{"type":"string"},"manual":{"type":"boolean"}}},"successMsgLineageNode":{"type":"object","properties":{"status":{"type":"string"},"statusCode":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/lineageNode"}}}},"sucssesMsg":{"type":"object","properties":{"status":{"type":"string"},"statusCode":{"type":"integer"}}},"validationMsg":{"type":"object","properties":{"status":{"type":"string"},"statusCode":{"type":"integer"},"message":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/validationError1"}}}},"validationError1":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"instance":{"type":"integer"},"details":{"type":"string"}}},"errorMsg2":{"required":["errors"],"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}}}},"statusCode":{"type":"number"},"status":{"type":"string"}}},"errorResponse1":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}}},"errorRbac403":{"type":"object","properties":{"message":{"type":"object","example":"user role insufficient permissions for profileId / requestId"},"statusCode":{"type":"object","example":"403"},"status":{"type":"object","example":"error"}}},"payloadRequestSchema":{"required":["channel","payload"],"type":"object","properties":{"source":{"type":"string","description":"Same as datasource in BigID. If not specified, will be treated as \"default\" source. Can be used to separate production environment from dev environment, etc.","example":"production","default":"default"},"channel":{"type":"string","description":"Used for logical grouping of the payloads. E.g. a topic name, a workflow, an origin of a message etc.","example":"Incoming Leads"},"payload":{"type":"string","description":"Data to scan.","example":"{\"user\": \"simon\", \"email\": \"[email protected]\"}"}}},"payloadResponse":{"required":["status"],"type":"object","properties":{"status":{"type":"string"}}},"errorMsg3":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}}}},"statusCode":{"type":"number"},"status":{"type":"string"}}},"dataItem":{"type":"object","properties":{"_id":{"type":"string"},"hashId":{"type":"string"},"att_stat":{"type":"array","items":{"type":"object","properties":{"identification_score":{"type":"number"},"overrideSureMatch":{"type":"boolean"},"stdDevPop_ids_per_value":{"type":"number"},"number_values_count":{"type":"number"},"distinct_ids_with_att_field":{"type":"number"},"distinct_ids_with_att_val":{"type":"number"},"avg_values_length":{"type":"number"},"stdDev_values_length":{"type":"number"},"max_att_pii":{"type":"number"},"avg_identities_per_value":{"type":"number"},"distinct_field_value_count":{"type":"number"},"_id":{"type":"string"},"max_att_ids":{"type":"number"},"_class":{"type":"string"}}}},"attribute":{"type":"string"},"attributeDistIdsCount":{"type":"number"},"attributeDistValsCount":{"type":"number"},"attributeFindingsCount":{"type":"number"},"attributeRecordsCount":{"type":"number"},"attributeRecordsCountNumbers":{"type":"number"},"attribute_type":{"type":"string"},"confidence_level":{"type":"number"},"count_full_match":{"type":"number"},"count_full_sure_match":{"type":"number"},"count_pos0":{"type":"number"},"count_pseudo_match":{"type":"number"},"count_sure_match":{"type":"number"},"fieldCount":{"type":"number"},"fieldFindingsCount":{"type":"number"},"fieldMaxIds":{"type":"number"},"fieldMaxPii":{"type":"number"},"fieldName":{"type":"string"},"fieldPiiCount":{"type":"number"},"findings_avg_len":{"type":"number"},"findings_full_match":{"type":"number"},"findings_pos0":{"type":"number"},"fullyQualifiedName":{"type":"string"},"records_avg_len":{"type":"number"},"scanId":{"type":"string"},"source":{"type":"string"},"totalPiiRecordsCount":{"type":"number"},"update_date":{"type":"string"},"avgRisk":{"type":"number"},"object":{"type":"string"},"owner":{"type":"string"},"partial_investigations":{"type":"array","items":{"type":"object","properties":{"idsor_value":{"type":"string"},"ds_value":{"type":"string"}}}}}},"keyValue":{"properties":{"key":{"type":"string","example":"key1","description":"Key field name - must be unique."},"value":{"type":"string","example":"value1","description":"Key field value"}}},"errorResponse2":{"properties":{"error":{"type":"string","example":"Request failed to process","description":"Error message - e.g. \"Request failed\""}},"required":["error"]},"executeResponse":{"properties":{"result":{"type":"string","example":true,"description":"Response from BigID server on invoking action."}},"required":["result"]},"putAttachmentResponse":{"properties":{"attachmentId":{"type":"string","example":"5e53fa029b086c461d395a03","description":"ID of uploaded file."}},"required":["attachmentId"]}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"responses":{"errorMsg403Rbac":{"description":"user role insufficient permissions to access the resource","content":{"schema":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"400BadRequest":{"description":"No channel or no Payload.","content":{"schema":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"403Forbidden":{"description":"Feature is not enabled on server.","content":{"schema":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"500InternalServerError":{"description":"Unknown server error.","content":{"schema":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}}},"parameters":{"tpaId":{"in":"path","name":"tpaId","schema":{"type":"string"},"required":true,"description":"Application ID as sent in the execute command."},"executionId":{"in":"path","name":"executionId","schema":{"type":"string"},"required":true,"description":"Execution ID assigned by the BigID server to this instance of the action call."}}},"x-public":true,"x-product":"bigid","x-explorer-enabled":false};

</script>

</html>

@@ Line 1: / Line 1: @@
+<html>
 <script>
 var spec = {"openapi":"3.0.3","info":{"title":"BigID API Documentation","description":"The BigID API allows you to access all system functions from an external system or a BigID App. This specification contains the BigID APIs that have been publically released, and we have committed to supporting them long-term. If you find something else within BigID that you want, you're free to use that API as well. Just know that only the APIs within this document are guaranteed to not change between versions.","version":"1.0.0","contact":{"name":"BigID","url":"https://docs.bigid.com","email":"[email protected]"}},"servers":[{"url":"{environment}/api/v1","variables":{"environment":{"default":"https://sandbox.apps.mybigid.com","description":"BigID installation hostname"}}}],"security":[{"ApiKeyAuth":[]}],"tags":[{"name":"Collection Streaming","description":"This API returns a stream with a filter and by pagination."},{"name":"Data Categories","description":"Use the Data Categories API to obtain the full list of attribute categories, as defined in the Business Glossary. The API response includes all data categories and their characteristics.","externalDocs":{"url":"https://www.docs.bigid.com/bigid/docs/identity-lineage#section-categories"}}],"paths":{"/scans":{"get":{"tags":["Data Source Scans"],"summary":"get a list of scans","description":"This API provides a list of BigID scans and their completion status","parameters":[{"name":"filter","in":"query","description":"filter scans","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScanResult"}}}}},"401":{"description":"Unauthorized","content":{}}}},"post":{"tags":["Data Source Scans"],"summary":"invoke scan profile name with the relevant profile name","description":"This API allows you to initate a scan using a given scan profile.","requestBody":{"description":"Scan details to invoke","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanInvoke"}}},"required":true},"responses":{"401":{"description":"Unauthorized","content":{}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/scans/{subScanId}/requestStop":{"put":{"tags":["Data Source Scans"],"summary":"stop a specific scan","description":"Given a scan ID, stop that scan from running. Note that this will not happen immediately. Using the /scans endpoint can tell you the status.","parameters":[{"name":"subScanId","in":"path","description":"bbb","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized","content":{}}}}},"/scanProfiles":{"get":{"tags":["Data Source Scans"],"summary":"get all scan profiles","description":"Get a listing of all scan profiles for you to run scans against.","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScanProfile"}}},"Simple Scan Profile":{"example":{"_id":"5a0d86459f6841001178d209","created_at":"2017-11-16T12:36:21.867Z","updated_at":"2017-11-16T12:36:21.867Z","scanType":"dsScan","allEnabledIdSor":false,"allEnabledDs":false,"name":"aws-mysql-data1m","description":"aws-mysql-data1m","isCustomScanProfile":true,"active":false,"dataSourceList":["Data source 1","Data source 2"],"idsorList":["Identites 1"]}},"Scheduled Scan Profile":{"example":{"_id":"5a0db10caf83d60012a3be39","created_at":"2017-11-16T12:36:21.867Z","updated_at":"2017-11-16T12:36:21.867Z","scanType":"dsScan","allEnabledIdSor":false,"allEnabledDs":false,"name":"aws-mysql-data1m","description":"aws-mysql-data1m","isCustomScanProfile":true,"active":false,"schedule":"0 22 * * *","dataSourceList":["Data source 1","Data source 2"],"idsorList":["Identites 1"]}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]},"post":{"tags":["Data Source Scans"],"summary":"create a scan profile","description":"Create a scan profile to run a scan against","requestBody":{"description":"Scan details to invoke","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanProfile"}}},"required":false},"responses":{"401":{"description":"Unauthorized","content":{}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/ds_connections":{"get":{"tags":["Data Sources"],"summary":"get a list of all ds connections","description":"Returns a list of all Data Source Connections within the system. Data sources are the systems that BigID is set up to scan.","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DsConnection"}}},"_id":{"example":"5826d66c0424c72e4cd7e9d5"},"id":{"example":"My Database"},"name":{"example":"MS-SQL"},"rdb_url":{"example":"aws-mssql.xxxxxxxxx.us-west-2.rds.amazonaws.com"},"rdb_name":{"example":"bigid"},"username":{"example":"bigid"},"password":{"example":"xxxxxxxxxxx"},"location":{"example":"Germany"},"type":{"example":"rdb-mssql"},"security_tier":{"example":"1"},"enabled":{"example":"yes"},"differential":{"example":true},"last_scan_at":{"example":1507014884865},"rdb_is_sample_data":{"example":true},"rdb_sample_data_max_size":{"example":"200"}}},"401":{"description":"Unauthorized","content":{}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]},"post":{"tags":["Data Sources"],"summary":"create ds connection","description":"Create a new data source connection for BigID to scan. This will just create the connection. You will need to manually run a scan or wait for one to occur to gain insight about this data source.","requestBody":{"description":"Scan details to invoke","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DsConnection"}}},"required":true},"responses":{"200":{"description":"success","content":{}},"401":{"description":"Unauthorized","content":{}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/ds_connections/{connectionName}":{"put":{"tags":["Data Sources"],"summary":"update Ds Connection","description":"Update the details about a data source. This could mean just updating the IP address to a new system or more.","parameters":[{"name":"connectionName","in":"path","description":"bbb","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"DS conection details to update","content":{"schema":{"schema":{"$ref":"#/components/schemas/DsConnection"}}},"required":true},"responses":{"200":{"description":"OK","content":{}}},"x-codegen-request-body-name":"body"}},"/correlation-set-connections":{"get":{"tags":["Correlation Sets"],"summary":"get a list of all correlation learning sets","description":"Returns a list of all Correleation Learning Sets within the system. Correlation Learning Sets are the tables of known entities that BigID will use as the starting point of correlation","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CLRConnection"}}},"_id":{"example":"5826d66c0424c72e4cd7e9d5"},"id":{"example":"My Database"},"name":{"example":"MS-SQL"},"rdb_url":{"example":"aws-mssql.xxxxxxxxx.us-west-2.rds.amazonaws.com"},"rdb_name":{"example":"bigid"},"username":{"example":"bigid"},"password":{"example":"xxxxxxxxxxx"},"location":{"example":"Germany"},"type":{"example":"rdb-mssql"},"security_tier":{"example":"1"},"enabled":{"example":"yes"},"differential":{"example":true},"last_scan_at":{"example":1507014884865},"rdb_is_sample_data":{"example":true},"rdb_sample_data_max_size":{"example":"200"}}},"401":{"description":"Unauthorized","content":{}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]},"post":{"tags":["Correlation Sets"],"summary":"create ds connection","description":"Create a new data source connection for BigID to scan. This will just create the connection. You will need to manually run a scan or wait for one to occur to gain insight about this data source.","requestBody":{"description":"Scan details to invoke","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DsConnection"}}},"required":true},"responses":{"200":{"description":"success","content":{}},"401":{"description":"Unauthorized","content":{}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/identityLocations":{"get":{"tags":["Metadata"],"summary":"get identity locations","description":"Get the real world locations of the entities within your systems. This requires you've set up a location field in your correleation learning sets.","responses":{"200":{"description":"success","content":{"schema":{"schema":{"type":"object","properties":{"identity_locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"number"},"avg":{"type":"number"},"max":{"type":"number"}}}}}}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/systemLocations":{"get":{"tags":["Metadata"],"summary":"get system locations","description":"Get the physical locations for your data sources as specified in their data source configuration.","responses":{"200":{"description":"success","content":{"schema":{"schema":{"type":"object","properties":{"system_locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"number"},"avg":{"type":"number"},"max":{"type":"number"},"systems":{"type":"array","items":{"type":"string"}}}}}}}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/sourceRisks":{"get":{"tags":["Metadata"],"summary":"get source risks","description":"Get the risk score for your data sources. This risk score is user configurable within the Risk Configuration application.","responses":{"200":{"description":"success","content":{"schema":{"schema":{"type":"object","properties":{"source_risks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"number"},"avg":{"type":"number"},"max":{"type":"number"}}}}}}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/piiInvestigationsCount":{"get":{"tags":["Metadata"],"summary":"get pii investigation count","description":"Get a count of the number of entities with cached data","responses":{"200":{"description":"success","content":{"schema":{"schema":{"type":"object","properties":{"piiInvestigationCount":{"type":"number"}}}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/riskTrends":{"get":{"tags":["Metadata"],"summary":"get risk trends","description":"Get a reporting of the risk score for given search criteria","responses":{"200":{"description":"success","content":{"schema":{"schema":{"type":"object","properties":{"risk_trends":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"risk":{"type":"number"},"count":{"type":"number"},"date":{"type":"string"}}}}}}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/scanner-status/":{"get":{"tags":["Scanner Status"],"summary":"Get scanner status","description":"Get statuses of all the scanners in the system.\nREQUEST: No parameters. Status filter optional.\nRESPONSE: Full list of the scanners in the system and their status.","parameters":[{"name":"status","in":"query","description":"Filter scanner list by status (active, idle).","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of all the scanners in the system, filtered by status (if applied)","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"scanner_id":{"type":"string"},"scanner_name":{"type":"string"},"scanner_group":{"type":"string"}}}},"example":[{"scanner_id":"be5f0515-c8bc-4b79-9fb1-6de0ddca5dda","scanner_name":"defaultHostName","scanner_group":"default"},{"scanner_id":"ec5f0515-c8ac-4b12-9fc1-6de0ddcaabcd","scanner_name":"MyhHostName","scanner_group":"default"}]}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}}}}},"/scanner-status/{scanner_id}/":{"get":{"tags":["Scanner Status"],"summary":"Get scanner details","description":"Get scanner details.\nREQUEST: scanner ID.\nRESPONSE: Number of running scans, total number of scans.","parameters":[{"name":"scanner_id","in":"path","description":"scanner_id","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Scanner details ","content":{"application/json":{"schema":{"type":"object","properties":{"scanner_id":{"type":"string"},"message":{"type":"string"},"running":{"type":"integer"},"total":{"type":"integer"}}},"example":[{"scanner_id":"be5f0515-c8bc-4b79-9fb1-6de0ddca5dda","message":"","running":3,"total":65}]}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}}}}},"/scanner_jobs/":{"get":{"tags":["Scanner Jobs"],"summary":"Pending scanner jobs counter","description":"Get count and information on pending scanner jobs.\nREQUEST: No parameters.\nRESPONSE: Information on pending scanner jobs, including: Scanner group, total number of tasks, count of each task type.","responses":{"200":{"description":"Pending scanner jobs counter","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"group":{"type":"string"},"total":{"type":"integer"},"types":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"count":{"type":"integer"}}}}}}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/stream-collections/{collection_name}":{"get":{"tags":["Collection Streaming"],"summary":"Get collection stream","description":"Get stream of collection records. User must be assigned to root scope and have the Export Collection permission.","parameters":[{"name":"collection_name","in":"path","description":"Name of collection","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum records return from the API call","schema":{"type":"number"}},{"name":"offset","in":"query","description":"records offset for pagination use","schema":{"type":"number"}},{"name":"filter","in":"query","description":"filter the records by attributes","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Stream collection was successful","content":{"application/json":{"schema":{"additionalProperties":false,"type":"array","items":{"type":"object"}}}}},"400":{"description":"Bad values for limit/Offset","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validationResponse"}}}},"403":{"description":"The user is not under root scope, asccess is forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"},"example":{"statusCode":403,"status":"error","message":"Only admin has access to this collection","errors":[]}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/data-catalog/":{"get":{"tags":["Objects"],"summary":"Get all objects","description":"Get a full list of all data objects and their characteristics. \nREQUEST: Format (json/csv), pagination parameters, filter by object characteristic.\nRESPONSE: Full list of objects in the system, sorted by fullyQualifiedName (= source.schema.table), in json (array) or csv (string) format.  \nThe response limit for the json response is  10,000 rows.","parameters":[{"name":"format","in":"query","description":"Response format `json` or `csv`","required":true,"schema":{"type":"string"}},{"name":"requireTotalCount","in":"query","description":"Include total count of objects (`estimatedCount`) in response?","schema":{"type":"boolean"}},{"name":"offset","in":"query","description":"Number of rows to skip before starting to count rows, for pagination","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Maximum number of data rows to return, for pagination. Maximum value for json = 10,000.","schema":{"type":"integer"}},{"name":"filter","in":"query","description":"Filter the result set by object characteristic","schema":{"type":"string","enum":["source","attribute","metadata.file","metadata.access_rights","contains_pi"]}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of all the objects and their characteristics in the system.  `Json` format is returned as array, `csv` format is returned as string.","content":{"application/json":{"schema":{"type":"object","properties":{"estimatedCount":{"type":"integer"},"totalRowsCounter":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"type":{"type":"string"},"containerName":{"type":"string"},"objectName":{"type":"string"},"fullyQualifiedNames":{"type":"string"},"fullObjectName":{"type":"string"},"total_pii_count":{"type":"number"},"scanner_type_group":{"type":"string"},"objectType":{"type":"string"},"attribute_original_name":{"type":"array","items":{"type":"string"}},"open_access":{"type":"string"},"Document Classifier":{"type":"string"},"Language":{"type":"string"},"Size (in bytes)":{"type":"string"},"Owner":{"type":"string"},"Modified":{"type":"string"},"Last scanned":{"type":"string"},"Location":{"type":"string"},"application_name":{"type":"array","items":{"type":"string"}}}}}}},"example":{"results":[{"fullyQualifiedName":"Oracle IT.INTEGRATION_TEST_1.SOME_TABLE_1","scanner_type_group":"structured","total_pii_count":111,"id":"5de3baf352ac28d369963810","source":"Oracle IT","type":"rdb-oracle","attribute_original_name":["ZFULL_NAME","FULL_NAME","FULLNAME","ZZIPCODE","SSN","full_name","ZSSN","ZIPCODE","ZID","DATE_OF_BIRTH"],"objectType":"rdb","open_access":"","fullObjectName":"INTEGRATION_TEST_1.SOME_TABLE_1","objectName":"SOME_TABLE_1","containerName":"INTEGRATION_TEST_1","attribute":["ZFULL_NAME","FULL_NAME","FULLNAME","ZZIPCODE","SSN","full_name","ZSSN","ZIPCODE","ZID","DATE_OF_BIRTH"],"application_name":["SAP","Marketing"]}],"totalRowsCounter":3,"estimatedCount":3,"Document Classifier":"","Language":"English","Size (in bytes)":"56","Owner":"Admin","Modified":"2015120117:33:21..","Last scanned":"2015120117:33:21..","Location":"USA"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/file-download/export/":{"get":{"tags":["Objects"],"summary":"Get all objects as CSV","description":"Download a full list of data objects and their characteristics, as CSV file.\nREQUEST: Pagination parameters, filter by object characteristics.\nRESPONSE: Full list of objects in the system, in CSV format. ","parameters":[{"name":"offset","in":"query","description":"Number of rows to skip before starting to collect the result set, for pagination","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Maximum numbers of data rows to return, for pagination","schema":{"type":"integer"}},{"name":"filter","in":"query","description":"Filter the result set by object characteristic","schema":{"type":"string","enum":["source","attribute","metadata.file","metadata.access_rights","contains_pi"]}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Download of Catalog Objects list, as CSV file. ","content":{"attachment/octet-stream":{"schema":{"$ref":"#/components/schemas/CatalogObjects"}}}},"400":{"description":"Bad request","content":{"attachment/octet-stream":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"attachment/octet-stream":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/object-details/":{"get":{"tags":["Objects"],"summary":"Get object details","description":"Get a full list of details of a requested object.\nREQUEST: Object name.\nRESPONSE: Full list of object details.","parameters":[{"name":"object_name","in":"query","description":"Name of the item in the data catalog for which to return details","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of object full details","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"source":{"type":"string"},"type":{"type":"string"},"containerName":{"type":"string"},"objectName":{"type":"string"},"fullyQualifiedNames":{"type":"string"},"fullObjectName":{"type":"string"},"total_pii_count":{"type":"number"},"scanner_type_group":{"type":"string"},"objectType":{"type":"string"},"ds_location":{"type":"string"},"attribute":{"type":"array","items":{"type":"string"}},"open_access":{"type":"string"},"created_date":{"type":"string"},"modified_date":{"type":"string"},"ds":{"type":"object","properties":{"location":{"type":"string"},"owners":{"type":"array","items":{"type":"string"}}},"description":"Data source info"},"owner":{"type":"string","description":"file owner"}}}}},"example":{"data":{"_id":"5de3baf352ac28d369963810","fullyQualifiedName":"Oracle IT.INTEGRATION_TEST_1.SOME_TABLE_1","scanId":"5de3a3af52ac28d36927d49c","source":"Oracle IT","isEncrypted":false,"created_date":"2019-12-01T13:06:59.145Z","scanStatus":"Completed","columnOrFieldOccurrencesCounter":[{"fieldName":"COUNTRY","fieldType":"VARCHAR2","isPrimary":false,"fieldCount":5,"findingCount":4,"fieldClassifications":[]},{"fieldName":"ZIPCODE","fieldType":"VARCHAR2","isPrimary":false,"fieldCount":5,"findingCount":5,"fieldClassifications":[]},{"fieldName":"FULL_NAME","fieldType":"VARCHAR2","isPrimary":false,"fieldCount":5,"findingCount":5,"fieldClassifications":[]},{"fieldName":"ID","fieldType":"NUMBER","isPrimary":false,"fieldCount":5,"findingCount":5,"fieldClassifications":[]},{"fieldName":"DATE_OF_BIRTH","fieldType":"VARCHAR2","isPrimary":false,"fieldCount":5,"findingCount":5,"fieldClassifications":[]},{"fieldName":"SSN","fieldType":"VARCHAR2","isPrimary":false,"fieldCount":5,"findingCount":5,"fieldClassifications":[]}],"scanPartId":"0","totalFindings":35,"dataSourceName":"Oracle IT","containerName":"INTEGRATION_TEST_1","objectName":"SOME_TABLE_1","scannerType":"rdb-oracle","collectionOrTableName":"SOME_TABLE_1","totalRowsWithFindings":5,"totalRows":5,"totalEnrichmentFindings":0,"correlation_status":"Completed","scanner_type_group":"structured","update_date":"2019-12-01T14:45:18.657Z","type":"rdb","total_findings_inserted":35,"total_pii_count":111,"attribute":["ZFULL_NAME","FULL_NAME","FULLNAME","ZZIPCODE","SSN","full_name","ZSSN","ZIPCODE","ZID","DATE_OF_BIRTH"],"id_source":["AthenaIDs","MySQL IDs Qualitest","EDS","MySQL IDSoR","SAP Test IDs","Postgres IDs","MySQLID","EDS2","Test Big_Table","Amazon Postgres"],"country":[],"num_identities":13,"max_pii_count":43,"ds":[{"_id":"5ddfcd2435c54b756cba962b","owners":[],"differential":false,"password":"bqukiqx3BOEIBSau0VmW6aUjRUFcDvzutBhicH6GNPQ=","name":"Oracle IT","credential_id":"","rdb_is_sample_data":true,"rdb_url":"bigid-aws-oracle.cj48rpb9opef.us-west-2.rds.amazonaws.com:1521/ORCL","username":"integration_test_1","updatedPasswords":[],"type":"rdb-oracle","security_tier":"1","scanner_strategy":"SCAN_ALL","enabled":"yes","is_idsor_supported":true,"custom_fields":[{"field_name":"shouldPrintSensitiveData","field_type":"clear","field_value":"true"}],"last_scan_at":1575199663399,"scan_is_success":true,"scan_timestamp":"2019-07-03T13:40:53.295Z","scan_num_of_objects":1,"test_is_success":true,"test_timestamp":"2019-07-03T13:37:48.855Z","connectionStatusTest":{"is_success":true,"last_connection":"2019-11-21T11:51:21.022Z","num_of_object":0},"connectionStatusScan":{"is_success":true,"last_connection":"2019-11-26T15:43:02.715Z","num_of_object":1}}],"open_access":"","fullObjectName":"INTEGRATION_TEST_1.SOME_TABLE_1"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/object-details/attributes/":{"get":{"tags":["Attributes"],"summary":"Get attribute details for object","description":"Get a full list of attribute details for a requested object.\nREQUEST: Object name.\nRESPONSE: Full list of the object's attribute details.","parameters":[{"name":"object_name","in":"query","description":"Name of the item in the data catalog for which to return attribute details","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of all object attribute details","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"attribute_name":{"type":"string"},"attribute_type":{"type":"string"},"attribute_original_name":{"type":"string"},"description":{"type":"string"},"categories":{"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string"}}}},"attribute_id":{"type":"string"},"investigation_scan_id_list":{"type":"array","items":{"type":"string"}},"is_support_investigation":{"type":"boolean"},"business_flow":{"type":"array","items":{"type":"string"}},"column_list":{"type":"array","items":{"type":"object","properties":{"column_name":{"type":"string"},"calc_confidence_level":{"type":"number","format":"double"},"rank":{"type":"string"}}}}}}}}},"example":{"data":[{"source":"Oracle IT","attribute_original_name":"DATE_OF_BIRTH","description":"day of born","categories":"Identify data","column_list":[{"column_name":"DATE_OF_BIRTH","rank":"Medium","calc_confidence_level":0.57}],"attribute_name":"B-Day","attribute_type":"IDSoR Attribute","business_flow":["send gift card"],"attribute_id":"dbf3160e2daaba72caac4c73724ad2cd","is_support_investigation":true,"investigation_scan_id_list":["1441894879"]}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/object-details/columns/":{"get":{"tags":["Columns"],"summary":"Get structured object column details","description":"Get a full list of columns and the attributes they contain, of a structured object.\nREQUEST: Object name, number of items to skip, item limitation.\nRESPONSE: Full list of object columns, their details and attributes they contain.","parameters":[{"name":"object_name","in":"query","description":"Name of the item in the data catalog for which to return column details","required":true,"schema":{"type":"string"}},{"name":"skip","in":"query","description":"The number of items to skip before starting to collect the result set","schema":{"type":"integer","default":0}},{"name":"limit","in":"query","description":"The numbers of items to return (-1 = return all)","schema":{"type":"integer","default":-1}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of all the column details of the object","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"column_name":{"type":"string"},"fieldType":{"type":"string"},"isPrimary":{"type":"boolean"},"linkedColumns":{"type":"number"},"attribute_list":{"type":"array","items":{"type":"object","properties":{"attribute_name":{"type":"string"},"attribute_id":{"type":"string"},"attribute_type":{"type":"string"},"calc_confidence_level":{"type":"number","format":"double"},"rank":{"type":"string"}}}}}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/fetch-clear-value/":{"post":{"tags":["Investigate"],"summary":"Investigate attribute","description":"Launch an investigation into a specified attribute.\nREQUEST: Attribute identification.\nRESPONSE: Investigation IDs.","requestBody":{"description":"Attribute identification. fullyQualifiedName = source.schema.table","content":{"application/json":{"schema":{"required":["attribute_name","attribute_type","fullyQualifiedName"],"type":"object","properties":{"attribute_name":{"type":"string"},"attribute_type":{"type":"string"},"fullyQualifiedName":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"piiInvestigationId":{"type":"string"},"piiInvestigationFullScanId":{"type":"string"}}},"example":{"piiInvestigationId":123456789,"piiInvestigationFullScanId":"987654321!"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/data-catalog/manual-fields/":{"post":{"tags":["Attributes"],"summary":"Update attribute manually","description":"Update attribute catalog characteristics manually.\nREQUEST: Parameters to update.\nRESPONSE: Count of updated parameters.","requestBody":{"description":"Parameters to update for attribute in file or table","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"required":["fullyQualifiedName","type","value"],"type":"object","properties":{"fullyQualifiedName":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"},"fieldName":{"type":"string"},"attribute_type":{"type":"string"},"attribute_original_type":{"type":"string"},"isNewAttribute":{"type":"boolean"},"confLevel":{"type":"string"}}}}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"customTypeCountUpdated":{"type":"integer","description":"amount of manual fields updated"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/data-catalog/manual-fields/attributes-list/":{"get":{"tags":["Attributes"],"summary":"Get all attributes","description":"Get a full list of all the attributes in the system and their characteristics.\nREQUEST: No parameters.\nRESPONSE: Full list of attributes.","responses":{"200":{"description":"Listing of all the attributes in the system, and their characteristics.","content":{"application/json":{"schema":{"type":"object","properties":{"attributesList":{"type":"array","items":{"type":"object","properties":{"attribute_name":{"type":"string"},"attribute_id":{"type":"string"},"attribute_original_name":{"type":"string"},"attribute_type":{"type":"string"}}}},"objectAttributeList":{"type":"array","items":{"type":"object","properties":{"attribute_id":{"type":"string"},"attribute_name":{"type":"string"},"attribute_original_name":{"type":"string"},"attribute_type":{"type":"string"}}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/data-catalog/object-details/columns/column-profile/":{"get":{"tags":["Columns"],"summary":"Get column profile","description":"Get the full profile of a specific column within a structured object.\nREQUEST: Object name, column name.\nRESPONSE: All the aggregate and statistical information about the data in the requested column.","parameters":[{"name":"object_name","in":"query","description":"Name of the item in the data catalog for which to return column profile","required":true,"schema":{"type":"string"}},{"name":"field_name","in":"query","description":"The field (column) for which to return profile","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Full column profile","content":{"application/json":{"schema":{"type":"object","properties":{"inferredDataType":{"type":"string"},"fieldCount":{"type":"integer"},"avgNum":{"type":"string"},"minNum":{"type":"string"},"maxNum":{"type":"string"},"numCnt":{"type":"integer"},"avgLen":{"type":"integer"},"numDev":{"type":"string"},"avgStrLen":{"type":"integer"},"minStrLen":{"type":"integer"},"maxStrLen":{"type":"integer"},"strDev":{"type":"string"},"maxStr":{"type":"string"},"minStr":{"type":"string"},"maxLexStr":{"type":"string"},"minLexStr":{"type":"string"},"emptyPct":{"type":"integer"},"distinctPct":{"type":"integer"}}},"example":{"fieldCount":5,"inferredDataType":"Numeric","avgNum":"47545","minNum":"196","maxNum":"18596","numCnt":5,"avgLen":86867,"numDev":"24306.971","avgStrLen":5,"minStrLen":5,"maxStrLen":5,"strDev":"0","maxStr":"54478","minStr":"54478","maxLexStr":"zzf","minLexStr":"abcaaa","emptyPct":0,"distinctPct":100}}}},"418":{"description":"Data unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/object-details/columns/count":{"get":{"tags":["Columns"],"summary":"Get column count for structured object","description":"Get the number of columns in a structured object.\nREQUEST: Object name.\nRESPONSE: Number of columns in the object.","parameters":[{"name":"object_name","in":"query","description":"Name of the item in the data catalog for which to return column count","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Column count for specified object","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"count":{"type":"number"}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/distinct-values/{field_name}/":{"get":{"tags":["Attributes"],"summary":"Get distinct field values","description":"Get a list of all distinct values of a specified field.\nREQUEST: Field name, free text query filter optional.\nRESPONSE: Full or filtered list of attribute values.","parameters":[{"name":"field_name","in":"path","description":"Name of the field for which to return values","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Free text query filter","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of distinct field values","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}}}}}},"example":{"results":[{"value":"SSN"},{"value":"FIRST_NAME"}]}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/insights/":{"get":{"tags":["Insights"],"summary":"Get Data Catalog highlights","description":"Get the following Data Catalog highlights: Top data sources containing PI, total number of scanned data sources, and total number of scanned data sources containing PI.\nREQUEST: Result limit.\nRESPONSE: Top data sources containing PI, total number of scanned data sources, and total number of scanned data sources containing PI.","parameters":[{"name":"limit","in":"query","description":"Maximum number of top data sources containing PI to return","schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of Data Catalog highlights","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"totalDsScanned":{"type":"number"},"totalDsWithPi":{"type":"number"},"topDsByPiCount":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"totalObjectsWithPii":{"type":"number"}}}}}}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/tables/":{"get":{"tags":["Objects"],"summary":"Get all table information","description":"Get all information on the tables in the system.\nREQUEST: Pagination parameters, filter by object name.\nRESPONSE: Full list of tables in the system, sorted by fullyQualifiedName.","parameters":[{"name":"offset","in":"query","description":"Number of items to skip before starting to collect the result set, for pagination","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Numbers of items to return, for pagination","schema":{"type":"integer"}},{"name":"filter","in":"query","description":"Filter the result set by objectName=starting with, for example: objectName=s for all tables that start with S.","schema":{"type":"string","enum":["objectName"]}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of all the tables in the system","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"fullyQualifiedName":{"type":"string"},"source":{"type":"string"},"containerName":{"type":"string"},"objectName":{"type":"string"}}}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/objects-with-pii/{source}/":{"get":{"tags":["Objects"],"summary":"Get PII objects per data source","description":"Get a list of all objects containing PII in a specified data source.\nREQUEST: Name of data source.\nRESPONSE: String list of objects that contain PII.","parameters":[{"name":"source","in":"path","description":"Name of data source","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"List of objects (fullyQulifiedName) with PII","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/searchable-attribute/{object_name}/":{"get":{"tags":["Objects"],"summary":"Get Cartesian multiplication of attributes per column","description":"Get a searchable Cartesian multiplication of attributes per column.\nREQUEST: Object name.\nRESPONSE: List of attributes per columns, including details for DSAR flow.","parameters":[{"name":"object_name","in":"path","description":"Object name (fullyQulifiedName)","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"List of attributes per columns","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"shortFieldName":{"type":"string"},"attribute":{"type":"string"},"attributePii":{"type":"number"},"corrStatus":{"type":"string"},"isFullMatch":{"type":"boolean"},"countMatches":{"type":"string"},"countPos0":{"type":"number"},"isCompositeKey":{"type":"boolean"},"countSureMatch":{"type":"number"}}}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/system-attributes/":{"get":{"tags":["Attributes"],"summary":"Get all attributes","description":"Get a full list of the attributes in the system.\nREQUEST: No parameters required, free text query filter optional.\nRESPONSE: Full list of the attributes in the system.","parameters":[{"name":"filter","in":"query","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of all the attributes in the system","content":{"application/json":{"schema":{"type":"object","properties":{"systemAttributeList":{"type":"array","items":{"$ref":"#/components/schemas/systemAttribute"}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data-catalog/active-system-attributes/":{"get":{"tags":["Attributes"],"summary":"Get all active attributes","description":"Get a full list of attributes that are linked to at least one object in the system.\nREQUEST: No parameters required. Data sources to filter by (optional), correlation set to filter by (optional, relevant to IDSoR attributes only).\nRESPONSE: Full list of the active attributes in the system, including attribute details.","parameters":[{"name":"dataSourceList","in":"query","description":"List of data sources to filter by","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"correlationSetList","in":"query","description":"List of correlation sets to filter by, relevant to IDSoR attirbutes only","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"withPurpose","in":"query","schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of all the active attributes and their details in the system","content":{"application/json":{"schema":{"type":"object","properties":{"activeAttributeList":{"type":"array","items":{"$ref":"#/components/schemas/systemAttribute"}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg1"}}}}}}},"/data_categories/":{"get":{"tags":["Data Categories"],"summary":"Get All Data Categories","description":"Get a full list of all data categories.","responses":{"200":{"description":"Get all Data Categories","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"color":{"type":"string"},"dc":{"type":"array","items":{"type":"object","properties":{"color":{"type":"string"},"description":{"type":"string"},"display_name":{"type":"string"},"unique_name":{"type":"string"}}}},"description":{"type":"string"},"display_name":{"type":"string"},"glossary_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"example":[{"color":"#FF0000","dc":[{"color":"#FF0000","description":"555","display_name":"category1","unique_name":"NewIntegrationTest2"}],"description":"555","display_name":"category1","glossary_id":"NewIntegrationTest2","name":"category1","type":"Personal Data Category"}]}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]},"post":{"tags":["Data Categories"],"summary":"Create Data Category","description":"The API receives Data Category object, saves it and returns a glossary_id. The Business Glossary defines certain terms and categories used in various contexts throughout the BigID system.","operationId":"createDataCategory","requestBody":{"description":"Data Categories","content":{"application/json":{"schema":{"required":["unique_name"],"type":"object","properties":{"unique_name":{"type":"string"},"description":{"type":"string"},"display_name":{"type":"string"},"color":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"required":["glossary_id"],"type":"object","properties":{"glossary_id":{"type":"string"},"success":{"type":"boolean"}}},"example":{"success":true,"glossary_id":"sensitive"}}}},"400":{"description":"Bad POST body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/lineage/attributes/":{"get":{"tags":["Lineage Attribute"],"summary":"Get Lineage Attribute","description":"Get Lineage Attribute. show classifications, enrichment_attributes and ds attributes (idsor_attributes)","responses":{"200":{"description":"Get all Lineage Attribute","content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"classifications":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"attribute_type":{"type":"string"},"collections":{"type":"array","items":{"type":"string"}},"friendly_name":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"glossary_id":{"type":"string"}}}},"enrichment_attributes":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"attribute_type":{"type":"string"},"collections":{"type":"array","items":{"type":"string"}},"friendly_name":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"glossary_id":{"type":"string"}}}},"idsor_attributes":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"attribute_type":{"type":"string"},"collections":{"type":"array","items":{"type":"string"}},"friendly_name":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"glossary_id":{"type":"string"},"identifiability":{"type":"number"},"overrideSureMatch":{"type":"boolean"}}}}}}},"identifiability_threshold":{"type":"number"}}},"example":{"attributes":[{"classifications":[{"_id":"Email","attribute_type":"Classification","collections":["Oracle Lineage DS.LINEAGE_TESTS.TEST_USERS"],"friendly_name":"Email"}],"enrichment_attributes":[{"_id":"enrich_field.ACTIVITY_ID","attribute_type":"Enrichment Attribute","collections":["Oracle Lineage DS.LINEAGE_TESTS.TEST_ACTIVITIES"],"friendly_name":"enrich_field.ACTIVITY_ID"}],"idsor_attributes":[{"_id":"USER_ID","attribute_type":"IDSoR Attribute","collections":["Oracle Lineage DS.LINEAGE_TESTS.TEST_ACTIVITIES","Oracle Lineage DS.LINEAGE_TESTS.TEST_USERS"],"friendly_name":"USER_ID","identifiability":1.5,"overrideSureMatch":false}]}],"identifiability_threshold":0.5}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/lineage/manual/connection":{"get":{"tags":["Manual Referential Integrity"],"summary":"Get connections","description":"Get referential integrity and manual connections for specified nodes.\nREQUEST: Manual or referential integrity nodes.\nRESPONSE: List of referential integrity and manual connections, sorted by table name.","parameters":[{"name":"nodes","in":"query","description":"One or more nodes, separated by a comma. For example: collection_1, collection_2, collection_3.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Listing of referential integrity and manual connections","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/successMsgLineageNode"}},"example":{"status":"success","statusCode":200,"data":[{"_id":"collection_2","lineage_details":{"_id":"collection_2","connected_collections":["collection_3","collection_1"],"connections":[{"linked_collection":"collection_3","connection_fields":[{"local_field":"collection_2_3","foreign_field":"collection_3_1","manual":true}]},{"linked_collection":"collection_1","connection_fields":[{"local_field":"collection_2_2","foreign_field":"collection_1_2","manual":true},{"local_field":"collection_2_1","foreign_field":"collection_1_1","manual":true}]}]}},{"_id":"collection_1","lineage_details":{"_id":"collection_1","connected_collections":["collection_3","collection_2"],"connections":[{"linked_collection":"collection_3","connection_fields":[{"local_field":"collection_1_3","foreign_field":"collection_3_3","manual":true},{"local_field":"collection_1_3","foreign_field":"collection_3_1","manual":true}]},{"linked_collection":"collection_2","connection_fields":[{"local_field":"collection_1_2","foreign_field":"collection_2_2","manual":true},{"local_field":"collection_1_1","foreign_field":"collection_2_1","manual":true}]}]}}]}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}}}},"post":{"tags":["Manual Referential Integrity"],"summary":"Insert connection","description":"Manually insert a referential integrity or manual connection. All nodes must be validated for the operation to be successful.\nREQUEST: Node characteristics.\nRESPONSE: Success/ fail.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/manualConnectionData"}}},"required":true},"responses":{"200":{"description":"OK, all nodes validated","content":{"application/json":{"schema":{"type":"object"},"example":{"status":"success","statusCode":200,"data":[]}}}},"400":{"description":"Bad request, no valid nodes","content":{"application/json":{"schema":{"type":"object"},"example":{"status":"error","statusCode":400,"message":"The provided request has invalid payload","errors":[{"type":"PAYLOAD_VALIDATION","title":"Payload Validation Error","details":"Expected a value of type '{data}' for 'undefined' but received '[object Object],[object Object]'."}]}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/sar/search/entity-sources":{"get":{"tags":["Search for Individual"],"summary":"Search for individual by name or ID (synchronous).","description":"Search entity sources defined in profile for individual, using userName or userID (synchronous) \n \n REQUEST:  Specify username or userID. \n RESPONSE: Returns a list of individuals found in entity sources matching the search criteria, with whatever personal information attributes were found for each individual (response fields depend on entity sources).  Use these attributes to run DSAR scan of selected individual (/sar/reports). \nMultiple values returned for a single attribute are separated by `|`.","parameters":[{"name":"profileId","in":"query","description":"Profile ID defining connected entity sources.  Use /sar/profiles to see full list of available profiles. If not specified, default profile will be applied.","schema":{"type":"string"}},{"name":"userName","in":"query","description":"Name of the individual you are searching for","schema":{"type":"string"}},{"name":"userId","in":"query","description":"Unique ID of the individual you are searching for","schema":{"type":"string"}},{"name":"allAttributes","in":"query","description":"get allAttributes","schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"usersMap":{"type":"object","properties":{"uniqueId":{"type":"object","properties":{"userId":{"type":"string"},"attributes":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"residency":{"type":"string"},"risk":{"type":"string"},"isOptOut":{"type":"string"},"optOutDate":{"type":"string"},"idSourceName":{"type":"string"},"attributesMap":{"type":"object","properties":{"field1":{"type":"number"},"field2":{"type":"string"},"field3":{"type":"boolean"}}},"unique_id":{"type":"string"}}}}}}},"errMessages":{"type":"object","properties":{}}}},"example":{"usersMap":{"uniqueId":{"userId":123456789,"attributes":{"id":2468,"name":"DATE_OF_BIRTH","residency":"Spain","risk":61,"isOptOut":true,"optOutDate":"25/5/2018","idSourceName":"HR-sybase","attributesMap":{"field2":"25/5/1966"},"unique_id":"123-34-4567"}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/search/entity-sources/async":{"post":{"tags":["Search for Individual"],"summary":"Search for individual by name or ID (asynchronous).","description":"REQUEST:  Search entity sources defined in profile for individual, using userName or userID (asynchronous - must include callback and SSL parameters) \n RESPONSE: Returns a list of individuals found in entity sources matching the search criteria, with whatever personal information attributes were found for each individual (response example shown below).  Use these attributes to run DSAR scan of selected individual (/sar/reports).\nMultiple values returned for a single attribute are separated by `|`","parameters":[{"name":"callbackUrl","in":"query","description":"POST request URL called on completion of search scan","schema":{"type":"string"}},{"name":"ssl_trust_store_path","in":"query","description":"Path of certificate to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_store_password","in":"query","description":"Password (if exists) to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_self_signed","in":"query","description":"Should callback trust self-signed certificates? (TRUE/FALSE)","schema":{"type":"string"}},{"name":"headers","in":"query","description":"If needed, specify headers for POST request here.  Syntax `\"ThisHeader\"=\"HeaderValue\"`","schema":{"type":"string"}},{"name":"profileId","in":"query","description":"Profile ID defining connected entity sources.  Use /sar/profiles to see full list of available profiles.  If not specified, default profile will be applied.","required":true,"schema":{"type":"string"}},{"name":"userName","in":"query","description":"Name of the individual you are searching for","schema":{"type":"string"}},{"name":"userId","in":"query","description":"Unique ID of the individual you are searching for","schema":{"type":"string"}},{"name":"allAttributes","in":"query","description":"get allAttributes","schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"Callback properties","content":{"schema":{"schema":{"type":"object","properties":{"callbackUrl":{"type":"string","example":"http://www.example.com"},"callbackUrlProperties":{"type":"object","properties":{"ssl_trust_store_path":{"type":"string","example":".../folder1/folder2"},"ssl_trust_store_password":{"type":"string","example":"mypassword123"},"ssl_trust_self_signed":{"type":"boolean","example":true},"headers":{"type":"object","properties":{"authorization":{"type":"string","example":"ffff"}}}}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"usersMap":{"type":"object","properties":{"uniqueId":{"type":"object","properties":{"userId":{"type":"string"},"attributes":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"residency":{"type":"string"},"risk":{"type":"string"},"isOptOut":{"type":"string"},"optOutDate":{"type":"string"},"idSourceName":{"type":"string"},"attributesMap":{"type":"object","properties":{"field1":{"type":"number"},"field2":{"type":"string"},"field3":{"type":"boolean"}}},"unique_id":{"type":"string"}}}}}}}}},"errMessages":{"type":"object","properties":{}}}},"example":{"results":{"usersMap":{"uniqueId":{"userId":123456789,"attributes":{"id":2468,"name":"DATE_OF_BIRTH","residency":"Spain","risk":61,"isOptOut":true,"optOutDate":"25/5/2018","idSourceName":"HR-sybase","attributesMap":{"field2":"25/5/1966"},"unique_id":"123-34-4567"}}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"x-codegen-request-body-name":"body"}},"/sar/search/entity-sources/{id_connection}":{"get":{"tags":["Search for Individual"],"summary":"Search for individual by specified attribute(s) (synchronous).","description":"REQUEST:  Search specified entity sources for individual, using specified attributes (synchronous). \n RESPONSE: Returns a list of individuals found in entity sources matching the search criteria, with whatever personal information attributes were found for each individual (response example shown below).  Use these attributes to run DSAR scan of selected individual (/sar/reports).\nMultiple values returned for a single attribute are separated by `|`","parameters":[{"name":"id_connection","in":"path","description":"Entity source name","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Query with attributes by which to search for individual.  Syntax: `filter=<attribute_name>=<attribute_value>` (append additional attributes using AND).  Example: `filter=SSN=123-45-6789 AND COUNTRY=USA`.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"usersMap":{"type":"object","properties":{"uniqueId":{"type":"object","properties":{"userId":{"type":"string"},"attributes":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"residency":{"type":"string"},"risk":{"type":"string"},"isOptOut":{"type":"string"},"optOutDate":{"type":"string"},"idSourceName":{"type":"string"},"attributesMap":{"type":"object","properties":{"field1":{"type":"number"},"field2":{"type":"string"},"field3":{"type":"boolean"}}},"unique_id":{"type":"string"}}}}}}},"errMessages":{"type":"object","properties":{}}}},"example":{"usersMap":{"uniqueId":{"userId":123456789,"attributes":{"id":2468,"name":"DATE_OF_BIRTH","residency":"Spain","risk":61,"isOptOut":true,"optOutDate":"25/5/2018","idSourceName":"HR-sybase","attributesMap":{"field2":"25/5/1966"},"unique_id":"123-34-4567"}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/search/entity-sources/async/{id_connection}":{"post":{"tags":["Search for Individual"],"summary":"Search for individual by specified attribute(s) (asynchronous).","description":"REQUEST:  Search specified entity sources for individual, using specified attributes (asynchronous - must include callback and SSL parameters). \n RESPONSE: Returns a list of individuals found in entity sources matching the search criteria, with whatever personal information attributes were found for each individual (response example shown below).  Use these attributes to run DSAR scan of selected individual (/sar/reports).\nMultiple values returned for a single attribute are separated by `|`","parameters":[{"name":"id_connection","in":"path","description":"Entity source name","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"Query with attributes by which to search for individual.  Syntax: `filter=<attribute_name>=<attribute_value>` (append additional attributes using AND).  Example: `filter=SSN=123-45-6789 AND COUNTRY=USA`.","required":true,"schema":{"type":"string"}},{"name":"callbackUrl","in":"query","description":"POST request URL called on completion of search scan","schema":{"type":"string"}},{"name":"ssl_trust_store_path","in":"query","description":"Path of certificate to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_store_password","in":"query","description":"Password (if exists) to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_self_signed","in":"query","description":"Should callback trust self-signed certificates? (TRUE/FALSE)","schema":{"type":"string"}},{"name":"headers","in":"query","description":"If needed, specify headers for POST request here.  Syntax `\"ThisHeader\"=\"HeaderValue\"`","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"Callback properties","content":{"schema":{"schema":{"type":"object","properties":{"callbackUrl":{"type":"string","example":"http://www.example.com"},"callbackUrlProperties":{"type":"object","properties":{"ssl_trust_store_path":{"type":"string","example":".../folder1/folder2"},"ssl_trust_store_password":{"type":"string","example":"mypassword123"},"ssl_trust_self_signed":{"type":"boolean","example":true},"headers":{"type":"object","properties":{"authorization":{"type":"string","example":"ffff"}}}}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"usersMap":{"type":"object","properties":{"uniqueId":{"type":"object","properties":{"userId":{"type":"string"},"attributes":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"residency":{"type":"string"},"risk":{"type":"string"},"isOptOut":{"type":"string"},"optOutDate":{"type":"string"},"idSourceName":{"type":"string"},"attributesMap":{"type":"object","properties":{"field1":{"type":"number"},"field2":{"type":"string"},"field3":{"type":"boolean"}}},"unique_id":{"type":"string"}}}}}}}}},"errMessages":{"type":"object","properties":{}}}},"example":{"results":{"usersMap":{"uniqueId":{"userId":123456789,"attributes":{"id":2468,"name":"DATE_OF_BIRTH","residency":"Spain","risk":61,"isOptOut":true,"optOutDate":"25/5/2018","idSourceName":"HR-sybase","attributesMap":{"field2":"25/5/1966"},"unique_id":"123-34-4567"}}}}}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"x-codegen-request-body-name":"body"}},"/sar/attributes":{"get":{"tags":["Search for Individual"],"summary":"Get a list of attributes","description":"REQUEST:  Specify Profile ID.  \n RESPONSE: Get a list of identifying attributes available in specified profile. Returned attributes are categorized as searchable (can be used to search for an individual) or non-searchable (cannot be used to search for an individual).","parameters":[{"name":"profileId","in":"query","description":"Profile ID.  Use /sar/profiles to see a listing of all existing profiles.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"idsor_attributes":{"type":"array","items":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"glossary_id":{"type":"number"},"friendly_name":{"type":"string"},"identifiability":{"type":"number"},"overrideSureMatch":{"type":"boolean"},"searchable":{"type":"boolean"},"searchable_classification":{"type":"boolean"},"_id":{"type":"string"}}}}}}},"classifications":{"type":"array","items":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"glossary_id":{"type":"number"},"friendly_name":{"type":"string"},"searchable":{"type":"boolean"},"searchable_classification":{"type":"boolean"},"_id":{"type":"string"}}}},"identifiability_threshold":{"type":"number"}}},"example":{"attributes":[{"idsor_attributes":[{"categories":["Mailing|Financial"],"description":"Date of Birth","glossary_id":2468,"friendly_name":"Birth Date","identifiability":50,"overrideSureMatch":false,"searchable":true,"searchable_classification":true,"_id":888888}],"classifications":[{"categories":["Mailing|Financial"],"description":"Date of Birth","glossary_id":2468,"friendly_name":"Birth Date","searchable":true,"searchable_classification":true,"_id":888888}]}],"identifiability_threshold":30}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/reports":{"post":{"tags":["Run DSAR"],"summary":"Run DSAR scan","description":"REQUEST:  Run DSAR scan for individual specified by userId, name, and whatever additional identifying attributes can be used for correlating data found in entity sources and data sources.\n RESPONSE: Scan ID of DSAR parent scan.","parameters":[{"name":"profileId","in":"query","description":"Profile ID, defining which entity sources and data sources to scan","schema":{"type":"string"}},{"name":"callbackUrl","in":"query","description":"POST request URL called on completion of search scan","schema":{"type":"string"}},{"name":"ssl_trust_store_path","in":"query","description":"Path of certificate to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_store_password","in":"query","description":"Password (if exists) to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_self_signed","in":"query","description":"Should callback trust self-signed certificates? (TRUE/FALSE)","schema":{"type":"string"}},{"name":"headers","in":"query","description":"If needed, specify headers for POST request here.  Syntax `\"ThisHeader\"=\"HeaderValue\"`","schema":{"type":"string"}},{"name":"userId","in":"query","description":"Unique ID of the individual to run the DSAR scan on","required":true,"schema":{"type":"string"}},{"name":"displayName","in":"query","description":"Name of the individual to run the DSAR scan on","required":true,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"Optional.  If not specified, scan will automatically extract all relevant attributes from allowed entity sources.  If specified, scan will use these attributes to correlate additional fields. Syntax `<attribute_name>:<attribute_value>`.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"A JSON payload containing the Unique ID, Display Name and whatever other identifying attributes of the requested individual are known.","content":{"schema":{"schema":{"required":["userDetails"],"type":"object","properties":{"profileId":{"type":"string","example":"123456"},"callbackUrl":{"type":"string","example":"http://www.example.com"},"callbackUrlProperties":{"type":"object","properties":{"ssl_trust_store_path":{"type":"string","example":".../folder1/folder2"},"ssl_trust_store_password":{"type":"string","example":"mypassword123"},"ssl_trust_self_signed":{"type":"boolean","example":true},"headers":{"type":"object","properties":{"authorization":{"type":"string","example":"ffff"}}}}},"userDetails":{"required":["displayName","userId"],"type":"object","properties":{"userId":{"type":"string","example":"123456789"},"displayName":{"type":"string","example":"Thomas Banks"},"attributes":{"type":"object","properties":{"attribute1":{"type":"number"},"attribute2":{"type":"string","example":"[email protected]"}}}}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"report_id":{"type":"string"},"requestId":{"type":"string"},"userId":{"type":"string"}}},"example":{"report_id":321321321,"requestId":321321321,"userId":"11-111-11"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"x-codegen-request-body-name":"body"}},"/sar/reports/{requestId}/retry-failed-objects":{"post":{"tags":["Run DSAR"],"summary":"Retry DSAR scan","description":"Run DSAR scan of failed subscans or failed objects within subscans.  \nREQUEST:  Scan IDs of parent scan and subscans to retry. \n RESPONSE: Scan IDs of subscans with failures that are now being rescanned.","parameters":[{"name":"requestId","in":"path","description":"Scan ID of DSAR parent scan","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"A JSON payload containing the Scan IDs of subscans to retry","content":{"schema":{"schema":{"required":["subScanIds"],"type":"object","properties":{"subScanIds":{"type":"array","example":["123456","456789"],"items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"subScanIds":{"type":"array","items":{"type":"string"}}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":[{"subScanIds":["123456","456789"]}],"status":"success","statusCode":200,"massage":"successful operation"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}},"x-codegen-request-body-name":"body"}},"/sar/reports/{requestId}":{"get":{"tags":["Reports"],"summary":"Get DSAR report as JSON/CSV","description":"Get full report of personal information attributes and values for requested individual, in JSON or CSV format.  \n REQUEST: Scan ID of DSAR parent scan, report format, parameters for pagination of results.\n RESPONSE: Returns all found personal information records - attributes and values - in JSON or CSV format.","parameters":[{"name":"requestId","in":"path","description":"Scan ID of DSAR parent scan","required":true,"schema":{"type":"number"}},{"name":"format","in":"query","description":"JSON or CSV.  Default = JSON.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of data rows to return","schema":{"type":"number"}},{"name":"offset","in":"query","description":"Number of rows to skip before starting to count rows","schema":{"type":"number"}},{"name":"excludeObjects","in":"query","description":"Exclude objects from report? Default = include objects","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"identity_unique_id":{"type":"string","example":"829-00-2162"},"row_type":{"type":"string","example":"rdb - record"},"detected_at":{"type":"string","example":"2019-04-30T13:17:54.075Z"},"value":{"type":"string","example":"25/5/1966"},"attribute":{"type":"string","example":"DATE_OF_BIRTH"},"attr_original_name":{"type":"string","example":"DATE_OF_BIRTH"},"scan_id":{"type":"string"},"source":{"type":"string","example":"Sybase"},"fullObjectName":{"type":"string","example":"probe.basic_test"},"shortFieldName":{"type":"string"},"proximityId":{"type":"string"}}}},"objects":{"type":"array","items":{"type":"object","properties":{"identity_unique_id":{"type":"string","example":"829-00-2162"},"row_type":{"type":"string","example":"rdb - object"},"detected_at":{"type":"string","example":"2019-04-30T13:17:54.075Z"},"value":{"type":"string","example":"25/5/1966"},"attribute":{"type":"string","example":"DATE_OF_BIRTH"},"attr_original_name":{"type":"string","example":"DATE_OF_BIRTH"},"scan_id":{"type":"string"},"source":{"type":"string","example":"Sybase"},"fullObjectName":{"type":"string","example":"probe.basic_test"},"shortFieldName":{"type":"string"},"proximityId":{"type":"string"}}}},"offset":{"type":"string","description":"pointer to the next block"},"limit":{"type":"string","description":"max records to show in the result"}}},"example":{"records":[{"identity_unique_id":"829-00-2162","row_type":"rdb-record","detected_at":"2019-04-30T13:17:54.075Z","value":"25/5/1966","attribute":"Date of Birth","attr_original_name":"DATE_OF_BIRTH","scan_id":321321321,"source":"HRsybase","fullObjectName":"probe.basic_test","shortFieldName":"BirthDate","proximityId":7777777}],"objects":[{"identity_unique_id":"829-00-2162","row_type":"rdb-record","detected_at":"2019-04-30T13:17:54.075Z","value":"25/5/1966","attribute":"Date of Birth","attr_original_name":"DATE_OF_BIRTH","scan_id":321321321,"source":"HRsybase","fullObjectName":"probe.basic_test","shortFieldName":"BirthDate","proximityId":7777777}],"offset":50,"limit":200}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}},"delete":{"tags":["Reports"],"summary":"Delete DSAR report","description":"Delete all records in DSAR report. \n REQUEST: Scan ID of DSAR parent scan.\n RESPONSE: Confirmation details","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"isDeletedPersonalInfo":{"type":"boolean"},"isDeletedSarConfiguration":{"type":"boolean"},"isDeletedSarFailedObjects":{"type":"boolean"},"numberJITRecordsRemoved":{"type":"number"},"numberScansExpired":{"type":"number"}}},"example":{"isDeletedPersonalInfo":true,"isDeletedSarConfiguration":true,"isDeletedSarFailedObjects":true,"numberJITRecordsRemoved":0,"numberScansExpired":0}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/reports/{requestId}/short-report":{"get":{"tags":["Reports"],"summary":"Get short/personal report","description":"Get Data Subject Short Report in JSON or CSV format or Personal Info PDF Report for requested individual.  See <a href=\"https://www.docs.bigid.com/docs/subject-access-request#section-reports\" target=\"_blank\">Access Request Reports</a> for more information.\n  REQUEST: Scan ID of DSAR parent scan.\n  RESPONSE: Data Subject Short Report in JSON/CSV format or Personal Info Report in PDF format.\n","parameters":[{"name":"requestId","in":"path","description":"Scan ID of DSAR parent scan","required":true,"schema":{"type":"string"}},{"name":"format","in":"query","description":"Specify requested report:\n  * `json` - Data Subject Short Report in JSON format\n  * `csv` - Data Subject Short Report in CSV format\n  * `pdf` - Personal Info Report in PDF format\n","schema":{"type":"string","default":"json","enum":["json","csv","pdf"]}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","example":"25/5/1966"},"attribute":{"type":"string","example":"DATE_OF_BIRTH"},"att_friendly_name":{"type":"string","example":"Birth Date"},"mask_it":{"type":"boolean","example":false},"purpose_of_use":{"type":"string","example":"Age verification"},"sar_category":{"type":"string","example":""}}}},"example":[{"value":"25/5/1966","attribute":"Date of Birth","att_friendly_name":"Birth Date","mask_it":false,"purpose_of_use":"Age verification","sar_category":""}]},"text/csv":{"schema":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","example":"25/5/1966"},"attribute":{"type":"string","example":"DATE_OF_BIRTH"},"att_friendly_name":{"type":"string","example":"Birth Date"},"mask_it":{"type":"boolean","example":false},"purpose_of_use":{"type":"string","example":"Age verification"},"sar_category":{"type":"string","example":""}}}},"example":"\"Attribute\",\"Value\",\"Purpose Of Use\",\"Category\"\n\"FULLNAME\",\"Thomas U. Banks\",\"\",\"\"\n\"DATE_OF_BIRTH\",\"25/5/1966\",\"\",\"\"\n\"ZIPCODE\",\"25253\",\"\",\"\"\n"},"application/pdf":{"schema":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","example":"25/5/1966"},"attribute":{"type":"string","example":"DATE_OF_BIRTH"},"att_friendly_name":{"type":"string","example":"Birth Date"},"mask_it":{"type":"boolean","example":false},"purpose_of_use":{"type":"string","example":"Age verification"},"sar_category":{"type":"string","example":""}}}},"example":"Personal Info Report PDF\n"}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}},"text/csv":{"schema":{"$ref":"#/components/schemas/errorRbac403"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}},"text/csv":{"schema":{"$ref":"#/components/schemas/errorResponse1"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/reports/{requestId}/summary-report":{"get":{"tags":["Reports"],"summary":"Get Personal Info Report as PDF","description":"Get Personal Info PDF Report for requested individual.  See <a href=\"https://www.docs.bigid.com/docs/subject-access-request#section-reports\" target=\"_blank\">Access Request Reports</a> for more information.\n  REQUEST: Scan ID of DSAR parent scan.\n  RESPONSE: Personal Info Report in PDF format.\n","parameters":[{"name":"requestId","in":"path","description":"Scan ID of DSAR parent scan","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed","content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}}}},"/sar/reports/{requestId}/request-for-remove":{"post":{"tags":["Delete Individual"],"summary":"Request to delete individual's data","description":"Create tasks for data administrator and data source owners to delete personal information records for the specified individual. \n REQUEST: Specify parent scan ID of DSAR run on individual to delete, and ID of user requesting deletion.\n  RESPONSE: Returns IDs of tasks created for data administrator (single) and data source owners (array).","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"auth_user","in":"header","description":"Requester username or email","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"SUCCESS"},"taskId":{"type":"string"},"taskIds":{"type":"array","items":{"type":"string"}}}},"example":{"status":"SUCCESS","taskID":778899,"tasksIDs":[112233,445566,665544]}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"FAILURE"},"message":{"type":"string"}}}}}}}}},"/sar/deletion-validations":{"get":{"tags":["Delete Individual"],"summary":"Get all delete requests","description":"Get a list of all currently active deletion validation requests.\nREQUEST: No parameters.\n  RESPONSE: Array of currently active deletion validation request details.","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"sarDeletionValidation":{"type":"array","items":{"type":"object","properties":{"created_at":{"type":"string"},"displayName":{"type":"string"},"lastScan":{"type":"string"},"owner":{"type":"string"},"profileId":{"type":"string"},"profileName":{"type":"string"},"requestId":{"type":"string"},"requestIdObj":{"type":"string"},"uniqueId":{"type":"string"},"updated_at":{"type":"string"},"_id":{"type":"string"}}}},"offset":{"type":"number"},"total":{"type":"number"}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":{"sarDeletionValidations":{"created_at":"2020-07-16T14:21:27.721Z","displayName":"Thomas U. Banks","lastScan":"2020-07-16T14:21:27.721Z","owner":"bigid","profileId":"5f0f1592daf5e1a8566b99c2","profileName":"Default Profile","requestId":"5f0f231fdaf5e1a8566bbdbd","requestIdObj":"5f0f231fdaf5e1a8566bbdbd","uniqueId":"829-00-2162","updated_at":"2020-07-16T14:21:27.721Z","_id":"5f106267daf5e1a8566c5b0b"},"offset":2,"total":100},"status":"success","statusCode":200,"massage":"successful operation"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/sar/deletion-validation/{requestId}":{"delete":{"tags":["Delete Individual"],"summary":"Cancel deletion request","description":"Remove request to delete individual's personal data. \n REQUEST: DSAR parent scan ID\n  RESPONSE: success(true)/fail(false)","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"deleted":{"type":"boolean"}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":[{"deleted":true}],"status":"success","statusCode":200,"massage":"successful operation"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}}}},"/sar/reports/{requestId}/personal-info":{"get":{"tags":["Reports"],"summary":"Get personal info report","description":"Get Personal Info report for requested individual, including personal information attributes, consent records, and data source information. \n REQUEST: Parent DSAR scan Request ID.\n RESPONSE: Returns Personal Info attributes/values, data sources, consent events and report configuration","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"att_friendly_name":{"type":"string"},"attribute":{"type":"string"},"attribute_value":{"type":"string"},"mask_it":{"type":"boolean"},"purpose_of_use":{"type":"string"},"sar_category":{"type":"string"}}}},"consent":{"type":"array","items":{"type":"object","properties":{"agreement":{"type":"string"},"agreement_version":{"type":"string"},"application_id":{"type":"string"},"date":{"type":"string"},"name":{"type":"string"},"parentScanId":{"type":"string"},"raw":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"timestamp":{"type":"string"},"type_of_consent":{"type":"string"},"unique_id":{"type":"string"}}}},"data_sources":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"report_config":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"is_enabled":{"type":"boolean"}}}},"extended_attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"is_enabled":{"type":"boolean"}}}},"requestId":{"type":"string"},"type":{"type":"string"},"_id":{"type":"string"}}}},"agreementConsentAttributes":{"type":"object","properties":{"attributeNotUnderConsentTypeInAgreement":{"type":"array","items":{"type":"object","properties":{"friendly_name":{"type":"string"},"original_name":{"type":"string"}}}},"attributeUnderConsentTypeInAgreement":{"type":"array","items":{"type":"object","properties":{"friendly_name":{"type":"string"},"original_name":{"type":"string"}}}}}}}},"example":{"attributes":[{"att_friendly_name":"Birth Date","attribute":"DATE_OF_BIRTH","attribute_value":"25/5/1966","mask_it":false,"purpose_of_use":"for test","sar_category":"Yellow"}],"consent":[{"agreement":"Employee contract","agreement_version":2.2,"application_id":"HR-DB","date":"1/1/2005","parentScanId":321321321,"raw":["For internal use only"],"timestamp":"2019-04-30T13:17:54.075Z","type_of_consent":"signature","unique_id":123456789}],"data_sources":[{"location":"USA","name":"HRsybase","type":"sybase"}],"report_config":[{"requestId":123456789,"type":"personal_info_attributes","_id":987654321,"attributes":[{"name":"Birth date","is_enabled":true}],"extended_attributes":[{"name":"Birth date","is_enabled":false}]}],"agreementConsentAttributes":{"attributeNotUnderConsentTypeInAgreement":[{"friendly_name":"residency","original_name":"COUNTRY"}],"attributeUnderConsentTypeInAgreement":[{"friendly_name":"Birth Date","original_name":"DATE_OF_BIRTH"}]}}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/reports/{requestId}/extended-info":{"get":{"tags":["Reports"],"summary":"Get extended info report","description":"Get Extended Info report for requested individual, which includes Personal Information (PI) - these are attributes that are personal information but do not uniquely identify the individual. \n REQUEST: Parent DSAR scan Request ID.\n RESPONSE: Returns PI attributes/values and report settings","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"limit","in":"query","description":"Maximum number of data rows to return (default=1000)","schema":{"type":"number"}},{"name":"offset","in":"query","description":"Number of rows to skip before starting to count rows (default=0)","schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"extended_attributes":{"type":"array","items":{"type":"object","properties":{"att_friendly_name":{"type":"string"},"attribute":{"type":"string"},"value":{"type":"string"},"mask_it":{"type":"boolean"},"purpose_of_use":{"type":"string"},"sar_category":{"type":"string"}}}},"report_config":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"is_enabled":{"type":"boolean"}}}},"extended_attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"is_enabled":{"type":"boolean"}}}},"requestId":{"type":"string"},"type":{"type":"string"},"_id":{"type":"string"}}}},"offset":{"type":"number"}}},"example":{"extended_attributes":[{"att_friendly_name":"Birth Date","attribute":"DATE_OF_BIRTH","attribute_value":"25/5/1966","mask_it":false,"purpose_of_use":"for test","sar_category":"Yellow"}],"report_config":[{"requestId":123456789,"type":"personal_info_attributes","_id":987654321,"attributes":[{"name":"Birth date","is_enabled":true}],"extended_attributes":[{"name":"Birth date","is_enabled":false}]}],"offset":5}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/reports/{requestId}/personal-info/config":{"put":{"tags":["Reports"],"summary":"Configure personal info report","description":"Configure which attributes to include in the Personal Info report for a specified DSAR request. \n REQUEST: DSAR parent scan ID, list of attributes to enable/disable in personal info report.\n RESPONSE: Returns list of attributes enabled/disabled successfully","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"Array containing list of attributes to enable/disable for personal info report","content":{"schema":{"schema":{"type":"object","properties":{"name":{"type":"string"},"is_enabled":{"type":"boolean"},"type":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"isModified":{"type":"boolean"},"name":{"type":"string"}}},"example":{"isModified":true,"name":"DATE_OF_BIRTH"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"x-codegen-request-body-name":"body"}},"/sar/profiles":{"get":{"tags":["Profiles"],"summary":"Get DSAR profiles","description":"Get a list of existing DSAR profile IDs and names. \n REQUEST: No parameters \n RESPONSE: Array of DSAR profile IDs and names.","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}}}}}}},"example":{"profiles":[{"_id":123456,"name":"HRprofile","scopes":["5f9e5f11bfd614fa1cd51535"]},{"_id":11112,"name":"default","scopes":["root"]}]}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]},"post":{"tags":["Profiles"],"summary":"Create DSAR profile","description":"REQUEST: Name for new profile, connection flags \n(use `POST /sar/profiles/{profileId}/connections` to create list of specified data sources and correlation sets for the profile). \n RESPONSE: Profile ID","requestBody":{"description":"A JSON payload containing initial settings for the new profile:\n`name` name for the new profile \n`allEnabledDs` flag to scan all enabled data sources (true) or only data sources specified for the profile (false). \n`allEnabledEs` flag to scan all enabled correlation sets (true) or only correlation sets specified for the profile (false).","content":{"schema":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"OnlineCustomers"},"allEnabledDs":{"type":"boolean"},"allEnabledEs":{"type":"boolean"},"scopes":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"profileId":{"type":"string"}}},"example":{"profileId":123456}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/sar/profiles/{profileId}":{"get":{"tags":["Profiles"],"summary":"Get profile connections","description":"Get a listing of connection settings for a specified profile. \nREQUEST: Profile ID \n RESPONSE: (1) Connection flags specifying whether to scan all enabled data sources and correlation sets (`true`) or only data sources and correlation sets specified for this profile (`false`). (2) list of data sources and correlation sets specified for this profile.","parameters":[{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"_id":{"type":"string"},"updated_at":{"type":"string"},"created_at":{"type":"string"},"name":{"type":"string"},"allEnabledEs":{"type":"boolean"},"allEnabledDs":{"type":"boolean"},"scopes":{"type":"array","items":{"type":"string"}},"dsConnections":{"type":"array","items":{"type":"object","properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"id":{"type":"string"},"connectionStatusScan":{"type":"object","properties":{"is_success":{"type":"boolean"},"last_connection":{"type":"string"},"num_of_object":{"type":"string"}}}}}},"esConnections":{"type":"array","items":{"type":"object","properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"id":{"type":"string"},"connectionStatusScan":{"type":"object","properties":{"is_success":{"type":"boolean"},"last_connection":{"type":"string"},"num_of_object":{"type":"string"}}}}}}}},"example":{"_id":123456,"updated_at":"2019-04-30T13:17:54.075Z","created_at":"2019-04-30T13:17:54.075Z","name":"HRprofile","scopes":["root"],"allEnabledEs":true,"allEnabledDs":true,"dsConnections":[{"enabled":true,"name":"HRsybase","type":"sybase","id":5566,"connectionStatusScan":{"is_success":true,"last_connection":"2019-04-30T13:17:54.075Z","num_of_object":24}}],"esConnections":[{"enabled":true,"name":"HRSybase","type":"sybase","id":560,"connectionStatusScan":{"is_success":true,"last_connection":"2019-04-30T13:17:54.075Z","num_of_object":12}}]}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}},"put":{"tags":["Profiles"],"summary":"Set profile connection flags ","description":"REQUEST: Profile ID, profile name, connection flags specifying whether to scan all enabled data sources and correlation sets (`true`) or only data sources and correlation sets specified for this profile (`false`). \n RESPONSE: Success/fail","parameters":[{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"A JSON payload containing profile name and connection flags to update.","content":{"schema":{"schema":{"type":"object","properties":{"name":{"type":"string"},"allEnabledDs":{"type":"boolean"},"allEnabledEs":{"type":"boolean"},"scopes":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"isModified":{"type":"boolean"}}},"example":{"isModified":true}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"x-codegen-request-body-name":"body"},"delete":{"tags":["Profiles"],"summary":"Delete profile","description":"REQUEST: Profile ID to delete \n RESPONSE: Success/fail","parameters":[{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"isDeleted":{"type":"boolean"}}},"example":{"isDeleted":true}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/profiles/{profileId}/connections":{"post":{"tags":["Profiles"],"summary":"Specify profile connections","description":"Specify a list of data sources and correlation sets for a specified profile.  This list is applied only when `allEnabledDs=false` and/or `allEnabledEs=false` (see `PUT /sar/profiles/{profileId}`). \nREQUEST: Profile ID. \n RESPONSE: Success/fail","parameters":[{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"Array of data source and correlation set connections for the profile","content":{"schema":{"schema":{"type":"object","properties":{"connections":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"sourceType":{"type":"string"},"enabled":{"type":"boolean"},"isCaseInSensitiveSupported":{"type":"boolean"},"isReferentialIntegrity":{"type":"boolean"},"isExactMatch":{"type":"boolean"}}}},"profileId":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"isModified":{"type":"boolean"}}}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"x-codegen-request-body-name":"body"},"delete":{"tags":["Profiles"],"summary":"Delete profile connections","description":"Delete list of specific data source and correlation set connections configured for specified profile.\nREQUEST: Profile ID. \n RESPONSE: Success/fail","parameters":[{"name":"profileId","in":"path","description":"Profile id","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"isModified":{"type":"boolean"}}}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/profiles/duplicate":{"post":{"tags":["Profiles"],"summary":"Duplicate profile","description":"REQUEST: Profile ID to duplicate, name for new profile. \n RESPONSE: Success/fail","requestBody":{"description":"A JSON payload containing the ID of the profile being duplicated and the name of the new duplicate profile.","content":{"schema":{"schema":{"type":"object","properties":{"profileIdToDuplicate":{"type":"string","example":"123456"},"name":{"type":"string","example":"NewProfile"}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"profileId":{"type":"string"}}},"example":{"name":"NewProfile","profileId":654321}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/sar/profiles/{profileId}}/fields":{"post":{"tags":["Profiles"],"summary":"Update profile field settings","description":"Update profile field settings, including friendly name, purpose of use, category, mask it and include in reports.\nREQUEST: Profile ID, array of field settings.\n  RESPONSE: Count of updated rows. ","parameters":[{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"Array of profile field settings","content":{"schema":{"schema":{"required":["data","query"],"type":"object","properties":{"data":{"type":"object","properties":{"mask_it":{"type":"boolean"},"is_included_in_report":{"type":"string"},"friendly_name_glossary_id":{"type":"string"},"category_glossary_id":{"type":"string"},"purpose_glossary_id":{"type":"string"}}},"query":{"type":"object","properties":{"filter":{"type":"array","items":{"type":"object","properties":{"field":{"type":"boolean"},"operator":{"type":"string"},"value":{"type":"array","items":{"type":"string"}}}}}}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"updatedRows":{"type":"number"}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":[{"updatedRows":2}],"status":"success","statusCode":200,"massage":"successful operation"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}},"x-codegen-request-body-name":"body"}},"/sar/reports/bulk/csv-format":{"get":{"tags":["Bulk Request"],"summary":"Get bulk template","description":"Get CSV file template for bulk request. \nREQUEST: Profile ID for bulk request. \nRESPONSE: CSV template, in string format","parameters":[{"name":"profileId","in":"query","description":"Profile ID to use for bulk request","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"text/csv":{"schema":{"type":"object","properties":{"data":{"type":"string"}}}},"application/json":{"example":{"data":"string"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"text/csv":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"text/csv":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/sar/reports/bulk-from-csv":{"post":{"tags":["Bulk Request"],"summary":"Run bulk DSAR from CSV file","description":"Upload CSV bulk file and execute DSAR requests. \nREQUEST: Profile ID, CSV bulk request, callback information for asynchronous progress update \nRESPONSE: (synchronous) array of request IDs and user IDs","parameters":[{"name":"profileId","in":"query","description":"Profile ID to use for bulk request","schema":{"type":"string"}},{"name":"callbackUrl","in":"query","description":"POST request URL called on completion of search scan","schema":{"type":"string"}},{"name":"ssl_trust_store_path","in":"query","description":"Path of certificate to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_store_password","in":"query","description":"Password (if exists) to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_self_signed","in":"query","description":"Should callback trust self-signed certificates? (TRUE/FALSE)","schema":{"type":"string"}},{"name":"headers","in":"query","description":"If needed, specify headers for POST request here.  Syntax `\"ThisHeader\"=\"HeaderValue\"`","schema":{"type":"string"}},{"name":"groupCallbackResponse","in":"query","description":"decide if should group all the callbacks","schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"text/csv":{"schema":{"type":"object","properties":{"jitFullScanIds":{"type":"array","items":{"type":"string"}},"requests":{"type":"array","items":{"type":"object","properties":{"requestId":{"type":"string"},"userId":{"type":"string"}}}}}}},"application/json":{"example":{"jitFullScanIds":["dfg"]}}}},"500":{"description":"Failed operation","content":{"text/csv":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/sar/reports/bulk":{"post":{"tags":["Bulk Request"],"summary":"Run JSON bulk DSAR","description":"Execute DSAR scans for individuals specified in JSON payload. \nREQUEST: Profile ID, JSON payload, callback information for asynchronous progress update \nRESPONSE: Array of DSAR scan IDs","parameters":[{"name":"profileId","in":"query","description":"Profile ID, defining which entity sources and data sources to scan","schema":{"type":"string"}},{"name":"callbackUrl","in":"query","description":"POST request URL called on completion of search scan","schema":{"type":"string"}},{"name":"ssl_trust_store_path","in":"query","description":"Path of certificate to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_store_password","in":"query","description":"Password (if exists) to use for authentication in callback","schema":{"type":"string"}},{"name":"ssl_trust_self_signed","in":"query","description":"Should callback trust self-signed certificates? (TRUE/FALSE)","schema":{"type":"string"}},{"name":"headers","in":"query","description":"If needed, specify headers for POST request here.  Syntax `\"ThisHeader\"=\"HeaderValue\"`","schema":{"type":"string"}},{"name":"userId","in":"query","description":"Unique ID of the individual to run the DSAR scan on","required":true,"schema":{"type":"string"}},{"name":"displayName","in":"query","description":"Name of the individual to run the DSAR scan on","required":true,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"Optional.  If not specified, scan will automatically extract all relevant attributes from allowed entity sources.  If specified, scan will use these attributes to correlate additional fields. Syntax `<attribute_name>:<attribute_value>`.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"A JSON payload containing the Unique ID, Display Name and whatever other identifying attributes of the requested individual are known.","content":{"multipart/form-data":{"schema":{"required":["usersDetails"],"type":"object","properties":{"profileId":{"type":"string","example":"123456"},"callbackUrl":{"type":"string","example":"http://www.example.com"},"groupCallbackResponse":{"type":"boolean"},"callbackUrlProperties":{"type":"object","properties":{"ssl_trust_store_path":{"type":"string","example":".../folder1/folder2"},"ssl_trust_store_password":{"type":"string","example":"mypassword123"},"ssl_trust_self_signed":{"type":"boolean","example":true},"headers":{"type":"object","properties":{"authorization":{"type":"string","example":"ffff"}}}}},"usersDetails":{"type":"array","items":{"required":["displayName","userId"],"type":"object","properties":{"userId":{"type":"string","example":"123456789"},"displayName":{"type":"string","example":"Thomas Banks"},"attributes":{"type":"object","properties":{"attribute1":{"type":"number"},"attribute2":{"type":"string","example":"[email protected]"}}}}}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"text/csv":{"schema":{"type":"object","properties":{"jitFullScanIds":{"type":"array","items":{"type":"string"}}}}},"application/json":{"example":{"jitFullScanIds":["dfg"]}}}},"500":{"description":"Failed operation","content":{"text/csv":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"x-codegen-request-body-name":"body"}},"/sar/config/file-download/config-report":{"get":{"tags":["Reports"],"summary":"Get short report settings CSV","description":"Download DSAR Short Report settings, in CSV file.\nREQUEST: Profile ID \nRESPONSE: String listing attributes enabled in this profile for Short Report.","parameters":[{"name":"profileId","in":"query","description":"Profile ID for which to get short report settings","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"attachment/octet-stream":{"schema":{"type":"string","format":"binary"}},"application/json":{"example":{"message":"string"}}}},"500":{"description":"Failed operation","content":{"attachment/octet-stream":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/sar/config":{"get":{"tags":["Reports"],"summary":"Get report settings","description":"Get report settings in an array listing attributes and configurations.\n REQUEST: Paramaters for paginating result set.\nRESPONSE: Return report settings","parameters":[{"name":"limit","in":"query","description":"Maximum number of data rows to return","schema":{"type":"number"}},{"name":"offset","in":"query","description":"Number of rows to skip before starting to count rows","schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sarFieldsConf":{"type":"object","properties":{"_id":{"type":"string"},"attribute_type":{"type":"string"},"field_name":{"type":"string"},"is_primary":{"type":"boolean"},"fully_qualified_name":{"type":"string"},"data_source":{"type":"string"},"schema":{"type":"string"},"table":{"type":"string"},"attribute_name":{"type":"string"},"correlation_id":{"type":"string"},"sample_values":{"type":"string"},"field_name_lower":{"type":"string"},"is_included_in_report":{"type":"boolean"},"mask_it":{"type":"boolean"},"category":{"type":"string"},"purpose_of_use":{"type":"string"}}},"offset":{"type":"number"}}},"example":{"sarFieldsConf":[{"_id":"5f14327adaf5e1a8566d48c7","attribute_type":"Correlation","field_name":"COUNTRY","is_primary":false,"fully_qualified_name":"Sybase.probe.basic_test","data_source":"Sybase","schema":"probe","table":"basic_test","attribute_name":"country","correlation_id":"5f143268daf5e1a8566d474b","sample_values":"RU","field_name_lower":"country","is_included_in_report":true,"mask_it":false,"field_friendly_name":"","category":"","purpose_of_use":""}],"offset":1}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}}}},"/sar/reports/{requestId}/failed-objects":{"get":{"tags":["Reports"],"summary":"Get failed objects report","description":"Get a list of objects that failed to scan in a specified DSAR scan, in JSON/CSV file.\nREQUEST: Request ID, report format \nRESPONSE: Array of failed object details and error messages.","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"format","in":"query","description":"JSON or CSV.  Default = JSON.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"failedObject":{"type":"array","items":{"type":"object","properties":{"updated_at":{"type":"string"},"scanId":{"type":"string"},"source":{"type":"string"},"fullyQualifiedName":{"type":"string"},"errorMessage":{"type":"string"}}}}}},"example":{"failedObject":[{"updated_at":"25/5/1966","scanId":"5ef0954118a5f148c66287ba","source":"Sybase","fullyQualifiedName":"Sybase.probe.basic_test","errorMessage":"Failed to create connection"}]}},"text/csv":{"schema":{"type":"object","properties":{"failedObject":{"type":"array","items":{"type":"object","properties":{"updated_at":{"type":"string"},"scanId":{"type":"string"},"source":{"type":"string"},"fullyQualifiedName":{"type":"string"},"errorMessage":{"type":"string"}}}}}},"example":"\"Timestamp\",\"Scan ID\",\"Data Source\",\"Object\",\"Failure Reason\"\n\"2020-06-22T11:25:57.518Z\",\"5ef0954118a5f148c66287ba\",\"Sybase\",\"Failed to create connection\"\n\"2020-06-22T11:25:57.518Z\",\"5ef0954118a5f148c66287bb\",\"Sybase\",\"Failed to create connection\"\n"}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}},"text/csv":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}},"text/csv":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"/sar/config/import":{"post":{"tags":["Reports"],"summary":"Import short report settings","description":"Import short report settings CSV file for specified profile. \nREQUEST: CSV file listing attributes to include in short report, Profile ID \nRESPONSE: success/operation-queued/fail","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file","profileId"],"properties":{"file":{"type":"string","description":"CSV file containing this profile's short report settings","format":"binary"},"profileId":{"type":"string","description":"Profile ID"}}}}},"required":true},"responses":{"200":{"description":"operation has been initiated successfuly","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"operation has been initiated successfully"}}}},"202":{"description":"operation queued - another process is currently running for this profile ID","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"operation queued - another process is currently running for this profile ID"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/sar/reports/{requestId}/external-records":{"post":{"tags":["Reports"],"summary":"Add external records","description":"Add external records to be included in the individual's DSAR reports. \nREQUEST: Request ID, JSON payload containing array of records to append. \nRESPONSE: Count of records inserted.","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"A JSON payload containing an array of record objects. `source`and `objectName` are required. `fieldName` or `attribute` are required.","content":{"multipart/form-data":{"schema":{"required":["records"],"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"objectName":{"type":"string"},"fieldName":{"type":"string"},"value":{"type":"string"},"proximityId":{"type":"string"},"sourceLocation":{"type":"string"},"attribute":{"type":"string"}}}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"insertedCount":{"type":"number"}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":[{"insertedCount":1}],"status":"success","statusCode":200,"massage":"successful operation"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}},"x-codegen-request-body-name":"body"},"delete":{"tags":["Reports"],"summary":"Delete external records","description":"Delete external records for specified Request ID. \nREQUEST: Request ID \nRESPONSE: Count of records deleted","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"deletedCount":{"type":"number"}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":[{"deletedCount":1}],"status":"success","statusCode":200,"massage":"successful operation"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}}}},"/sar/scans":{"get":{"tags":["Monitoring"],"summary":"Get all DSAR scans history","description":"REQUEST: Get a list of all DSAR scans - can filter by scan state.\n RESPONSE: Returns an array of DSAR scan IDs and summary parameters.","parameters":[{"name":"limit","in":"query","description":"Maximum number of data rows to return","schema":{"type":"number"}},{"name":"offset","in":"query","description":"Number of rows to skip before starting to count rows","schema":{"type":"number"}},{"name":"state","in":"query","description":"Filter returned scans by state (completed/stopped/in progress).  If blank, returns all states.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"scans":{"type":"array","items":{"type":"object","properties":{"request_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"scan_progress_status":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"type":{"type":"string"},"state":{"type":"string"},"identity_unique_id":{"type":"string"},"record_count":{"type":"number"},"auth_user":{"type":"string"},"profile_id":{"type":"string"},"profile_name":{"type":"string"},"expires_on":{"type":"string"},"data_expired":{"type":"boolean"},"data_deleted":{"type":"boolean"},"sub_scan_finished":{"type":"number"}}}}}},"example":{"scans":[{"request_id":321321321,"created_at":"2019-04-30T13:17:54.075Z","updated_at":"2019-04-30T13:17:54.075Z","scan_progress_status":["completed"],"name":"JIT Full Scan","type":"JIT sub scan","state":"completed","identity_unique_id":123456789,"record_count":88,"auth_user":"[email protected]","profile_id":123456,"profile_name":"HRprofile","expires_on":"1/1/2020","data_expired":false,"data_deleted":false,"sub_scan_finished":7}]}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/scans/{requestId}":{"get":{"tags":["Monitoring"],"summary":"Get specific DSAR scan history","description":"REQUEST: Specify DSAR parent scan ID.  Can also filter by scan state.\n RESPONSE: Returns an array of scan information, including parent and sub-scans.","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"limit","in":"query","description":"Maximum number of data rows to return","schema":{"type":"number"}},{"name":"offset","in":"query","description":"Number of rows to skip before starting to count rows","schema":{"type":"number"}},{"name":"state","in":"query","description":"Filter returned scans by state (completed/stopped/in progress). If blank, returns all states.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"scans":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal unique ID"},"request_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"scan_progress_status":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"type":{"type":"string"},"state":{"type":"string"},"identity_unique_id":{"type":"string"},"record_count":{"type":"number"},"auth_user":{"type":"string"},"profile_id":{"type":"string"},"profile_name":{"type":"string"},"expires_on":{"type":"string"},"data_expired":{"type":"boolean"},"data_deleted":{"type":"boolean"},"sub_scan_finished":{"type":"number"},"totalCount":{"type":"number","description":"Total count of subscans that matched filter criteria","example":4},"sub_scans":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal unique ID"},"sub_scan_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"scan_progress_status":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"type":{"type":"string"},"state":{"type":"string"},"parent_scan_id":{"type":"string"},"ds_connection_name":{"type":"string"},"identity_unique_id":{"type":"string"},"identity_display_name":{"type":"string"},"connectorType":{"type":"string"},"scanner_group":{"type":"string"},"parent_scan_type":{"type":"string"},"is_report_ready":{"type":"boolean"},"is_deletion_validation":{"type":"boolean"},"scannerId":{"type":"string"},"record_count":{"type":"number"},"errorMessage":{"type":"string"},"auth_user":{"type":"string"},"profile_id":{"type":"string"},"profile_name":{"type":"string"},"expires_on":{"type":"string"},"data_expired":{"type":"boolean"},"data_deleted":{"type":"boolean"},"finalCollectionsCount":{"type":"number"},"totalCollections":{"type":"number"},"totalFailedCollections":{"type":"number"},"info":{"type":"string","description":"Scan progress info","example":"Objects scanned: 3, Failures: 1"}}}}}}}}},"example":{"scans":[{"request_id":321321321,"created_at":"2019-04-30T13:17:54.075Z","updated_at":"2019-04-30T13:17:54.075Z","scan_progress_status":["completed"],"name":"JIT - Request ID 123456789","type":"JIT sub scan","state":"completed","identity_unique_id":123456789,"record_count":88,"auth_user":"[email protected]","profile_id":123456,"profile_name":"HRprofile","expires_on":"1/1/2020","data_expired":false,"data_deleted":false,"sub_scan_finished":7,"sub_scans":[{"sub_scan_id":123123123,"created_at":"2019-04-30T13:17:54.075Z","updated_at":"2019-04-30T13:17:54.075Z","scan_progress_status":["completed"],"name":"Sybase1, Unique ID: 829-00-2162","type":"jit sub-scan","state":"completed","parent_scan_id":321321321,"ds_connection_name":"HRsybase","identity_unique_id":123456789,"identity_display_name":"Thomas Banks","connectorType":"sybase","scanner_group":"default","parent_scan_type":"jit scan","is_report_ready":true,"is_deletion_validation":false,"scannerId":12345,"record_count":31,"auth_user":"[email protected]","profile_id":123456,"profile_name":"HRprofile","expires_on":"1/1/2020","data_expired":false,"data_deleted":false,"finalCollectionsCount":10,"totalCollections":12,"totalFailedCollections":2,"info":"Objects scanned: 3, Failures: 1"}]}]}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/jit_scans":{"get":{"tags":["Monitoring"],"summary":"Get DSAR scans history (older version)","description":"REQUEST: Get all or filter by DSAR parent scan ID.\n RESPONSE: Returns an array of DSAR scan information.","parameters":[{"name":"filter","in":"query","description":"DSAR parent scan ID.  If blank, return all scans.  Can also filter by scan state.  Syntax: `state=completed `","schema":{"type":"string"}},{"name":"allScans","in":"query","description":"`TRUE` return all JIT scans. `FALSE` return only non-deleted JIT scans. Default = `FALSE`","schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"create_date":{"type":"string"},"data_deleted":{"type":"boolean"},"data_expired":{"type":"boolean"},"expires_on":{"type":"string"},"identity_display_name":{"type":"string"},"isAllCompleted":{"type":"boolean"},"is_report_ready":{"type":"boolean"},"parent_scan_id":{"type":"string"},"record_count":{"type":"number"},"statuses_set":{"type":"array","items":{"type":"string"}},"statuses_str":{"type":"string"},"stopRequested":{"type":"boolean"},"user_id":{"type":"string"},"profile_id":{"type":"string"},"profile_name":{"type":"string"}}}},"example":[{"create_date":"2019-04-30T13:17:54.075Z","data_deleted":false,"data_expired":false,"expires_on":"1/1/2020","identity_display_name":"Thomas Banks","isAllCompleted":true,"is_report_ready":true,"parent_scan_id":321321321,"record_count":88,"statuses_set":["string"],"stopRequested":false,"user_id":"[email protected]","profile_id":123456,"profile_name":"HRprofile"}]}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"type":"string","example":"Error"}}}}}}},"/sar/reports/{requestId}/searched-attributes":{"get":{"tags":["Monitoring"],"summary":"Get searched attributes","description":"Get a list of attributes that were used to search for the individual in a specified DSAR request. \n REQUEST: DSAR parent scan ID.\n RESPONSE: Returns the list of searched attributes and their values.","parameters":[{"name":"requestId","in":"path","description":"Parent scan ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"searchedAttributes":{"type":"object","properties":{"allAttributes":{"type":"object","properties":{}},"searchableAttributes":{"type":"object","properties":{}}}}}},"example":{"searchedAttributes":{"allAttributes":{"ssn":123344567,"email":"[email protected]","favorite_color":"blue"},"searchableAttributes":{"ssn":123344567,"email":"[email protected]"}}}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}},"delete":{"tags":["Monitoring"],"summary":"Delete searched attributes","description":"Delete the list of attributes and values that were used in a specified DSAR request.  \n REQUEST: DSAR parent scan ID.\n RESPONSE: Success/failure","parameters":[{"name":"requestId","in":"path","description":"Parent scan ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse1"}}}}}}},"/sar/reports/{requestId}/status":{"get":{"tags":["Monitoring"],"summary":"Get individual scan status","description":"Get scan status for specified individual.\n REQUEST:  Parent scan ID. \n RESPONSE: Completion status and details of parent scan and subscans.","parameters":[{"name":"requestId","in":"path","description":"DSAR parent scan ID","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"requestId":{"type":"string"},"userId":{"type":"string"},"state":{"type":"string"},"statuses":{"type":"object","properties":{}},"subScansInfo":{"type":"array","items":{"type":"object","properties":{"scanId":{"type":"string"},"dataSourceName":{"type":"string"},"state":{"type":"string"},"scannedObjects":{"type":"number"},"failedObjects":{"type":"number"},"error":{"type":"string"}}}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":{"requestId":"5f156f68daf5e1a8566df122","userId":"829-00-2162","state":"Completed","statuses":{"Completed":2},"subScansInfo":[{"scanId":"5f156fa3daf5e1a8566df19b","dataSourceName":"Sybase","state":"Completed","scannedObjects":1,"failedObjects":0},{"scanId":"5f156f69daf5e1a8566df15b","state":"Completed","scannedObjects":0,"failedObjects":0}]},"status":"success","statusCode":200,"massage":"successful operation"}}}},"403":{"description":"user role insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}}}},"/sar/attributes-enrichment":{"get":{"tags":["Attributes Enrichment"],"summary":"Get all enrichment flow names","description":"Get a list of all enrichment flow names in the system. \nREQUEST: No parameters.\nRESPONSE: List of enrichment flow names.","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"names":{"type":"array","items":{"type":"string"}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":{"names":["name1","name2"],"status":"success","statusCode":200,"message":"successful operation"}}}}},"400":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"Expected a value of type string"}],"status":"error","statusCode":400,"message":"The provided request has invalid payload"}}}},"500":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"internal error"}],"status":"error","statusCode":500,"message":"internal error"}}}}},"parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/sar/attributes-enrichment/{flowName}":{"get":{"tags":["Attributes Enrichment"],"summary":"Get enrichment flow steps","description":"Get a list of steps in the specified enrichment flow.\nREQUEST: Flow name.\nRESPONSE: Listing of steps mapping fields in the enrichment flow - from/to/origin.","parameters":[{"name":"flowName","in":"path","description":"Flow name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"attributesEnrichmentFlow":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"index":{"type":"number"},"source":{"type":"string"},"fieldsMapping":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"source":{"type":"string"}}}}}}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":{"attributesEnrichmentFlow":[{"name":"model"},{"index":0},{"source":"entity source"},{"fieldsMapping":[{"from":"origin attribute"},{"to":"distance attribute"},{"origin":"entity source to take the value from"}]}]},"status":"success","statusCode":200,"message":"successful operation"}}}},"400":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"Expected a value of type string"}],"status":"error","statusCode":400,"message":"The provided request has invalid payload"}}}},"500":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"internal error"}],"status":"error","statusCode":500,"message":"internal error"}}}}}},"post":{"tags":["Attributes Enrichment"],"summary":"Create enrichment flow","description":"Create correlation set field mappings for enrichment flow.\nREQUEST: Flow name, field mappings - from/to/origin.\nRESPONSE: Count of flow steps inserted.","parameters":[{"name":"flowName","in":"path","description":"Flow name to create","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"content":{"schema":{"schema":{"required":["flow"],"type":"object","properties":{"flow":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string","example":"entity source"},"fieldsMapping":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","example":"origin attribute"},"to":{"type":"string","example":"current attribute"},"origin":{"type":"string","example":"the entity source to take the value from"}}}}}}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"name":{"type":"string"},"insertedSteps":{"type":"integer"}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":{"name":"attributes-enrichment-model","insertedSteps":7},"status":"success","statusCode":200,"message":"successful operation"}}}},"400":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"Expected a value of type string"}],"status":"error","statusCode":400,"message":"The provided request has invalid payload"}}}},"500":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"internal error"}],"status":"error","statusCode":500,"message":"internal error"}}}}},"x-codegen-request-body-name":"body"},"delete":{"tags":["Attributes Enrichment"],"summary":"Delete enrichment flow","description":"Delete specified enrichment flow.\nREQUEST: Enrichment flow name.\nRESPONSE: Count of flow steps deleted.","parameters":[{"name":"flowName","in":"path","description":"Flow name to delete","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"deletedSteps":{"type":"integer"},"name":{"type":"string"}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":{"deletedSteps":2,"name":"attribute-enrichment-flow"},"status":"success","statusCode":200,"message":"successful operation"}}}},"400":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"Expected a value of type string"}],"status":"error","statusCode":400,"message":"The provided request has invalid payload"}}}},"500":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"internal error"}],"status":"error","statusCode":500,"message":"internal error"}}}}}}},"/sar/attributes-enrichment/{flowName}/enrich":{"post":{"tags":["Attributes Enrichment"],"summary":"Run enrichment flow","description":"Run specified enrichment flow for specified individual.\nREQUEST: Enrichment flow name, identifying attribute(s) for individual.\nRESPONSE: Array of enrichment attributes and values found for the individual. ","parameters":[{"name":"flowName","in":"path","description":"Enrichment flow name","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"Enrichment attributes and values found","content":{"schema":{"schema":{"required":["attributes"],"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"full_name"},"value":{"type":"string","example":"Yair Shkedi"}}}}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"attributesEnrichment":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"attributesMap":{"type":"object","properties":{}}}}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":{"attributesEnrichment":{"source":"entity source","attributesMap":[{"fullName":"Yair Shkedi"},{"zipcode":123456},{"id":654321}]}},"status":"success","statusCode":200,"message":"successful operation"}}}},"400":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"Expected a value of type string"}],"status":"error","statusCode":400,"message":"The provided request has invalid payload"}}}},"500":{"description":"wrong input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"},"example":{"error":[{"message":"internal error"}],"status":"error","statusCode":500,"message":"internal error"}}}}},"x-codegen-request-body-name":"body"}},"/sar/audit":{"get":{"tags":["Audit"],"summary":"Get audit logs","description":"Get all audit logs.\n REQUEST: Pagination parameters, sort criteria. \n RESPONSE: Structured array of log entries.","parameters":[{"name":"limit","in":"query","description":"Maximum number of data rows to return","schema":{"type":"number"}},{"name":"skip","in":"query","description":"Number of rows to skip before starting to count rows","schema":{"type":"number"}},{"name":"requireTotalCount","in":"query","description":"Return count of total records? (default = false)","schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string"},"endpoint":{"type":"string"},"id":{"type":"string"},"requestId":{"type":"string"},"timestamp":{"type":"string"},"uniqueId":{"type":"string"},"user":{"type":"string"},"userAgent":{"type":"string"}}}},"total":{"type":"number"}}}},"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"}}},"example":{"data":[{"results":[{"action":"GET","endpoint":"/api/v1/sar/...","id":"5f157f12daf5e1a8566e092a","requestId":"5f156f68daf5e1a8566df122","timestamp":"2020-07-20T11:25:06.973Z","uniqueId":"829-00-2162","user":"bigid","userAgent":"Mozilla/5.0"}],"offset":2,"total":100}],"status":"success","statusCode":200,"massage":"successful operation"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}},"x-codegen-request-body-name":"sort"}},"/sar/sar-queries":{"get":{"tags":["Query"],"summary":"Get DSAR queries","description":"Get DSAR queries by filter.\n REQUEST: object name, scan id, parent scan id criterias. \n RESPONSE: Structured array of query objects.","parameters":[{"name":"scanId","in":"query","description":"DSAR sub-request id","schema":{"type":"string"}},{"name":"parentScanId","in":"query","description":"DSAR request id","schema":{"type":"string"}},{"name":"objectName","in":"query","description":"Name of the object","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"scanId":{"type":"string","example":"5f97e32c85f3d92cc16fda98"},"parentScanId":{"type":"string","example":"5f97e32b85f3d92cc16fda76"},"objectName":{"type":"string","example":"TABLE_NAME"},"query":{"type":"string","example":"SELECT column1 FROM TABLE_NAME where column1 = 'A'"}}},"example":{"data":[{"_id":"5f97e34e85f3d92cc16fdbe1","created_at":"2020-10-27T09:07:26.413Z","objectName":"TRANSACTION_DETAILS_1","parentScanId":"5f97e34a85f3d92cc16fdb99","query":"SELECT \"TRANSACTION_ID\" FROM \"instance\".\"schema\".\"table\" WHERE ((TRANSACTION_ID = '100009'))","scanId":"5f97e34a85f3d92cc16fdbaf","updated_at":"2020-10-27T09:07:26.413Z"}],"status":"success","statusCode":200,"massage":"successful operation"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}}},"post":{"tags":["Query"],"summary":"Get DSAR queries","description":"Get DSAR queries by filter.\n REQUEST: object name, scan id, parent scan id criterias. \n RESPONSE: Structured array of query objects.","requestBody":{"description":"A JSON payload containing the Scan ID, Parent Scan ID, Object Name, DSAR Query","content":{"schema":{"schema":{"required":["objectName","parentScanId","query","scanId"],"type":"object","properties":{"parentScanId":{"type":"string","description":"DSAR sub-request id"},"scanId":{"type":"string","description":"DSAR request id"},"objectName":{"type":"string","description":"Name of the object"},"query":{"type":"string","description":"DSAR query"}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"5f97e32c85f3d92cc16fda98"}}},"example":{"data":[{"_id":"5f97e34e85f3d92cc16fdbe1"}],"status":"success","statusCode":200,"massage":"successful operation"}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg2"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/scan-api/analyze":{"post":{"tags":["Scan API"],"summary":"Scan API (asynchronously)","description":"Scan a payload asynchronously. If data is valid, a 202 (Accepted) status code is returned. This endpoint can be used in two modes:\n - body contains source, channel and payload. This mode is useful for programmatic invocation.\n - body is the payload, source is passed in X-BIGID-SOURCE and chanel is passed in X-BIGID-CHANNEL header.\n This mode is useful for monitoring an API gateway's traffic.","operationId":"asyncScanApi","parameters":[{"name":"X-BIGID-CHANNEL","in":"header","description":"An alternative way to pass a channel. \n If used, message body will be used as the payload, the message body will be used as the payload, channel from X-BIGID-CHANNEL and source will be taken from X-BIGID-SOURCE.","schema":{"type":"string"}},{"name":"X-BIGID-SOURCE","in":"header","description":"An alternative way to pass a source. \n If X-BIGID-CHANNEL is set, the message body will be used as the payload, channel from X-BIGID-CHANNEL and source will be taken from X-BIGID-SOURCE.\n If X-BIGID-CHANNEL is not set - this field will be ignored.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"description":"Source, channel and payload of the scan payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadRequestSchema"}}},"required":true},"responses":{"202":{"description":"Accepted - the scan will be done asynchronously.","content":{"application/json":{"schema":{"required":["status"],"type":"object","properties":{"status":{"type":"string","example":"Accepted"}}}}}},"400":{"description":"No channel or no Payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"403":{"description":"Feature is not enabled on server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"500":{"description":"Unknown server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}}},"x-codegen-request-body-name":"body"}},"/scan-api/classify":{"post":{"tags":["Scan API"],"summary":"Scan payload for classifications (Synchronously).","description":"Scan payload for classifiers (including NER). Return the list of classifiers found.","operationId":"syncScanApiClassify","requestBody":{"description":"Source, channel and payload to the scan payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadRequestSchema"}}},"required":true},"responses":{"200":{"description":"An object which describes all found classifications.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"No channel or no Payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"403":{"description":"Feature is not enabled on server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"500":{"description":"Unknown server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/scan-api/correlate":{"post":{"tags":["Scan API"],"summary":"Get Entity Source (IDSoR) Attribute (not classifiers) synchronously. Return the list of IDSoR Attributes found.","operationId":"syncScanApiCorrelate","requestBody":{"description":"Source, channel and payload to the scan payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadRequestSchema"}}},"required":true},"responses":{"200":{"description":"List of IDSoR Attributes found.","content":{}},"400":{"description":"No channel or no Payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"403":{"description":"Feature is not enabled on server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"500":{"description":"Unknown server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/scan-api/check-policies":{"post":{"tags":["Scan API"],"summary":"Get which policies are violated by this message (synchronously)","operationId":"syncScanApiCheckPolicies","requestBody":{"description":"Source, channel and payload to the scan payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadRequestSchema"}}},"required":true},"responses":{"200":{"description":"List of policies that have violated this message.","content":{}},"400":{"description":"No channel or no Payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"403":{"description":"Feature is not enabled on server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"500":{"description":"Unknown server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/scan-api/entities":{"post":{"tags":["Scan API"],"summary":"Get which entities (identities) have been correlated to this messages (synchronously) (e.g. this message contains Danny’s SSN)","operationId":"syncScanApiEntities","requestBody":{"description":"Source, channel and payload to the scan payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadRequestSchema"}}},"required":true},"responses":{"200":{"description":"List of entities (identities) that have been correlated to this messages (e.g. this message contains Danny’s SSN).","content":{}},"400":{"description":"No channel or no Payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"403":{"description":"Feature is not enabled on server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"500":{"description":"Unknown server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/scan-api/residencies":{"post":{"tags":["Scan API"],"summary":"Synchronously get list of residencies (identities) have been correlated to this messages.","operationId":"syncScanApiResidencies","requestBody":{"description":"Source, channel and payload to the scan payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadRequestSchema"}}},"required":true},"responses":{"200":{"description":"List of residencies (identities) that have been correlated to this messages","content":{}},"400":{"description":"No channel or no Payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"403":{"description":"Feature is not enabled on server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"500":{"description":"Unknown server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/scan-result/stream/json":{"get":{"tags":["Scan results"],"summary":"Get Scan results  info","description":"Get Scan results info.","parameters":[{"name":"pageSize","in":"query","description":"page size for pagination use","schema":{"type":"number"}},{"name":"limit","in":"query","description":"maximum records return from the api call","schema":{"type":"number"}},{"name":"offset","in":"query","description":"records offset for pagination use","schema":{"type":"number"}},{"name":"sort","in":"query","description":"gives the user the option to sort the records return by a certain field (accending/decending)","schema":{"type":"string"}},{"name":"skip","in":"query","description":"gives the user the option to skip the first number of records return from the api. if skip = 5 and limit = 100, the api will return the last 95 records","schema":{"type":"number"}},{"name":"filter","in":"query","description":"gives the user the option to filter the records, using bigid query language.","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Get Scan results info","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/dataItem"}},"example":[{"_id":"5eb02fc8e0fd6afb73029cef","hashId":"f366703f7150e20a0dd6034d9a370a0b","attribute":"","attributeRecordsCount":1600,"avgRisk":-1,"fieldName":"","object":"","owner":"","source":"mysql-ds-enrichment-tests","update_date":"2020-05-04T15:07:52.350Z","attribute_original_name":"","attribute_name":"","type":"rdb-mysql","location":"Israel","last_scan_at":"2020-05-04T15:06:58.926Z"},{"_id":"5eb02fc8e0fd6afb73029ce0","hashId":"4a89f10bebb9bfe64fb5e2796f4e3560","attribute":"country","attributeRecordsCount":400,"attribute_type":"IDSoR Attribute","avgRisk":-1,"source":"mysql-ds-enrichment-tests","update_date":"2020-05-04T15:07:52.330Z","pii_investigation_join_field":{"attribute":"country","data_source":"mysql-ds-enrichment-tests"},"attribute_original_name":"country","attribute_name":"country","type":"rdb-mysql","location":"Israel","last_scan_at":"2020-05-04T15:06:58.926Z"},{"_id":"5eb02faae0fd6afb73028eab","hashId":"693b4a8ca2072146054708ceed6c9687","att_stat":[{"identification_score":0.13,"overrideSureMatch":false,"stdDevPop_ids_per_value":6.831877941899851,"number_values_count":0,"distinct_ids_with_att_field":100,"distinct_ids_with_att_val":100,"avg_values_length":8.384615384615385,"stdDev_values_length":5.076923076923077,"max_att_pii":100,"avg_identities_per_value":7.6923076923076925,"distinct_field_value_count":13,"_id":"country","max_att_ids":100,"_class":"com.bigid.correlator.correlatordomain.domain.AttributeStatistics"}],"attribute":"country","attributeDistIdsCount":0,"attributeDistValsCount":1,"attributeFindingsCount":1,"attributeRecordsCount":0,"attributeRecordsCountNumbers":0,"attribute_type":"IDSoR Attribute","confidence_level":0,"count_full_match":0,"count_full_sure_match":0,"count_pos0":0,"count_pseudo_match":0,"count_sure_match":0,"fieldCount":1000,"fieldFindingsCount":1,"fieldMaxIds":0,"fieldMaxPii":0,"fieldName":"city","fieldPiiCount":0,"findings_avg_len":6,"findings_full_match":0,"findings_pos0":0,"fullyQualifiedName":"mysql-ds-enrichment-tests.ben.pause_resume_view1","scanId":"5eb02f92e0fd6afb730289a2","source":"mysql-ds-enrichment-tests","totalPiiRecordsCount":400,"update_date":"2020-05-04T15:07:22.743Z","attribute_original_name":"country","attribute_name":"country","rank":"3 - Low","type":"rdb-mysql","location":"Israel","last_scan_at":"2020-05-04T15:06:58.926Z","owner":"ben","object":"pause_resume_view1","calculatedRank":"3 - Low"}]}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMsg3"}}}}}}},"/sessions":{"post":{"tags":["Session Token"],"summary":"Generate session token","description":"Use this API to generate a session login token. A session login token expires 24 hours after creation.\n Use recieved token in header parameter 'authorization' in every succeeding API call.\n REQUEST: Put username and password. \n RESPONSE: Returns auth_token.","requestBody":{"description":"put user basic authentication credentials.","content":{"schema":{"schema":{"required":["password","username"],"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string","example":"Enjoy your token!"},"auth_token":{"type":"string"},"username":{"type":"string"},"firstName":{"type":"string"},"permissions":{"type":"array","items":{"type":"string","example":"api"}}}},"example":{"success":true,"message":"Enjoyyourtoken!","auth_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJiaWdpZCIsInR5cGUiOiJhY2Nlc3MtdG9rZW4iLCJyb2xlSWRzIjpbIjViYWE0Y2VkNTkxZTc1NzFhOTRlY2I2ZSJdLCJpc0FkbWluIjp0cnVlLCJpYXQiOjE1NzQyNTYwNDUsImV4cCI6MTU3NDM0MjQ0NX0.JebF8nAA5qZ5mCUPOzCO9dkUdR4EqPqplVrX3_ebxJg","username":"bigid","firstName":"BigIDAdmin","permissions":["api"]}}}},"500":{"description":"Failed operation","content":{"application/json":{"schema":{"required":["error"],"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"}}}}}}},"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}]}},"/tpa/executions/{executionId}":{"put":{"tags":["Action Progress"],"summary":"Update action progress","description":"Update BigID on the progress of an action being executed.\n \nREQUEST: Execution ID, execution status, percent completed, progress message.\n\n RESPONSE: Success/fail.","parameters":[{"$ref":"#/components/parameters/executionId"},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"content":{"application/form":{"schema":{"type":"object","properties":{"statusEnum":{"description":"Completion status of action in progress.","type":"string","enum":["COMPLETED","IN_PROGRESS","ERROR"]},"progress":{"description":"A number between 0 and 1 representing the percent completion of executing the action.","type":"number","format":"double","example":0.55,"minimum":0,"maximum":1},"message":{"type":"string","example":"Action is 55% complete -or- Processed 55 items out of 100.","description":"A text message describing the progress update."}},"example":{"statusEnum":"IN_PROGRESS","progress":0.55,"message":"Action is 55% complete -or- Processed 55 items out of 100."}}}}},"responses":{"200":{"description":"Synchronous response - update was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/executeResponse"}}}},"500":{"description":"Synchronous response - update failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse2"}}}},"default":{"description":"Unexpected error"}}}},"/tpa/executions/{executionId}/attachment":{"post":{"tags":["Action I/O"],"summary":"Upload file","description":"Upload/overwrite file(s) to save in BigID. Maximum number of files = 3 (fourth file will overwrite the first, fifth file will overwrite the second, etc).\n\nREQUEST: File(s) to upload, execution ID.\n\nRESPONSE: Attachment ID.","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"File(s) to upload, not bigger than 16MB in total"}}}}}},"parameters":[{"$ref":"#/components/parameters/executionId"},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"File(s) uploaded successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/putAttachmentResponse"}}}},"default":{"description":"Unexpected error"}}}},"/tpa/{tpaId}/storage":{"put":{"tags":["Action I/O"],"summary":"Store values.","description":"Store values produced by the action as key-value pairs in BigID. \n\nREQUEST: Array of key-value pairs.\n\nRESPONSE: Success/fail.","parameters":[{"$ref":"#/components/parameters/tpaId"},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"keysValue":{"description":"Key-value pairs to store in BigID.","type":"array","items":{"$ref":"#/components/schemas/keyValue"}}}}}}},"responses":{"200":{"description":"Data saved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/executeResponse"}}}},"default":{"description":"Unexpected error"}}},"get":{"tags":["Action I/O"],"summary":"Get all keys and values","description":"Get a list of all key-value pairs stored in BigID by this application.\n\nREQUEST: Application ID.  \n\nRESPONSE: Array of key-value pairs.","parameters":[{"$ref":"#/components/parameters/tpaId"},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Array of all key-value pairs stored in BigID for this application.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/keyValue"},"required":["result"]}}}},"default":{"description":"Unexpected error"}}}},"/tpa/{tpaId}/storage/key/{keyName}":{"get":{"tags":["Action I/O"],"summary":"Get key value","description":"Get the value of a specified key. \n\nREQUEST: Application ID, key name. \n\nRESPONSE: Key value.","parameters":[{"$ref":"#/components/parameters/tpaId"},{"in":"path","name":"keyName","schema":{"type":"string"},"required":true,"description":"Name of the key value to retrieve."},{"name":"Authorization","in":"header","description":"API key for BigID","schema":{"type":"string"}}],"responses":{"200":{"description":"Value of requested key (or {key: null} if no value is found).","content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/keyValue"}},"required":["result"]}}}},"default":{"description":"Unexpected error"}}}}},"components":{"schemas":{"AuthRequest":{"type":"object","properties":{"username":{"type":"string","example":"some_username"},"password":{"type":"string","example":"some_password"}}},"ScanInvoke":{"type":"object","properties":{"scanType":{"type":"string","example":"dsScan"},"scanProfileName":{"type":"string","example":"scan-profile1"}}},"ScanProfile":{"required":["active","allEnabledDs","allEnabledIdSor","description","isCustomScanProfile","name","scanType"],"type":"object","properties":{"scanType":{"type":"string"},"allEnabledIdSor":{"type":"boolean"},"allEnabledDs":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"isCustomScanProfile":{"type":"boolean"},"active":{"type":"boolean"},"schedule":{"type":"string"},"dataSourceList":{"type":"array","items":{"type":"string"}},"idsorList":{"type":"array","items":{"type":"string"}}}},"ScanResult":{"type":"object","properties":{"name":{"type":"string"},"state":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"noFindingsForCorrelation":{"type":"boolean"},"collectionForCorrelation":{"type":"string"},"identities_scanned":{"type":"integer"}}},"DsConnection":{"type":"object","properties":{"password":{"type":"string"},"name":{"type":"string"},"rdb_is_sample_data":{"type":"boolean"},"rdb_url":{"type":"string"},"rdb_name":{"type":"string","example":"hhhhhh"},"rdb_conn_properties":{"type":"string"},"rdb_comma_sep_table_list":{"type":"string"},"rdb_is_only_user_objects":{"type":"boolean"},"enrichment_is_enabled":{"type":"boolean"},"classification_is_enabled":{"type":"boolean"},"username":{"type":"string"},"type":{"type":"string"},"security_tier":{"type":"string"},"enabled":{"type":"string"},"differntial":{"type":"boolean"},"comment":{"type":"string"}}},"CLRConnection":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"string","example":"ColumnName"}},"columnTypes":{"type":"array","items":{"type":"string","example":"char"}},"custom_query_string":{"type":"string","example":"SELECT * FROM USERS"},"isCustomQueryString":{"type":"boolean"},"location":{"type":"string","example":"United States"},"name":{"type":"string","example":"Users"},"db_table":{"type":"string","example":"Users"},"scanConnectioinTimoutInSeconds":{"type":"number","example":100,"nullable":true},"display_name":{"type":"string","example":"None"},"dsConnection":{"type":"string","example":"Users"},"enabled":{"type":"string","example":"yes"},"identities_force_sample":{"type":"boolean"},"identities_sample_size":{"type":"string","example":1000},"skip_sample_size":{"type":"number","example":100,"nullable":true},"skip_sample_start":{"type":"boolean"},"type":{"type":"string","example":"ds-connection"},"unique_id":{"type":"string","example":"Username"},"unique_id_delimiter":{"type":"string","example":","},"use_random_sampling":{"type":"boolean"}}},"errorMsg":{"required":["error"],"type":"object","properties":{"message":{"type":"string"},"error":{"type":"string"}}},"errorResponse":{"additionalProperties":false,"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}}}},"statusCode":{"type":"number"},"status":{"type":"string"}}},"validationResponse":{"additionalProperties":false,"type":"object","properties":{"status":{"type":"string"},"statusCode":{"type":"number"},"message":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/validationError"}}}},"validationError":{"additionalProperties":false,"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"instance":{"type":"string"},"details":{"type":"string"}}},"systemAttribute":{"required":["attributeOriginalName"],"type":"object","properties":{"attributeId":{"type":"string"},"attributeOriginalName":{"type":"string"},"attributeName":{"type":"string"},"identificationScore":{"type":"number"},"compositeDelimiter":{"type":"string"},"isPartOfComposition":{"type":"boolean"},"description":{"type":"string"},"glossaryId":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"idSource":{"type":"array","items":{"type":"string"}},"attributeType":{"type":"string"},"attributeOriginalType":{"type":"string"},"classifierType":{"type":"string"},"source":{"type":"array","items":{"type":"string"}},"purpose":{"type":"array","items":{"type":"string"}}}},"errorMsg1":{"required":["detail","message","status"],"type":"object","properties":{"message":{"type":"string"},"status":{"type":"number"},"detail":{"type":"string"}}},"CatalogObjects":{"type":"object","properties":{"estimatedCount":{"type":"integer"},"totalRowsCounter":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"type":{"type":"string"},"containerName":{"type":"string"},"objectName":{"type":"string"},"fullyQualifiedNames":{"type":"string"},"fullObjectName":{"type":"string"},"total_pii_count":{"type":"number"},"scanner_type_group":{"type":"string"},"objectType":{"type":"string"},"attribute_original_name":{"type":"array","items":{"type":"string"}},"open_access":{"type":"string"},"Document Classifier":{"type":"string"},"Language":{"type":"string"},"Size (in bytes)":{"type":"string"},"Owner":{"type":"string"},"Modified":{"type":"string"},"Last scanned":{"type":"string"},"Location":{"type":"string"}}}}}},"manualConnectionData":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/manualConnection"}}}},"manualConnection":{"required":["foreign_field","lineage_node","linked_collection","local_field"],"type":"object","properties":{"lineage_node":{"type":"string"},"linked_collection":{"type":"string"},"local_field":{"type":"string"},"foreign_field":{"type":"string"},"type":{"type":"string"},"scanId":{"type":"string"},"data_source":{"type":"string"},"constraint_name":{"type":"string"}}},"lineageNode":{"type":"object","properties":{"_id":{"type":"string"},"lineage_details":{"type":"object","properties":{"_id":{"type":"string"},"connected_collections":{"type":"array","items":{"type":"string"}},"connections":{"type":"array","items":{"$ref":"#/components/schemas/connection"}}}}}},"connection":{"type":"object","properties":{"linked_collection":{"type":"string"},"connection_fields":{"type":"array","items":{"$ref":"#/components/schemas/connection_field"}}}},"connection_field":{"type":"object","properties":{"local_field":{"type":"string"},"foreign_field":{"type":"string"},"manual":{"type":"boolean"}}},"successMsgLineageNode":{"type":"object","properties":{"status":{"type":"string"},"statusCode":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/lineageNode"}}}},"sucssesMsg":{"type":"object","properties":{"status":{"type":"string"},"statusCode":{"type":"integer"}}},"validationMsg":{"type":"object","properties":{"status":{"type":"string"},"statusCode":{"type":"integer"},"message":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/validationError1"}}}},"validationError1":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"instance":{"type":"integer"},"details":{"type":"string"}}},"errorMsg2":{"required":["errors"],"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}}}},"statusCode":{"type":"number"},"status":{"type":"string"}}},"errorResponse1":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}}},"errorRbac403":{"type":"object","properties":{"message":{"type":"object","example":"user role insufficient permissions for profileId / requestId"},"statusCode":{"type":"object","example":"403"},"status":{"type":"object","example":"error"}}},"payloadRequestSchema":{"required":["channel","payload"],"type":"object","properties":{"source":{"type":"string","description":"Same as datasource in BigID. If not specified, will be treated as \"default\" source. Can be used to separate production environment from dev environment, etc.","example":"production","default":"default"},"channel":{"type":"string","description":"Used for logical grouping of the payloads. E.g. a topic name, a workflow, an origin of a message etc.","example":"Incoming Leads"},"payload":{"type":"string","description":"Data to scan.","example":"{\"user\": \"simon\", \"email\": \"[email protected]\"}"}}},"payloadResponse":{"required":["status"],"type":"object","properties":{"status":{"type":"string"}}},"errorMsg3":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}}}},"statusCode":{"type":"number"},"status":{"type":"string"}}},"dataItem":{"type":"object","properties":{"_id":{"type":"string"},"hashId":{"type":"string"},"att_stat":{"type":"array","items":{"type":"object","properties":{"identification_score":{"type":"number"},"overrideSureMatch":{"type":"boolean"},"stdDevPop_ids_per_value":{"type":"number"},"number_values_count":{"type":"number"},"distinct_ids_with_att_field":{"type":"number"},"distinct_ids_with_att_val":{"type":"number"},"avg_values_length":{"type":"number"},"stdDev_values_length":{"type":"number"},"max_att_pii":{"type":"number"},"avg_identities_per_value":{"type":"number"},"distinct_field_value_count":{"type":"number"},"_id":{"type":"string"},"max_att_ids":{"type":"number"},"_class":{"type":"string"}}}},"attribute":{"type":"string"},"attributeDistIdsCount":{"type":"number"},"attributeDistValsCount":{"type":"number"},"attributeFindingsCount":{"type":"number"},"attributeRecordsCount":{"type":"number"},"attributeRecordsCountNumbers":{"type":"number"},"attribute_type":{"type":"string"},"confidence_level":{"type":"number"},"count_full_match":{"type":"number"},"count_full_sure_match":{"type":"number"},"count_pos0":{"type":"number"},"count_pseudo_match":{"type":"number"},"count_sure_match":{"type":"number"},"fieldCount":{"type":"number"},"fieldFindingsCount":{"type":"number"},"fieldMaxIds":{"type":"number"},"fieldMaxPii":{"type":"number"},"fieldName":{"type":"string"},"fieldPiiCount":{"type":"number"},"findings_avg_len":{"type":"number"},"findings_full_match":{"type":"number"},"findings_pos0":{"type":"number"},"fullyQualifiedName":{"type":"string"},"records_avg_len":{"type":"number"},"scanId":{"type":"string"},"source":{"type":"string"},"totalPiiRecordsCount":{"type":"number"},"update_date":{"type":"string"},"avgRisk":{"type":"number"},"object":{"type":"string"},"owner":{"type":"string"},"partial_investigations":{"type":"array","items":{"type":"object","properties":{"idsor_value":{"type":"string"},"ds_value":{"type":"string"}}}}}},"keyValue":{"properties":{"key":{"type":"string","example":"key1","description":"Key field name - must be unique."},"value":{"type":"string","example":"value1","description":"Key field value"}}},"errorResponse2":{"properties":{"error":{"type":"string","example":"Request failed to process","description":"Error message - e.g. \"Request failed\""}},"required":["error"]},"executeResponse":{"properties":{"result":{"type":"string","example":true,"description":"Response from BigID server on invoking action."}},"required":["result"]},"putAttachmentResponse":{"properties":{"attachmentId":{"type":"string","example":"5e53fa029b086c461d395a03","description":"ID of uploaded file."}},"required":["attachmentId"]}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"responses":{"errorMsg403Rbac":{"description":"user role insufficient permissions to access the resource","content":{"schema":{"schema":{"$ref":"#/components/schemas/errorRbac403"}}}},"400BadRequest":{"description":"No channel or no Payload.","content":{"schema":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"403Forbidden":{"description":"Feature is not enabled on server.","content":{"schema":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}},"500InternalServerError":{"description":"Unknown server error.","content":{"schema":{"schema":{"$ref":"#/components/schemas/payloadResponse"}}}}},"parameters":{"tpaId":{"in":"path","name":"tpaId","schema":{"type":"string"},"required":true,"description":"Application ID as sent in the execute command."},"executionId":{"in":"path","name":"executionId","schema":{"type":"string"},"required":true,"description":"Execution ID assigned by the BigID server to this instance of the action call."}}},"x-public":true,"x-product":"bigid","x-explorer-enabled":false};
 </script>
+</html>

Latest revision as of 22:01, 26 April 2021