List SWG Override Device Settings - Cloud Security API

{"type":"api","title":"List SWG Override Device Settings","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/d2a1854d5c0ed9069a7f0bc54a9b813f3075ddc9/7e0efc2b-8c6a-374b-ad2f-31007d7fa1b4","info":{"version":"2.0.0","title":"Cisco Umbrella Secure Web Gateway Device Settings API","description":"Manage the Secure Web Gateway (SWG) settings for the devices in an organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"SWG Device Settings","description":"Secure Web Gateway (SWG) device settings"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/deployments/umbrella-swg-devices-overview.md","uri":"umbrella-api-reference-swg-devices-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.devices.swg:write":"Write SWG device settings","deployments.devices.swg:read":"Read SWG device settings"}}}}}},"spec":{"tags":["SWG Device Settings","Umbrella"],"description":"List the Secure Web Gateway (SWG) override setting for devices in the organization.","summary":"List SWG Override Device Settings","operationId":"listSecureWebGatewayDeviceSettings","security":[{"oauthFlow":["deployments.devices.swg:read"]}],"requestBody":{"description":"Provide a list of origin ID for the devices in the organization. The list can contain 1–100 origin IDs.","content":{"application/json":{"schema":{"type":"object","description":"The `originIds` property.","required":["originIds"],"properties":{"originIds":{"type":"array","description":"The list of origin IDs. The list can contain 1–100 origin IDs.","items":{"description":"The origin ID of the device.","type":"integer","format":"int64","example":12321231,"$$ref":"#/components/schemas/originId"}}}},"example":{"originIds":[12321231,123134314]}}}},"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","description":"The list of Secure Web Gateway (SWG) settings for the devices in the organization.","items":{"type":"object","description":"The properties of the secure web gateway settings for the device.","required":["originId","name","value","modifiedAt"],"properties":{"originId":{"description":"The origin ID of the device.","type":"integer","format":"int64","example":12321231,"$$ref":"#/components/schemas/originId"},"name":{"type":"string","description":"The name of the device setting.","example":"SWG enabled device"},"value":{"type":"string","enum":["0","1"],"description":"Specifies whether to enable the Secure Web Gateway (SWG) device settings.\nValid values are: `0` or `1` where `1` indicates enable.","example":"1","$$ref":"#/components/schemas/value"},"modifiedAt":{"type":"string","description":"The date and time when the settings on the device were modified. The timestamp is in the ISO 8601 date format.","format":"iso-date-time","example":"2021-04-26 13:12:11"}}},"example":[{"originId":124131441,"name":"SWGEnabled","value":"1","modifiedAt":"2021-04-26 13:12:11"},{"originId":124131442,"name":"SWG-not-enabled","value":"0","modifiedAt":"2023-04-26 13:12:11"}],"$$ref":"#/components/schemas/ListSWGDeviceSettings"},"example":[{"originId":124131441,"name":"SWG-enabled","value":"1","modifiedAt":"2021-04-26 13:12:11"},{"originId":124131442,"name":"SWG-not-enabled","value":"0","modifiedAt":"2023-04-26 13:12:11"}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The information about the error condition.","required":["Error"],"properties":{"Error":{"type":"string","description":"The message associated with the error condition."}}},"example":{"Error":"Invalid request"}}},"$$ref":"#/components/responses/400ErrorSingle"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","description":"The information about the error condition.","properties":{"message":{"type":"string","description":"The message associated with the error condition."},"error":{"type":"string","description":"The status code for the error condition."}},"$$ref":"#/components/schemas/error"},"example":{"message":"Unauthorized request"}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","description":"The information about the error condition.","properties":{"message":{"type":"string","description":"The message associated with the error condition."},"error":{"type":"string","description":"The status code for the error condition."}},"$$ref":"#/components/schemas/error"},"example":{"message":"Forbidden"}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","description":"The information about the error condition.","required":["Error"],"properties":{"Error":{"type":"string","description":"The message associated with the error condition."}}},"example":{"Error":"Not Found"}}},"$$ref":"#/components/responses/404ErrorSingle"},"413":{"description":"Content Too Large","content":{"application/json":{"schema":{"type":"object","description":"The list of `originIds` contains more than 100 origin IDs.","required":["Error"],"properties":{"Error":{"type":"string","description":"Invalid Request: orginIds in the request exceeded max limit - 100.","example":"Invalid Request: orginIds in the request exceeded max limit - 100."}}},"example":{"Error":"Invalid Request: orginIds in the request exceeded max limit - 100."}}},"$$ref":"#/components/responses/413ErrorSingle"},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","description":"The information about the error condition.","properties":{"message":{"type":"string","description":"The message associated with the error condition."},"error":{"type":"string","description":"The status code for the error condition."}},"$$ref":"#/components/schemas/error"},"example":{"message":"Too many requests. Retry request."}}},"$$ref":"#/components/responses/429Error"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","description":"The information about the error condition.","required":["Error"],"properties":{"Error":{"type":"string","description":"The message associated with the error condition."}}},"example":{"Error":"Internal server error"}}},"$$ref":"#/components/responses/500ErrorSingle"}},"__originalOperationId":"listSecureWebGatewayDeviceSettings","method":"post","path":"/deviceSettings/SWGEnabled/list"}}