Get EDM Data Identifier - Cloud Security API

{"type":"api","title":"Get EDM 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":"Get EDM Data Identifier","description":"Get the properties of a specific Exact Data Match (EDM) data identifier.","operationId":"getEDM","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the Exact Data Match (EDM) data identifier.","schema":{"type":"string","format":"uuid"},"example":"123e4567-e89b-12d3-a456-426614174000","$$ref":"#/components/parameters/idEdm"}],"security":[{"oauthFlow":["policies.dlp:read"]}],"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 Exact Data Match (EDM) data identifier.","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the EDM data identifier."},"name":{"type":"string","maxLength":255,"description":"The name of the EDM data identifier.","example":"Test EDM for Integration 2122","$$ref":"#/components/schemas/nameEdm"},"description":{"type":"string","maxLength":255,"description":"The description of the EDM data identifier.","example":"Description 1","$$ref":"#/components/schemas/descriptionEdm"},"creationTime":{"type":"integer","format":"int64","description":"The date and time represented in seconds since the UNIX Epoch when the system created the EDM data identifier.","$$ref":"#/components/schemas/creationEDMIdentifier"},"modificationTime":{"type":"integer","format":"int64","description":"The date and time represented in seconds since the UNIX Epoch when the system updated the EDM data identifier.","$$ref":"#/components/schemas/modificationEDMIdentifier"},"columns":{"type":"array","description":"The list of columns for the Exact Data Match (EDM) identifier.","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the column.","example":"1234565a","$$ref":"#/components/schemas/idColumn"},"name":{"type":"string","description":"The name of the column.","example":"sample column name","$$ref":"#/components/schemas/nameColumn"},"samples":{"type":"array","description":"The list of sample data for the column.","items":{"type":"string"},"$$ref":"#/components/schemas/samplesColumn"},"primary":{"type":"boolean","description":"Specifies whether the column is the primary column.","$$ref":"#/components/schemas/primaryColumn"},"typeId":{"type":"string","format":"uuid","description":"The ID of the type for the column.","$$ref":"#/components/schemas/typeIdColumn"}},"required":["name","samples","primary","typeId"]},"$$ref":"#/components/schemas/columnsEdmWithId"},"minimumNumberOfMatches":{"type":"integer","description":"The minimum number of matches required for Exact Data Match (EDM).","example":2,"$$ref":"#/components/schemas/minimumNumberOfMatchesEdm"},"isActive":{"type":"boolean","description":"Specifies whether the EDM data identifier is active."}},"required":["id","name","description","creationTime","modificationTime","columns","minimumNumberOfMatches","isActive"],"$$ref":"#/components/schemas/EDMIdentifierResponse"},"examples":{"example-success":{"summary":"Example Response","value":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Test EDM for Integration 2122","description":"Description 1","creationTime":1752577698,"modificationTime":1752577698,"isActive":false,"minimumNumberOfMatches":2,"columns":[{"typeId":"be05dc1c-6210-423e-8b4e-f3bdb1d4033e","id":"1b2d1753-99ff-4702-ba5d-522c759104dc","name":"SSN","primary":true,"samples":["113011111","248257990","363265019"]},{"typeId":"5cb289dc-2c6a-4999-9e7b-f7f363749c8a","id":"2922b359-56ef-473b-8635-aeece07a2a7d","name":"Email","primary":false,"samples":["r_t@gmail.com","r_ppp@gmail.com","r_opop@gmail.com"]}]},"$$ref":"#/components/examples/EDMDataIdentifierResponseExample"}}}}},"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":"getEDM","method":"get","path":"/dlp/edm/dataIdentifiers/{id}"}}