List Roaming Computers - Secure Access for China

{"type":"api","title":"List Roaming Computers","meta":{"id":"/apps/pubhub/media/secure-access-for-china/318ddd7717f4865220eea69b480686bd569e1a76/0283533d-6c4c-313f-8ad7-bc34026e0e53","info":{"title":"Cisco Secure Access China Roaming Computers API","version":"2.0.0","description":"Manage the roaming computers in the organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Roaming Computers"},{"name":"Organization Information"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"reference/deployments/roaming-computers-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://cisco.secureaccesschina.cn/{basePath}","variables":{"basePath":{"default":"deployments/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"Client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.ciscosecureaccess.cn/auth/v2/token","scopes":{"deployments.roamingcomputers:write":"Write deployments roaming computers","deployments.roamingcomputers:read":"Read deployments roaming computers","deployments.roamingcomputersOrgInfo:read":"Read deployments roaming computers and OrgInfo properties"}}}}}},"spec":{"summary":"List Roaming Computers","operationId":"listRoamingComputers","tags":["Roaming Computers","Secure Access"],"description":"List the roaming computers.","security":[{"oauthFlow":["deployments.roamingcomputers: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},"example":3,"$$ref":"#/components/parameters/paginationPageParam"},{"name":"limit","in":"query","description":"The number of records in the collection to return on the page.","required":false,"schema":{"default":100,"type":"integer","format":"int32","minimum":1,"maximum":100},"example":40,"$$ref":"#/components/parameters/paginationLimitParam"},{"name":"name","schema":{"type":"string"},"in":"query","required":false,"description":"The name of the roaming computer.","example":"roaming-device-1"},{"name":"status","schema":{"type":"string","pattern":"^(Off|Open|Transparent|Encrypted|VA|Network|Disabled|Uninstalled|TrustedCustomerNetwork|CiscoTrustedNetwork|DisabledDueToACVpnFullTunnel)$"},"in":"query","required":false,"description":"Filter for the status of the roaming computer with DNS-layer security.","example":"Network"},{"name":"swgStatus","schema":{"type":"string","pattern":"^(NA|Protected|Unprotected|Disabled|DisabledDueToVPN|DisabledDueToTrustedNetwork|ConfigError|CloudServiceUnavailable)$"},"in":"query","required":false,"description":"Filter for the status of the roaming computer with Internet security (Secure Web Gateway).","example":"Protected"},{"name":"lastSyncBefore","schema":{"type":"string","format":"date-time"},"in":"query","required":false,"description":"The date and time (timestamp) before the last sync.","example":"2024-09-19T10:34:30.000Z"},{"name":"lastSyncAfter","schema":{"type":"string","format":"date-time"},"in":"query","required":false,"description":"The date and time (timestamp) after the last sync.","example":"2024-09-19T10:34:30.000Z"}],"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 the roaming computer.","required":["originId","name","deviceId","type","status","swgStatus","lastSyncStatus","lastSyncSwgStatus","lastSync","appliedBundle","hasIpBlocking","version","osVersion","osVersionName"],"properties":{"originId":{"type":"integer","description":"The origin ID for the roaming computer.","example":1234556},"name":{"type":"string","description":"The name of the roaming computer. `name` is a sequence of 1–50 characters.","minLength":1,"maxLength":50,"example":"roaming-computer-one","$$ref":"#/components/schemas/name"},"deviceId":{"type":"string","description":"The hex ID of the roaming computer.","example":"AB00C7DCEC99D211"},"type":{"type":"string","description":"The type of the roaming computer.","example":"anyconnect"},"status":{"type":"string","enum":["Off","Open","Transparent","Encrypted","VA","Network","Disabled","Uninstalled","TrustedCustomerNetwork","CiscoTrustedNetwork","DisabledDueToACVpnFullTunnel"],"description":"The status of the roaming computer with DNS-layer security.","example":"Encrypted"},"swgStatus":{"type":"string","enum":["Off","NA","Protected","Unprotected","Disabled","DisabledDueToVPN","DisabledDueToTrustedNetwork","ConfigError","CloudServiceUnavailable"],"description":"The status of the roaming computer with Internet security (Secure Web Gateway).","example":"Protected"},"lastSyncStatus":{"type":"string","enum":["Off","Open","Transparent","Encrypted","VA","Network","Disabled","Uninstalled","TrustedCustomerNetwork","CiscoTrustedNetwork","DisabledDueToACVpnFullTunnel"],"description":"The status of the last sync on the roaming computer with DNS-layer security.","example":"Encrypted"},"lastSyncSwgStatus":{"type":"string","enum":["NA","Protected","Unprotected","Disabled","DisabledDueToVPN","DisabledDueToTrustedNetwork","ConfigError","CloudServiceUnavailable"],"description":"The status of the last sync on the roaming computer with Internet security (Secure Web Gateway).","example":"Protected"},"lastSync":{"type":"string","format":"date-time","description":"The date and time (timestamp) of the last sync.","example":"2024-09-19T10:34:30.000Z"},"appliedBundle":{"type":"integer","description":"The policy ID.","example":0},"hasIpBlocking":{"type":"boolean","description":"Specifies whether the roaming computer has IP blocking.","example":false},"version":{"type":"string","description":"The version of the Cisco Secure Client with the Internet Security module deployed on the roaming computer.","example":"5.0"},"osVersion":{"type":"string","description":"The OS version of the roaming computer.","example":"Microsoft Windows NT 10.0.19045.0"},"osVersionName":{"type":"string","description":"The OS version name of the roaming computer.","example":"Windows 10"},"anyconnectDeviceId":{"type":"string","description":"The ID of the device that has the Cisco Secure Client deployed with the Internet Security module.","example":"6949b5cbfdc0b48ae4a58592867529480d88ef50"}},"example":{"originId":618400931,"deviceId":"AB000C044C87A4F0","type":"anyconnect","status":"Encrypted","swgStatus":"Protected","lastSyncStatus":"Encrypted","lastSyncSwgStatus":"Protected","lastSync":"2024-09-19T10:34:30.000Z","version":"5.2.3","name":"wkst2","hasIpBlocking":false,"appliedBundle":2,"osVersion":"Microsoft Windows NT 10.0.19045.0","osVersionName":"Windows 10","anyconnectDeviceId":"9e963836fef9429b66c3e47b58e496efce2b5003"},"$$ref":"#/components/schemas/RoamingComputerObject"}},"example":[{"originId":618400931,"deviceId":"AB000C044C87A4F0","type":"anyconnect","status":"Encrypted","swgStatus":"Protected","lastSyncStatus":"Encrypted","lastSyncSwgStatus":"Protected","lastSync":"2024-09-19T10:34:30.000Z","version":"5.2.3","name":"wkst2","hasIpBlocking":false,"appliedBundle":2,"osVersion":"Microsoft Windows NT 10.0.19045.0","osVersionName":"Windows 10","anyconnectDeviceId":"9e963836fef9429b66c3e47b58e496efce2b5003"}]}}},"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":"Bad Request","description":"A malformed client request."},"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":"Unauthorized","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":"listRoamingComputers","method":"get","path":"/roamingcomputers"}}