{"type":"api","title":"Update SaaS API DLP Rule","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/eace9409ffd11b915a153976d7c4159c4dd78740/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":["Rules","Secure Access"],"summary":"Update SaaS API DLP Rule","description":"Update the properties of the SaaS API Out-of-Band (OOB) DLP rule.","operationId":"updateSaasApiDlpRule","parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the SaaS API DLP rule.","schema":{"type":"string","format":"uuid"},"example":"123e4567-e89b-12d3-a456-426614174000","$$ref":"#/components/parameters/idSaaSApiDlpRule"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"The properties used to update a SaaS API (OOB) DLP rule.","properties":{"name":{"type":"string","maxLength":255,"description":"The name of the SaaS API OOB DLP Rule.","example":"SaaA API OOB dlp rule one","$$ref":"#/components/schemas/nameSaasApiRule"},"description":{"type":"string","description":"The meaningful description of the SaaS API OOB DLP Rule.","example":"SaaA API OOB dlp rule one","$$ref":"#/components/schemas/descriptionSaasApiRule"},"enabled":{"type":"boolean","description":"Specifies whether the system enabled the DLP rule.","example":true,"$$ref":"#/components/schemas/enabled"},"action":{"type":"string","format":"enum","default":"MONITOR","enum":["BLOCK","DELETE","MONITOR","QUARANTINE","REVOKE_SHARING"],"description":"Action to take when the rule matches.","example":"BLOCK","$$ref":"#/components/schemas/Action"},"severity":{"type":"string","format":"enum","enum":["INFO","WARNING","ALERT","CRITICAL"],"description":"Severity of the rule.","example":"INFO","$$ref":"#/components/schemas/Severity"},"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"},"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"},"labels":{"type":"array","description":"The list of label criteria.","items":{"type":"object","description":"The label criteria used when matching the DLP rule.","properties":{"labelId":{"type":"string","format":"uuid","description":"The unique identifier of the label.","example":"4dad81be-cc99-47ef-922b-cc882da5b885"},"labelType":{"type":"string","description":"The type of the label.","example":"mip"}},"$$ref":"#/components/schemas/LabelCriteria"},"$$ref":"#/components/schemas/listLabelCriteria"},"labelFileParameters":{"type":"object","description":"The labels or MIP tags applied as part of action.","properties":{"labelsData":{"type":"array","description":"The list of label identifier and type.","items":{"type":"object","description":"The label criteria used when matching the DLP rule.","properties":{"labelId":{"type":"string","format":"uuid","description":"The unique identifier of the label.","example":"4dad81be-cc99-47ef-922b-cc882da5b885"},"labelType":{"type":"string","description":"The type of the label.","example":"mip"}},"$$ref":"#/components/schemas/LabelCriteria"}},"mipData":{"type":"array","description":"The list of of Microsoft Information Protection (MIP) tags.","items":{"type":"string","example":"test"},"$$ref":"#/components/schemas/mipTags"}},"$$ref":"#/components/schemas/LabelActionParameters"},"notificationTemplateUuid":{"type":"string","format":"uuid","description":"The unique identifier of the notification template.","$$ref":"#/components/schemas/notificationTemplateUuid"},"incrementalConfig":{"type":"object","description":"The properties used to update the SaaS API (OOB) incremental configuration.","properties":{"owners":{"type":"array","description":"The list of emails for the owners.","items":{"type":"string","description":"The email for the owner."},"$$ref":"#/components/schemas/owners"},"platforms":{"type":"array","description":"The list of SaaS API OOB platform configurations.","items":{"type":"object","description":"The properties of the SaaS API OOB platform configuration.","required":["name","instances"],"properties":{"name":{"type":"string","description":"The name of the SaaS platform name, for example: office365, google, spark.","example":"office365"},"instances":{"type":"array","description":"The list of the SaaS API OOB instances.","items":{"type":"object","required":["id","applicationLabels"],"description":"The properties of the SaaS API OOB instance configuration.","properties":{"id":{"type":"integer","description":"The identifier of the cloud connector or account."},"applicationLabels":{"type":"array","description":"The list of the application labels.","example":["onedrive","sharepoint","spark"],"items":{"type":"string","description":"The label for the SaaS platform application, for example: onedrive, sharepoint, or spark.","example":"spark"}}},"$$ref":"#/components/schemas/OOBInstanceConfig"}}},"$$ref":"#/components/schemas/OOBPlatformConfig"},"$$ref":"#/components/schemas/platforms"},"exposures":{"type":"array","description":"The list of SaaS API OOB exposure configurations.","items":{"type":"object","description":"The properties of the exposure configuration grouped by platform.","required":["platform","exposure"],"properties":{"platform":{"type":"string","description":"The label for the platform.","example":"office365"},"exposure":{"type":"array","description":"The list of exposure configuration.","items":{"type":"object","description":"The properties of the exposure configuration.","properties":{"type":{"type":"string","description":"The type of exposure.","example":"PUBLIC","enum":["PUBLIC","DOMAIN","PRIVATE","FOR_SPECIFIC_USERS"]},"users":{"type":"array","description":"The list of users when required by the type of exposure.","items":{"type":"string","description":"A specific user when required by the type of exposure."}}},"$$ref":"#/components/schemas/OOBExposureItem"},"example":[{"type":"PUBLIC","users":["134ajf"]}]}},"example":{"platform":"office365","exposure":[{"type":"PUBLIC","users":["abc12"]}]},"$$ref":"#/components/schemas/OOBExposureConfig"},"$$ref":"#/components/schemas/exposures"},"revokeSharingParameters":{"type":"object","description":"The parameters controlling the revoke sharing action, which are specific to the platform.","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/RevokeSharingParameters"},"resourceIds":{"type":"array","description":"The list of resource identifiers.","items":{"type":"string","description":"An identifier of a resource."},"$$ref":"#/components/schemas/resourceIds"},"resourceTags":{"type":"array","description":"The list of resource tags.","items":{"type":"object","description":"The arbitrary properties (key/value) of the resource tag object.","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/ResourceTag"},"$$ref":"#/components/schemas/resourceTags"},"domains":{"type":"array","description":"The list of domains.","items":{"type":"string","description":"A fully qualified domain name."},"$$ref":"#/components/schemas/domains"}},"$$ref":"#/components/schemas/OOBPatchIncrementalConfig"}},"$$ref":"#/components/schemas/OOBRulePatchRequest"},"examples":{"example-request":{"summary":"Example Request","value":{"name":"Updated OOB SaaS Rule","enabled":true,"action":"QUARANTINE"},"$$ref":"#/components/examples/OOBRulePatchRequestExample"}}}}},"security":[{"oauthFlow":["policies.dlp:write"]}],"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":{"description":"The properties of the SaaS API DLP rule response.","type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the SaaS API DLP rule.","example":"a861476c-f6a7-4d15-bf59-07aff51fc807","$$ref":"#/components/schemas/idSaaSApiDlpRule"},"version":{"type":"integer","description":"The number that represents the version of the SaaS API OOB DLP rule."},"creationTime":{"type":"integer","format":"int64","description":"The date and time represented in seconds since the UNIX Epoch when the system created the SaaS API OOB DLP Rule.","$$ref":"#/components/schemas/creationTimeOOBRule"},"modificationTime":{"type":"integer","format":"int64","description":"The date and time represented in seconds since the UNIX Epoch when the system updated the SaaS API OOB DLP Rule.","$$ref":"#/components/schemas/modificationTimeOOBRule"},"name":{"type":"string","maxLength":255,"description":"The name of the SaaS API OOB DLP Rule.","example":"SaaA API OOB dlp rule one","$$ref":"#/components/schemas/nameSaasApiRule"},"description":{"type":"string","description":"The meaningful description of the SaaS API OOB DLP Rule.","example":"SaaA API OOB dlp rule one","$$ref":"#/components/schemas/descriptionSaasApiRule"},"enabled":{"type":"boolean","description":"Specifies whether the system enabled the DLP rule.","example":true,"$$ref":"#/components/schemas/enabled"},"action":{"type":"string","format":"enum","default":"MONITOR","enum":["BLOCK","DELETE","MONITOR","QUARANTINE","REVOKE_SHARING"],"description":"Action to take when the rule matches.","example":"BLOCK","$$ref":"#/components/schemas/Action"},"severity":{"type":"string","format":"enum","enum":["INFO","WARNING","ALERT","CRITICAL"],"description":"Severity of the rule.","example":"INFO","$$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"},"classifications":{"type":"array","description":"The list of data classifications associated with the rule. \nThis field is only included if `includeDetails` contains `classifications`.","items":{"type":"object","required":["id"],"description":"The ID and name of the Reference object.","properties":{"id":{"type":"string","format":"uuid","example":"4dad81be-cc99-47ef-922b-cc882da5b885","description":"The unique identifier of the Reference object."},"name":{"type":"string","description":"The name of the Reference object.","example":"Credit Card Number"}},"$$ref":"#/components/schemas/IdNameRef"},"$$ref":"#/components/schemas/DLPRuleClassifications"},"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"},"labels":{"type":"array","description":"The list of label criteria.","items":{"type":"object","description":"The label criteria used when matching the DLP rule.","properties":{"labelId":{"type":"string","format":"uuid","description":"The unique identifier of the label.","example":"4dad81be-cc99-47ef-922b-cc882da5b885"},"labelType":{"type":"string","description":"The type of the label.","example":"mip"}},"$$ref":"#/components/schemas/LabelCriteria"},"$$ref":"#/components/schemas/listLabelCriteria"},"labelFileParameters":{"type":"object","description":"The labels or MIP tags applied as part of action.","properties":{"labelsData":{"type":"array","description":"The list of label identifier and type.","items":{"type":"object","description":"The label criteria used when matching the DLP rule.","properties":{"labelId":{"type":"string","format":"uuid","description":"The unique identifier of the label.","example":"4dad81be-cc99-47ef-922b-cc882da5b885"},"labelType":{"type":"string","description":"The type of the label.","example":"mip"}},"$$ref":"#/components/schemas/LabelCriteria"}},"mipData":{"type":"array","description":"The list of of Microsoft Information Protection (MIP) tags.","items":{"type":"string","example":"test"},"$$ref":"#/components/schemas/mipTags"}},"$$ref":"#/components/schemas/LabelActionParameters"},"notificationTemplateUuid":{"type":"string","format":"uuid","description":"The unique identifier of the notification template.","$$ref":"#/components/schemas/notificationTemplateUuid"},"incrementalConfig":{"type":"object","description":"The properties of the SaaS API (OOB) incremental configuration.","required":["platforms"],"properties":{"owners":{"type":"array","description":"The list of emails for the owners.","items":{"type":"string","description":"The email for the owner."},"$$ref":"#/components/schemas/owners"},"platforms":{"type":"array","description":"The list of SaaS API OOB platform configurations.","items":{"type":"object","description":"The properties of the SaaS API OOB platform configuration.","required":["name","instances"],"properties":{"name":{"type":"string","description":"The name of the SaaS platform name, for example: office365, google, spark.","example":"office365"},"instances":{"type":"array","description":"The list of the SaaS API OOB instances.","items":{"type":"object","required":["id","applicationLabels"],"description":"The properties of the SaaS API OOB instance configuration.","properties":{"id":{"type":"integer","description":"The identifier of the cloud connector or account."},"applicationLabels":{"type":"array","description":"The list of the application labels.","example":["onedrive","sharepoint","spark"],"items":{"type":"string","description":"The label for the SaaS platform application, for example: onedrive, sharepoint, or spark.","example":"spark"}}},"$$ref":"#/components/schemas/OOBInstanceConfig"}}},"$$ref":"#/components/schemas/OOBPlatformConfig"},"$$ref":"#/components/schemas/platforms"},"exposures":{"type":"array","description":"The list of SaaS API OOB exposure configurations.","items":{"type":"object","description":"The properties of the exposure configuration grouped by platform.","required":["platform","exposure"],"properties":{"platform":{"type":"string","description":"The label for the platform.","example":"office365"},"exposure":{"type":"array","description":"The list of exposure configuration.","items":{"type":"object","description":"The properties of the exposure configuration.","properties":{"type":{"type":"string","description":"The type of exposure.","example":"PUBLIC","enum":["PUBLIC","DOMAIN","PRIVATE","FOR_SPECIFIC_USERS"]},"users":{"type":"array","description":"The list of users when required by the type of exposure.","items":{"type":"string","description":"A specific user when required by the type of exposure."}}},"$$ref":"#/components/schemas/OOBExposureItem"},"example":[{"type":"PUBLIC","users":["134ajf"]}]}},"example":{"platform":"office365","exposure":[{"type":"PUBLIC","users":["abc12"]}]},"$$ref":"#/components/schemas/OOBExposureConfig"},"$$ref":"#/components/schemas/exposures"},"revokeSharingParameters":{"type":"object","description":"The parameters controlling the revoke sharing action, which are specific to the platform.","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/RevokeSharingParameters"},"resourceIds":{"type":"array","description":"The list of resource identifiers.","items":{"type":"string","description":"An identifier of a resource."},"$$ref":"#/components/schemas/resourceIds"},"resourceTags":{"type":"array","description":"The list of resource tags.","items":{"type":"object","description":"The arbitrary properties (key/value) of the resource tag object.","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/ResourceTag"},"$$ref":"#/components/schemas/resourceTags"},"domains":{"type":"array","description":"The list of domains.","items":{"type":"string","description":"A fully qualified domain name."},"$$ref":"#/components/schemas/domains"}},"$$ref":"#/components/schemas/OOBIncrementalConfig"}},"$$ref":"#/components/schemas/OOBRuleResponse"},"examples":{"example-success":{"summary":"Example Request","value":{"id":"a82ddc7e-cd7e-4c2a-ab80-76577085fbc9","name":"Updated OOB SaaS Rule","enabled":true,"action":"QUARANTINE","severity":"ALERT","classifications":[{"id":"b1c2d3e4-f5a6-7890-bcde-fa2345678901","name":"Built-in Privacy Data Classification"}],"incrementalConfig":{"platforms":[{"name":"office365","instances":[{"id":123,"applicationLabels":["onedrive","sharepoint"]}]}],"exposures":[{"platform":"office365","exposure":[{"type":"PUBLIC"}]}]}},"$$ref":"#/components/examples/OOBRulePatchResponseExample"}}}}},"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"},"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":"updateSaasApiDlpRule","method":"patch","path":"/dlp/saasApi/rules/{id}"}}