{"type":"api","title":"Update Custom 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":"Update Custom Data Identifier","description":"Update a custom data identifier.\n","operationId":"updateCustomDataIdentifier","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the custom data identifier.","schema":{"type":"string","format":"uuid"},"example":"d2ff7f03-e713-454c-8726-b63859800c5d","$$ref":"#/components/parameters/idCustomDataIdentifier"}],"security":[{"oauthFlow":["policies.dlp:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"The properties used to update a custom data identifier.\nThe system requires that you set at least one field of the custom data identifier in the request body.","properties":{"name":{"type":"string","maxLength":255,"minLength":1,"description":"The unique name of the the custom data identifier.\n`name` is a sequence of 1–255 characters and is unique within the organization.","example":"custom identifier one","$$ref":"#/components/schemas/nameCustomIdentifier"},"description":{"type":"string","maxLength":255,"minLength":1,"description":"A meaningful description of the custom data identifier.\n`description` is a sequence of 1–255 characters.","example":"description of custom identifier","$$ref":"#/components/schemas/descriptionCustomIdentifier"},"threshold":{"type":"integer","minimum":1,"maximum":2000,"description":"The threshold value for the custom identifier.\n`threshold` is between 1 and 2000 and determines the sensitivity of the custom data identifier.","example":1,"$$ref":"#/components/schemas/thresholdCustomIdentifier"},"terms":{"type":"array","maxItems":100,"description":"The set of terms for the custom data identifier. Limited to 100 terms. Set at least one of the `terms` or `patterns` fields.\n","items":{"type":"string","minLength":1},"example":["Hello","Hike","World"],"$$ref":"#/components/schemas/termsCustomIdentifier"},"patterns":{"type":"array","maxItems":10,"description":"The set of regex patterns for the custom data identifier. Limited to 10 patterns. Each pattern must be at least three characters long and cannot start with `^ ` or end with `$`. Set at least one of the `terms` or `patterns` fields.\n","items":{"type":"string","minLength":3,"pattern":"^(?!\\^).*(?\u003c!\\$)$"},"example":["abc","test.*","hello"],"$$ref":"#/components/schemas/patternsCustomIdentifier"},"proximity":{"type":"array","maxItems":10,"description":"The set of proximity values for the custom data identifier. Limited to 10 proximity values.","items":{"type":"string"},"example":["34","Hello"],"$$ref":"#/components/schemas/proximityCustomIdentifier"},"creationTime":{"type":"integer","format":"int64","description":"The date and time represented in seconds since the UNIX Epoch when the system created the custom data identifier.","$$ref":"#/components/schemas/creationTimeCustomIdentifier"},"modificationTime":{"type":"integer","format":"int64","description":"The date and time represented in seconds since the UNIX Epoch when the system updated the custom data identifier.","$$ref":"#/components/schemas/modificationTimeCustomIdentifier"}},"$$ref":"#/components/schemas/CustomDataIdentifierUpdateRequest"},"examples":{"example-request":{"summary":"Example Request","value":{"name":"Updated Custom Identifier Example","description":"An updated example custom data identifier","threshold":10,"terms":["updated","terms"],"patterns":["\\b[A-Z]{3}\\d{5}\\b"],"proximity":["updated","proximity"]},"$$ref":"#/components/examples/CustomDataIdentifierUpdateRequestExample"}}}}},"responses":{"200":{"description":"OK","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 custom data identifier.","properties":{"id":{"type":"string","format":"uuid","description":"The unique ID of the custom data identifier."},"name":{"type":"string","maxLength":255,"minLength":1,"description":"The unique name of the the custom data identifier.\n`name` is a sequence of 1–255 characters and is unique within the organization.","example":"custom identifier one","$$ref":"#/components/schemas/nameCustomIdentifier"},"description":{"type":"string","maxLength":255,"minLength":1,"description":"A meaningful description of the custom data identifier.\n`description` is a sequence of 1–255 characters.","example":"description of custom identifier","$$ref":"#/components/schemas/descriptionCustomIdentifier"},"threshold":{"type":"integer","minimum":1,"maximum":2000,"description":"The threshold value for the custom identifier.\n`threshold` is between 1 and 2000 and determines the sensitivity of the custom data identifier.","example":1,"$$ref":"#/components/schemas/thresholdCustomIdentifier"},"terms":{"type":"array","maxItems":100,"description":"The set of terms for the custom data identifier. Limited to 100 terms. Set at least one of the `terms` or `patterns` fields.\n","items":{"type":"string","minLength":1},"example":["Hello","Hike","World"],"$$ref":"#/components/schemas/termsCustomIdentifier"},"patterns":{"type":"array","maxItems":10,"description":"The set of regex patterns for the custom data identifier. Limited to 10 patterns. Each pattern must be at least three characters long and cannot start with `^ ` or end with `$`. Set at least one of the `terms` or `patterns` fields.\n","items":{"type":"string","minLength":3,"pattern":"^(?!\\^).*(?\u003c!\\$)$"},"example":["abc","test.*","hello"],"$$ref":"#/components/schemas/patternsCustomIdentifier"},"proximity":{"type":"array","maxItems":10,"description":"The set of proximity values for the custom data identifier. Limited to 10 proximity values.","items":{"type":"string"},"example":["34","Hello"],"$$ref":"#/components/schemas/proximityCustomIdentifier"},"creationTime":{"type":"integer","format":"int64","description":"The date and time represented in seconds since the UNIX Epoch when the system created the custom data identifier.","$$ref":"#/components/schemas/creationTimeCustomIdentifier"},"modificationTime":{"type":"integer","format":"int64","description":"The date and time represented in seconds since the UNIX Epoch when the system updated the custom data identifier.","$$ref":"#/components/schemas/modificationTimeCustomIdentifier"}},"required":["id","name","description","threshold","terms","patterns","proximity","creationTime","modificationTime"],"$$ref":"#/components/schemas/CustomDataIdentifier"},"examples":{"example-success":{"summary":"Example Response","value":{"id":"b93d5005-9080-4d44-9955-02bfd2bec7a0","name":"Custom Identifier","description":"A custom data identifier for internal use.","threshold":1,"terms":["Hello","Hike"],"patterns":["%hi%"],"proximity":["34","Hello"],"creationTime":1681696840,"modificationTime":1681696840},"$$ref":"#/components/examples/CustomDataIdentifierExample"}}}}},"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"},"404":{"description":"Not Found","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/NotFoundError"},"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":"updateCustomDataIdentifier","method":"patch","path":"/dlp/custom/dataIdentifiers/{id}"}}