List Policies for Network - Cloud Security Gov

{"type":"api","title":"List Policies for Network","meta":{"id":"/apps/pubhub/media/cloud-security-gov/9ead083ce611c254ac9201d1e76003bd3d4b4b6b/d18eea70-593b-3577-bbe6-8d05a788de7b","info":{"title":"Cisco Umbrella for Government Networks API","version":"2.0.0","description":"Manage the networks in your organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Networks"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/deployments/networks-overview.md","uri":"umbrella-api-reference-networks-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrellagov.com/{basePath}","variables":{"basePath":{"default":"deployments/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrellagov.com/auth/v2/token","scopes":{"deployments.networks:write":"Write deployments networks","deployments.networks:read":"Read deployments networks"}}}}}},"spec":{"summary":"List Policies for Network","operationId":"listNetworkPolicies","tags":["Networks","Umbrella"],"description":"List the policies for a network.","security":[{"oauthFlow":["deployments.networks:read"]}],"parameters":[{"name":"networkId","schema":{"type":"integer"},"description":"The ID of the network.","in":"path","required":true,"example":13456,"$$ref":"#/components/parameters/networkId"},{"name":"type","schema":{"type":"string","enum":["dns","web"]},"in":"query","required":false,"description":"The type of the Umbrella policy.","example":"web"}],"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","readOnly":true,"properties":{"id":{"type":"integer","description":"The ID of the policy. Use the policy ID as a reference for subsequent requests.","example":134556},"name":{"type":"string","description":"The name of the policy.","example":"my policy name"},"type":{"type":"string","description":"The type of the policy.","enum":["dns","web"],"example":"dns"},"organizationId":{"type":"integer","description":"The organization ID.","example":123466},"priority":{"type":"integer","description":"A number that represents the priority of the policy in the policy list.","example":12},"isDefault":{"type":"boolean","description":"Specifies whether the policy is the default policy.","example":true},"isAppliedDirectly":{"type":"boolean","description":"Indicates if policy is applied directly to this identity.","example":true},"createdAt":{"type":"string","format":"date-time","description":"The date and time (ISO 8601 timestamp) when the policy was created.","example":"2018-06-13T16:07:07.222Z"},"modifiedAt":{"type":"string","format":"date-time","description":"The date and time (ISO 8601 timestamp) when the policy was modified.","example":"2018-06-13T16:07:07.222Z"},"uri":{"type":"string","description":"The resource URI."}},"required":["id","name","organizationId","priority","isDefault","isAppliedDirectly","createdAt","modifiedAt","uri"],"example":{"id":1234,"name":"The policy name","type":"dns","organizationId":123456,"priority":1,"isDefault":false,"isAppliedDirectly":true,"createdAt":"2020-03-09T22:18:26.625Z","modifiedAt":"2020-03-09T22:18:26.625Z","uri":"The resource URI"},"$$ref":"#/components/schemas/PolicyObject"}},"example":[{"id":1234,"name":"The policy name","type":"dns","organizationId":123456,"priority":1,"isDefault":false,"isAppliedDirectly":true,"createdAt":"2020-03-09T22:18:26.625Z","modifiedAt":"2020-03-09T22:18:26.625Z","uri":"The resource URI"}]}}},"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","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"}}}}},"$$ref":"#/components/responses/400Error"},"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","properties":{"statusCode":{"type":"integer","example":401,"description":"HTTP status code"},"error":{"type":"string","example":"Validation error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/401Error"},"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","properties":{"statusCode":{"type":"integer","example":403,"description":"HTTP status code"},"error":{"type":"string","example":"Forbidden","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/403Error"},"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","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/responses/404Error"},"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","properties":{"statusCode":{"type":"integer","example":500,"description":"HTTP status code"},"error":{"type":"string","example":"Internal error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"listNetworkPolicies","method":"get","path":"/networks/{networkId}/policies"}}