DLPRulePatchRequest - Cloud Security API

{"type":"model","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":{"type":"object","description":"The properties used to update the DLP rule.","properties":{"name":{"type":"string","minLength":6,"maxLength":255,"description":"The name of the DLP rule.","example":"new SaaS API rule one","$$ref":"#/components/schemas/nameDlpRule"},"description":{"type":"string","description":"The description of the DLP rule.","example":"This rule is used for sensitive data.","$$ref":"#/components/schemas/descriptionDlpRule"},"enabled":{"type":"boolean","description":"Specifies whether the system enabled the DLP rule.","example":true,"$$ref":"#/components/schemas/enabled"},"action":{"type":"string","description":"The action taken by the system when the rule is triggered.","enum":["BLOCK","MONITOR"],"example":"MONITOR","$$ref":"#/components/schemas/action"},"severity":{"type":"string","description":"The severity level of the rule.","enum":["WARNING","ALERT"],"example":"WARNING","$$ref":"#/components/schemas/severity"},"identities":{"type":"array","description":"The list of identities associated with the DLP rule.","items":{"type":"object","description":"The properties of the identity.","properties":{"originId":{"type":"integer","description":"The unique identifier of the identity.","example":1339712162},"originTypeId":{"type":"integer","description":"The type of the identity either directory_user or directory_group.","example":7},"details":{"type":"string","description":"The additonal details about the identity described in the JSON format.","example":"{\n \"originId\": 1339712162,\n \"label\": \"Kit Kit\",\n \"originTypeId\": 7,\n \"type\": \"directory_user\"\n}"}},"$$ref":"#/components/schemas/Identity"},"$$ref":"#/components/schemas/identities"},"excludedIdentities":{"type":"array","description":"The list of identities that the system excludes from the DLP rule.","items":{"type":"object","description":"The properties of the identity.","properties":{"originId":{"type":"integer","description":"The unique identifier of the identity.","example":1339712162},"originTypeId":{"type":"integer","description":"The type of the identity either directory_user or directory_group.","example":7},"details":{"type":"string","description":"The additonal details about the identity described in the JSON format.","example":"{\n \"originId\": 1339712162,\n \"label\": \"Kit Kit\",\n \"originTypeId\": 7,\n \"type\": \"directory_user\"\n}"}},"$$ref":"#/components/schemas/Identity"},"$$ref":"#/components/schemas/excludedIdentities"},"classifications":{"type":"array","description":"The list of the data classifications associated with the DLP rule.","items":{"type":"string","format":"uuid","description":"The unique identifier of the data classification.","example":"83374fac-0543-4f77-80e6-6359a67cfc96"},"$$ref":"#/components/schemas/classificationsCreate"},"allDestinationsScope":{"type":"string","format":"enum","enum":["NONE","FILES_AND_FORMS","FILES_AND_VETTED_APPS_FORMS"],"description":"The scope of all of the destinations for the DLP rule.","$$ref":"#/components/schemas/allDestinationsScope"},"destinations":{"type":"object","description":"Details of a destination.","properties":{"type":{"type":"string","description":"Type of the destination (e.g., url, domain).","example":"url"},"address":{"type":"string","description":"Address of the destination.","example":"http://example.com"}},"$$ref":"#/components/schemas/Destination"},"destinationListIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"The list of IDs for the destination lists associated with the DLP rule.","$$ref":"#/components/schemas/destinationListIds"},"excludedDestinationListIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"The list of IDs for the destination lists that the system excludes from the DLP rule.","$$ref":"#/components/schemas/excludedDestinationListIds"},"applications":{"type":"array","items":{"type":"object","required":["id"],"description":"Details of an application.","properties":{"id":{"type":"integer","format":"int64","description":"Unique application identifier.","example":75},"trafficDirection":{"type":"string","format":"enum","enum":["BOTH","REQUEST","RESPONSE","INTERNAL"],"description":"Traffic direction for the application or resource.","$$ref":"#/components/schemas/TrafficDirectionType"}},"$$ref":"#/components/schemas/Application"},"description":"The list of applications associated with the DLP rule.","$$ref":"#/components/schemas/applications"},"applicationIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"The list of IDs for applications associated with the DLP rule.","$$ref":"#/components/schemas/applicationIds"},"applicationCategories":{"type":"array","items":{"type":"object","required":["id"],"description":"Details of an application category.","properties":{"id":{"type":"integer","format":"int64","description":"Unique application category identifier.","example":10},"trafficDirection":{"type":"string","format":"enum","enum":["BOTH","REQUEST","RESPONSE","INTERNAL"],"description":"Traffic direction for the application or resource.","$$ref":"#/components/schemas/TrafficDirectionType"}},"$$ref":"#/components/schemas/ApplicationCategory"},"description":"The list of application categories associated with the DLP rule.","$$ref":"#/components/schemas/applicationCategories"},"applicationCategoryIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"The list of IDs for the application categories associated with the DLP rule.","$$ref":"#/components/schemas/applicationCategoryIds"},"privateResources":{"type":"array","items":{"type":"object","required":["id"],"description":"Details of a private resource.","properties":{"id":{"type":"integer","format":"int64","description":"Unique private resource identifier.","example":10},"trafficDirection":{"type":"string","format":"enum","enum":["BOTH","REQUEST","RESPONSE","INTERNAL"],"description":"Traffic direction for the application or resource.","$$ref":"#/components/schemas/TrafficDirectionType"}},"$$ref":"#/components/schemas/PrivateResource"},"description":"The list of private resources associated with the DLP rule.","$$ref":"#/components/schemas/privateResources"},"excludedPrivateResources":{"type":"array","items":{"type":"object","required":["id"],"description":"Details of a private resource.","properties":{"id":{"type":"integer","format":"int64","description":"Unique private resource identifier.","example":10},"trafficDirection":{"type":"string","format":"enum","enum":["BOTH","REQUEST","RESPONSE","INTERNAL"],"description":"Traffic direction for the application or resource.","$$ref":"#/components/schemas/TrafficDirectionType"}},"$$ref":"#/components/schemas/PrivateResource"},"description":"The list of private resources to exclude from the DLP rule.","$$ref":"#/components/schemas/excludedPrivateResources"},"privateResourceGroups":{"type":"array","items":{"type":"object","required":["id"],"description":"Priovate Resource Group details","properties":{"id":{"type":"integer","format":"int64","description":"Unique private resource identifier.","example":10},"trafficDirection":{"type":"string","format":"enum","enum":["BOTH","REQUEST","RESPONSE","INTERNAL"],"description":"Traffic direction for the application or resource.","$$ref":"#/components/schemas/TrafficDirectionType"}},"$$ref":"#/components/schemas/PrivateResourceGroup"},"description":"The list of private resource groups associated with the DLP rule.","$$ref":"#/components/schemas/privateResourceGroups"},"excludedPrivateResourceGroups":{"type":"array","items":{"type":"object","required":["id"],"description":"Priovate Resource Group details","properties":{"id":{"type":"integer","format":"int64","description":"Unique private resource identifier.","example":10},"trafficDirection":{"type":"string","format":"enum","enum":["BOTH","REQUEST","RESPONSE","INTERNAL"],"description":"Traffic direction for the application or resource.","$$ref":"#/components/schemas/TrafficDirectionType"}},"$$ref":"#/components/schemas/PrivateResourceGroup"},"description":"List of private resource groups to be excluded from the rule.","$$ref":"#/components/schemas/excludedPrivateResourceGroups"},"scannableContexts":{"type":"array","description":"The list of scannable contexts.","items":{"type":"string","format":"enum","enum":["CONTENT","FILENAME"],"description":"The scannable context where the rule applies.","example":"CONTENT","$$ref":"#/components/schemas/ScannableContext"},"example":["CONTENT"],"$$ref":"#/components/schemas/scannableContexts"},"fileSizeFrom":{"type":"integer","description":"The minimum file size in KB for the system to apply the DLP rule.","example":1024,"$$ref":"#/components/schemas/fileSizeFrom"},"fileSizeTo":{"type":"integer","description":"The maximum file size in KB for the system to apply the DLP rule.","example":10485760,"$$ref":"#/components/schemas/fileSizeTo"},"notifyOwner":{"type":"boolean","description":"Specifies whether the system notifies the owner when the rule is triggered.","example":false,"$$ref":"#/components/schemas/notifyOwner"},"notifyActor":{"type":"boolean","description":"Specifies whether the system notifies the actor when the rule is triggered.","example":false,"$$ref":"#/components/schemas/notifyActor"},"mipTags":{"type":"array","description":"The list of of Microsoft Information Protection (MIP) tags.","items":{"type":"string","example":"test"},"$$ref":"#/components/schemas/mipTags"}},"$$ref":"#/components/schemas/DLPRulePatchRequest","title":"DLPRulePatchRequest"}}