Create Custom DLP Classification - Cloud Security API

{"type":"api","title":"Create Custom DLP Classification","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":["Classifications","Secure Access"],"operationId":"createCustomDlpClassification","summary":"Create Custom DLP Classification","description":"Create a custom DLP classification.","security":[{"oauthFlow":["policies.dlp:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","classifierEvaluationStrategy","dataIdentifiers"],"description":"Request body for creating a new data classification.","properties":{"name":{"type":"string","minLength":6,"maxLength":255,"description":"The name of the data classification.","example":"data classification","$$ref":"#/components/schemas/nameClassification"},"description":{"type":"string","description":"The detailed description of the classification.","example":"A built-in classification for specific use cases.","$$ref":"#/components/schemas/descriptionDataClassification"},"classifierEvaluationStrategy":{"type":"string","format":"enum","enum":["all","any"],"description":"The strategy for evaluating the classifiers.","example":"all","$$ref":"#/components/schemas/ClassifierEvaluationStrategy"},"dataIdentifiers":{"type":"array","minimum":1,"description":"The list of IDs for the data classifiers associated with the classification.","items":{"type":"string","format":"uuid","description":"DataIdentifiers Id for inclusion","example":"a82ddc7e-cd7e-4c2a-ab80-76577085fbc9"},"example":["a82ddc7e-cd7e-4c2a-ab80-76577085fbc9"],"$$ref":"#/components/schemas/dataIdentifiersClassification"},"excludedDataIdentifiers":{"type":"array","description":"The list of IDs for excluded classifiers associated with the classification.","items":{"type":"string","format":"uuid","description":"DataIdentifier Id for exclusion","example":"a82ddc7e-cd7e-4c2a-ab80-76577085fbc9"},"example":["a82ddc7e-cd7e-4c2a-ab80-76577085fbc9"],"$$ref":"#/components/schemas/excludedDataIdentifiersClassification"}},"$$ref":"#/components/schemas/DataClassificationCreateRequest"},"examples":{"example-request":{"summary":"Example Request","value":{"name":"Custom Financial Data Classification","description":"A custom classification for financial data.","dataIdentifiers":["223e4567-e89b-12d3-a456-426614174002","b93d5005-9080-4d44-9955-02bfd2bec7a0"],"excludedDataIdentifiers":["123e4567-e89b-12d3-a456-426614174001"],"classifierEvaluationStrategy":"all"},"$$ref":"#/components/examples/DataClassificationCreateRequestExample"}}}}},"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","required":["id","name","type"],"description":"Details of a data classification.","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the classification.","example":"12345678-abcd-4ef0-9123-456789abcdef","$$ref":"#/components/schemas/idDataClassification"},"name":{"type":"string","minLength":6,"maxLength":255,"description":"The name of the classification.","example":"Classification Name","$$ref":"#/components/schemas/nameDataClassification"},"type":{"type":"string","format":"enum","enum":["built-in","built-in-ai-defense","custom","custom-ai-defense"],"description":"The type of the classification.","$$ref":"#/components/schemas/DataClassificationType"},"description":{"type":"string","description":"The detailed description of the classification.","example":"A built-in classification for specific use cases.","$$ref":"#/components/schemas/descriptionDataClassification"},"classifierEvaluationStrategy":{"type":"string","format":"enum","enum":["all","any"],"description":"The strategy for evaluating the classifiers.","example":"all","$$ref":"#/components/schemas/ClassifierEvaluationStrategy"},"dataIdentifiers":{"type":"array","minimum":1,"description":"The list of IDs for the data classifiers associated with the classification.","items":{"type":"string","format":"uuid","description":"DataIdentifiers Id for inclusion","example":"a82ddc7e-cd7e-4c2a-ab80-76577085fbc9"},"example":["a82ddc7e-cd7e-4c2a-ab80-76577085fbc9"],"$$ref":"#/components/schemas/dataIdentifiersClassification"},"excludedDataIdentifiers":{"type":"array","description":"The list of IDs for excluded classifiers associated with the classification.","items":{"type":"string","format":"uuid","description":"DataIdentifier Id for exclusion","example":"a82ddc7e-cd7e-4c2a-ab80-76577085fbc9"},"example":["a82ddc7e-cd7e-4c2a-ab80-76577085fbc9"],"$$ref":"#/components/schemas/excludedDataIdentifiersClassification"},"creationTime":{"type":"integer","format":"int64","description":"The date and time represented in seconds since the UNIX Epoch when the system created the data classification.","$$ref":"#/components/schemas/creationTimeDataClassification"},"modificationTime":{"type":"integer","format":"int64","description":"The date and time represented in seconds since the UNIX Epoch when the system updated the data classification.","$$ref":"#/components/schemas/modificationTimeDataClassification"}},"$$ref":"#/components/schemas/DataClassification"},"examples":{"example-success":{"summary":"Example Response","value":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","name":"Built-in Privacy Data Classification (US)","description":"A built-in classification for US privacy data.","type":"built-in","creationTime":1759400302967,"modificationTime":1759400302967,"dataIdentifiers":["123e4567-e89b-12d3-a456-426614174001"],"excludedDataIdentifiers":[],"classifierEvaluationStrategy":"any"},"$$ref":"#/components/examples/DataClassificationExample"}}}}},"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"},"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":"createCustomDlpClassification","method":"post","path":"/dlp/custom/classifications"}}