List Policies for Internal Network - Cloud Security API

{"type":"api","title":"List Policies for Internal Network","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/692c17ab-9a0e-3c46-a243-97c59f19136b","info":{"title":"Cisco Umbrella Internal Networks API","version":"2.0.0","description":"Manage the internal networks in your organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Internal Networks"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/deployments/internal-networks-overview.md","uri":"umbrella-api-reference-internal-networks-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrella.com/{basePath}","variables":{"basePath":{"default":"deployments/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrella.com/auth/v2/token","scopes":{"deployments.internalnetworks:write":"Write deployments internal networks","deployments.internalnetworks:read":"Read deployments internal networks"}}}}}},"spec":{"tags":["Internal Networks","Umbrella"],"description":"List the policies for an internal network.","summary":"List Policies for Internal Network","operationId":"listInternalNetworkPolicies","security":[{"oauthFlow":["deployments.internalnetworks:read"]}],"parameters":[{"name":"internalNetworkId","schema":{"type":"integer"},"description":"The origin ID (originId) of the internal network.","in":"path","required":true},{"name":"type","schema":{"type":"string","enum":["dns","web"]},"in":"query","required":false,"description":"Specifies the type of Umbrella policy."}],"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."},"name":{"type":"string","description":"The name that is given to the policy."},"type":{"type":"string","description":"The type of the policy.","enum":["dns","web"]},"organizationId":{"type":"integer","description":"The Umbrella organization ID."},"priority":{"type":"integer","description":"A number that represents the priority of the policy in the policy list."},"isDefault":{"type":"boolean","description":"Specifies whether the policy is the default policy."},"isAppliedDirectly":{"type":"boolean","description":"Indicates if policy is directly applied to this identity."},"createdAt":{"type":"string","format":"date-time","description":"The date and time (ISO8601 timestamp) when the policy was created.","example":"2018-06-13T16:07:07.222Z"},"modifiedAt":{"type":"string","format":"date-time","description":"The date and time (ISO8601 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":"internal network label","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":"URI for internal network"}]}}},"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 Server Error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"listInternalNetworkPolicies","method":"get","path":"/internalnetworks/{internalNetworkId}/policies"}}