List SaaS API DLP Rules - Cloud Security API

{"type":"api","title":"List SaaS API DLP Rules","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":["Rules","Secure Access"],"summary":"List SaaS API DLP Rules","description":"List the SaaS API (Out-of-Band) DLP rules.","operationId":"getAllSaasApiDlpRules","parameters":[{"name":"name","in":"query","required":false,"description":"The name of the SaaS API DLP rule. The value of `name` is case insensitive and the system allows partial matches.","schema":{"type":"string"},"example":"name saas api dlp rules","$$ref":"#/components/parameters/nameSaasAPIDlpRules"},{"name":"limit","in":"query","description":"The number of records returned by the system in the response. The maximum number of items that are allowed in the response is 100.\nThe default number of items returned in the response is 50.","required":false,"schema":{"type":"integer","default":50,"format":"int32","minimum":1,"maximum":100},"example":20,"$$ref":"#/components/parameters/limit"},{"name":"offset","in":"query","required":false,"description":"The numeric offset into the collection used for pagination. Set the `offset` to skip the number of records from the collection in the response. The default value is `0`.\n","schema":{"type":"integer","format":"int32","default":0},"$$ref":"#/components/parameters/offset"},{"name":"fields","in":"query","required":false,"description":"A comma-separated list of fields to include in the response.\n","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["id","name","description","enabled","action","severity","type","secureIcapEnabled","identities","applications","classifications","scannableContexts","mipTags"]},"default":["id","name"],"example":["id","name"]},"$$ref":"#/components/parameters/ruleFields"}],"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":"array","items":{"type":"object","description":"The properties of a DLP rule.","properties":{"id":{"type":"string","description":"The unique identifier of the DLP rule.","example":"a861476c-f6a7-4d15-bf59-07aff51fc807","$$ref":"#/components/schemas/idDlpRule"},"name":{"type":"string","minLength":6,"maxLength":255,"description":"The name of the DLP rule.","example":"new SaaS API rule one","$$ref":"#/components/schemas/nameDlpRule"}},"$$ref":"#/components/schemas/DLPRuleListItem"}},"examples":{"example-success":{"summary":"Example Response","value":[{"id":"d1e2f3a4-b5c6-7890-abcd-ef1234567890","name":"Default DLP Rule"},{"id":"e1f2a3b4-c5d6-7890-bcde-fa2345678901","name":"Custom DLP Rule"}],"$$ref":"#/components/examples/DLPRuleListExample"}}}}},"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":"getAllSaasApiDlpRules","method":"get","path":"/dlp/saasApi/rules"}}