Create IDM Data Identifier - Cloud Security API

{"type":"api","title":"Create IDM Data Identifier","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/83e8a10367d157243cd1c3e478b807cb81262a3d/8d86edee-12fb-373d-b1e1-d0caf3a16e2d","info":{"title":"Data Loss Prevention Policy Rules API","description":"Manage the Data Loss Prevention (DLP) rules, classifications, and data identifiers.","version":"1.0.0","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"DataIdentifiers","description":"Operations related to DLP data identifiers."},{"name":"Classifications","description":"Operations related to DLP classifications."},{"name":"Rules","description":"Operations related to DLP rules."},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/policies/dlp-rules-overview.md","uri":"secure-access-api-reference-dlp-policy-rules-overview"}},"openapi":"3.0.3","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"policies/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"policies.dlp:read":"Read dlp classifications, data identifiers, and rules","policies.dlp:write":"Write dlp classifications, data identifiers, and rules"}}}}}},"spec":{"tags":["DataIdentifiers","Secure Access"],"summary":"Create IDM Data Identifier","description":"Create an Indexed Document Match (IDM)) data identifier.\nYou can use the IDM data identifier for document fingerprinting and matching.\n","operationId":"createIDMDataIdentifier","security":[{"oauthFlow":["policies.dlp:write"]}],"requestBody":{"required":true,"description":"The properties of the IDM data identifier.","content":{"application/json":{"schema":{"type":"object","description":"The properties used to create an Indexed Document Match (IDM) data identifier.","properties":{"name":{"type":"string","maxLength":255,"description":"The name of the Indexed Document Match (IDM) data identifier.","example":"Financial Documents IDM","$$ref":"#/components/schemas/idmName"},"description":{"type":"string","maxLength":255,"description":"The description of the IDM data identifier.","example":"IDM identifier for financial document matching","$$ref":"#/components/schemas/idmDescription"},"idmAccuracy":{"type":"string","description":"The accuracy level for the IDM identifier.","enum":["LOW","MEDIUM","HIGH"],"example":"HIGH","$$ref":"#/components/schemas/idmAccuracy"}},"required":["name","idmAccuracy"],"example":{"name":"name of idm data identifier","idmAccuracy":"MEDIUM"},"$$ref":"#/components/schemas/IDMIdentifierCreateRequest"},"examples":{"example-create-request":{"summary":"Example Request","value":{"name":"Financial Documents IDM","description":"IDM identifier for financial document matching","idmAccuracy":"HIGH"},"$$ref":"#/components/examples/IDMDataIdentifierCreateRequestExample"}}}}},"responses":{"201":{"description":"Created","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the Indexed Document Match (IDM) data identifier.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the IDM data identifier"},"name":{"type":"string","maxLength":255,"description":"The name of the Indexed Document Match (IDM) data identifier.","example":"Financial Documents IDM","$$ref":"#/components/schemas/idmName"},"description":{"type":"string","maxLength":255,"description":"The description of the IDM data identifier.","example":"IDM identifier for financial document matching","$$ref":"#/components/schemas/idmDescription"},"modificationTimeIDMIdentifier":{"type":"integer","format":"int64","description":"The date and time represented in seconds since the UNIX Epoch when the system updated the IDM data identifier.","$$ref":"#/components/schemas/modificationTimeIDMIdentifier"},"creationTimeIDMIdentifier":{"type":"integer","format":"int64","description":"The date and time represented in seconds since the UNIX Epoch when the system created the IDM data identifier.","$$ref":"#/components/schemas/creationTimeIDMIdentifier"},"idmAccuracy":{"type":"string","description":"The accuracy level for the IDM identifier.","enum":["LOW","MEDIUM","HIGH"],"example":"HIGH","$$ref":"#/components/schemas/idmAccuracy"},"isActive":{"type":"boolean","description":"Indicates whether the IDM data identifier is active.","example":false},"numberOfIndexedFiles":{"type":"integer","format":"int64","description":"The number of indexed files associated with the IDM data identifier.","example":1000},"uploadedIdmSize":{"type":"integer","format":"int64","description":"The size in bytes of the uploaded IDM data identifier.","example":10000},"documents":{"type":"array","description":"The collection of file metadata documents associated with the IDM data identifier.","items":{"type":"object","description":"The properties of the metadata for the files associated with Indexed Document Match (IDM) identifiers.","properties":{"fileName":{"type":"string","description":"The name of the file."},"fileSize":{"type":"integer","format":"int64","description":"The size of the file in bytes."},"fileType":{"type":"string","description":"The type or format of the file."},"uploadedDate":{"type":"string","format":"date-time","description":"The date and time when the file was uploaded. Specify an ISO 8601-formatted timestamp."},"documentId":{"type":"string","description":"The unique identifier for the document."}},"$$ref":"#/components/schemas/FileMetadata"}}},"required":["id","name","description","modificationTime","creationTime","isActive","lowSpecificity","numberOfIndexedFiles","uploadedIdmSize"],"$$ref":"#/components/schemas/IDMDataIdentifierResponse"},"examples":{"example-success":{"summary":"Example Response","value":{"id":"d2ff7f03-e713-454c-8726-b63859800c5d","name":"Financial Documents IDM","description":"IDM identifier for financial document matching","modificationTime":1681696840,"creationTime":1681696840,"idmAccuracy":"HIGH","isActive":false,"lowSpecificity":false,"numberOfIndexedFiles":1,"uploadedIdmSize":204800},"$$ref":"#/components/examples/IDMDataIdentifierExample"}}}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Standard error response format","properties":{"error":{"type":"string","description":"Error description","example":"Something went wrong please"},"statusCode":{"type":"integer","description":"HTTP status code","example":400},"txId":{"type":"string","description":"Unique transaction ID for tracing the request","example":"a82ddc7e-cd7e-4c2a-ab80-76577085fbc9"}},"$$ref":"#/components/schemas/ApiErrorResponse"}}},"$$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Standard error response format","properties":{"error":{"type":"string","description":"Error description","example":"Something went wrong please"},"statusCode":{"type":"integer","description":"HTTP status code","example":400},"txId":{"type":"string","description":"Unique transaction ID for tracing the request","example":"a82ddc7e-cd7e-4c2a-ab80-76577085fbc9"}},"$$ref":"#/components/schemas/ApiErrorResponse"}}},"$$ref":"#/components/responses/UnauthorizedError"},"403":{"description":"Forbidden","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Standard error response format","properties":{"error":{"type":"string","description":"Error description","example":"Something went wrong please"},"statusCode":{"type":"integer","description":"HTTP status code","example":400},"txId":{"type":"string","description":"Unique transaction ID for tracing the request","example":"a82ddc7e-cd7e-4c2a-ab80-76577085fbc9"}},"$$ref":"#/components/schemas/ApiErrorResponse"}}},"$$ref":"#/components/responses/ForbiddenError"},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Standard error response format","properties":{"error":{"type":"string","description":"Error description","example":"Something went wrong please"},"statusCode":{"type":"integer","description":"HTTP status code","example":400},"txId":{"type":"string","description":"Unique transaction ID for tracing the request","example":"a82ddc7e-cd7e-4c2a-ab80-76577085fbc9"}},"$$ref":"#/components/schemas/ApiErrorResponse"}}},"$$ref":"#/components/responses/InternalServerError"}},"__originalOperationId":"createIDMDataIdentifier","method":"post","path":"/dlp/idm/dataIdentifiers"}}