List Policies - Cloud Security Gov

{"type":"api","title":"List Policies","meta":{"id":"/apps/pubhub/media/cloud-security-gov/9ead083ce611c254ac9201d1e76003bd3d4b4b6b/6a0a4614-87f6-3fee-b712-6f6612fb04be","info":{"title":"Cisco Umbrella for Government Deployments Policies API","version":"2.0.0","description":"Manage the policies for the deployments in your organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Policy","description":"Umbrella Policy Management"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/deployments/policies-overview.md","uri":"umbrella-api-reference-deployment-policies-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrellagov.com/{basePath}","variables":{"basePath":{"default":"deployments/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrellagov.com/auth/v2/token","scopes":{"deployments.policies:write":"Write deployments policies","deployments.policies:read":"Read deployments policies"}}}}}},"spec":{"summary":"List Policies","operationId":"listPolicies","tags":["Policy","Umbrella"],"description":"List the Umbrella policies. You can filter by policy type.\nIf you do not specify a policy type, Umbrella returns the DNS policies.","security":[{"oauthFlow":["deployments.policies:read"]}],"parameters":[{"name":"page","in":"query","description":"The number of a page in the collection.","required":false,"schema":{"default":1,"type":"integer","format":"int32","minimum":1},"$$ref":"#/components/parameters/paginationPageParam"},{"name":"limit","in":"query","description":"The number of records from the collection to return on the page.","required":false,"schema":{"default":100,"type":"integer","format":"int32","minimum":1,"maximum":100},"$$ref":"#/components/parameters/paginationLimitParam"},{"name":"type","in":"query","description":"The type of the policy (`dns` or `web`).","required":false,"schema":{"default":"dns","enum":["dns","web"],"type":"string"},"example":"web","$$ref":"#/components/parameters/policyTypeParam"}],"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","minProperties":6,"required":["policyId","organizationId","name","priority","createdAt","isDefault"],"properties":{"policyId":{"type":"integer","description":"The unique policy ID.","minimum":1},"organizationId":{"type":"integer","example":1234,"minimum":1},"name":{"type":"string","description":"The label for the policy.","example":"ApiDemoPolicy","minLength":1},"priority":{"type":"integer","description":"The priority of the policy.","minimum":0},"createdAt":{"type":"string","format":"date-time","example":"2017-09-22T04:18:51.000Z","description":"The time and date (ISO 8601-formatted timestamp) when the policy was created."},"isDefault":{"type":"boolean","example":true,"description":"Specified whether the policy is the default."}},"$$ref":"#/components/schemas/PolicyStub"},"$$ref":"#/components/schemas/PolicyList"},"example":[{"policyId":1,"organizationId":1234,"name":"ApiDemoPolicy","priority":1,"createdAt":"2017-09-22T04:18:51.000Z","isDefault":false}]}}},"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":{"description":"Bad Request","type":"object","properties":{"statusCode":{"type":"integer","example":400,"description":"HTTP status code"},"error":{"type":"string","example":"Validation Error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"},"validationErrors":{"type":"object","properties":{"someProperty":{"type":"string","example":"must not be empty","description":"the name of the property failing validation."}}}},"$$ref":"#/components/schemas/BadRequestError"}}},"$$ref":"#/components/responses/InvalidRequest"},"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":{"description":"Unauthorized","type":"object","properties":{"statusCode":{"type":"integer","example":401,"description":"HTTP status code"},"error":{"type":"string","example":"Unauthorized","description":"The authorization header is missing or the token is unauthorized"},"message":{"type":"string","description":"Detailed error message"}},"$$ref":"#/components/schemas/UnauthorizedError"}}},"$$ref":"#/components/responses/Unauthorized"},"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":{"description":"Forbidden","type":"object","properties":{"statusCode":{"type":"integer","example":403,"description":"HTTP status code"},"error":{"type":"string","example":"Forbidden, Invalid authentication credentials","description":"a brief description of the error"},"message":{"type":"string","description":"Detailed error message"}},"$$ref":"#/components/schemas/ForbiddenError"}}},"$$ref":"#/components/responses/Forbidden"},"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":{"description":"Not Found","type":"object","properties":{"statusCode":{"type":"integer","example":404,"description":"HTTP status code"},"error":{"type":"string","example":"Not Found","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}},"$$ref":"#/components/schemas/NotFoundError"}}},"$$ref":"#/components/responses/NotFound"},"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":{"description":"Internal Server Error","type":"object","properties":{"statusCode":{"type":"integer","example":500,"description":"HTTP status code"},"error":{"type":"string","example":"Internal Server Error","description":"The server has an internal error and could not process the request."},"message":{"type":"string","description":"Detailed error message"}},"$$ref":"#/components/schemas/ServerError"}}},"$$ref":"#/components/responses/ServerErr"}},"__originalOperationId":"listPolicies","method":"get","path":"/policies"}}