Get Devices With Tag - Cloud Security API

{"type":"api","title":"Get Devices With Tag","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/59bf0ad6-4eb1-34ae-8274-88981a81af60","info":{"title":"Cisco Umbrella Tagging API","version":"2.0.0","description":"Manage the tags and roaming computers with tags in the Umbrella organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Tags","description":"Manage the tags in the organization."},{"name":"TagDevices","description":"Manage the roaming computers in the Umbrella organization that have a tag."},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/deployments/tagging-overview.md","uri":"umbrella-api-reference-tagging-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.tags:read":"Tags read access","deployments.tags:write":"Tags write access","deployments.tagDevices:read":"Tagged devices read access","deployments.tagDevices:write":"Tagged devices write access"}}}}}},"spec":{"description":"List the roaming computers that have a tag with the specified tag ID.","summary":"Get Devices With Tag","operationId":"getDevicesWithTag","tags":["TagDevices","Umbrella"],"security":[{"oauthFlow":["deployments.tagDevices:read"]}],"parameters":[{"name":"limit","description":"The number of roaming computers with the tag ID to return from the collection in the response.","schema":{"type":"integer","default":10,"maximum":500},"in":"query","required":false,"example":350,"$$ref":"#/components/parameters/limitTagDevices"},{"name":"page","description":"The number of a page in the collection.","schema":{"type":"integer","default":1},"in":"query","required":false,"example":2,"$$ref":"#/components/parameters/page"},{"name":"tagId","in":"path","description":"The ID of the tag.","required":true,"schema":{"type":"integer"},"example":2,"$$ref":"#/components/parameters/tagId"}],"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 information about the device.","required":["originId","organizationId","label","type","createdAt","modifiedAt"],"properties":{"originId":{"type":"integer","description":"The unique identifier of the device.","example":2456,"$$ref":"#/components/schemas/originId"},"organizationId":{"type":"integer","description":"The organization ID.","example":2456789,"$$ref":"#/components/schemas/organizationId"},"label":{"type":"string","description":"The display name of the device.","example":"device-one","$$ref":"#/components/schemas/label"},"type":{"type":"string","description":"The device type.","example":"macOS","$$ref":"#/components/schemas/type"},"createdAt":{"type":"string","format":"date-time","description":"The date and time (timestamp) that Umbrella added the roaming computer to the organization.\nThe timestamp is an ISO 8601 formatted string. For example: `2023-04-12T23:20:50.52Z`.","example":"2022-04-12T23:20:50.52Z","$$ref":"#/components/schemas/deviceCreatedAt"},"modifiedAt":{"type":"string","format":"date-time","description":"The date and time (timestamp) that Umbrella updated the roaming computer in the organization.\nThe timestamp is an ISO 8601 formatted string. For example: `2023-04-12T23:20:50.52Z`.","example":"2022-04-12T23:20:50.52Z","$$ref":"#/components/schemas/deviceModifiedAt"}},"example":{"originId":12345,"organizationId":567893,"label":"device-one","type":"linux","createdAt":"2022-04-12T23:20:50.52Z","modifiedAt":"2022-04-12T23:20:50.52Z"},"$$ref":"#/components/schemas/deviceInformation"}},"example":[{"originId":384428946,"organizationId":3056800,"label":"test1","type":"roaming/anyconnect","createdAt":"2022-04-12T23:20:50.52Z","modifiedAt":"2022-04-12T23:20:50.52Z"},{"originId":12345,"organizationId":567893,"label":"device-one","type":"linux","createdAt":"2022-04-12T23:20:50.52Z","modifiedAt":"2022-04-12T23:20:50.52Z"}]}}},"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":{"Error":{"type":"string"}}}}},"$$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":{"Error":{"type":"string"}}}}},"$$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":{"Error":{"type":"string"}}}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Tag 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","required":["Error"],"properties":{"Error":{"type":"string"}},"example":{"Error":"object_not_found","message":"Tag not found","code":404,"code_text":"Not Found"}}}},"$$ref":"#/components/responses/404TagNotFound"},"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":{"Error":{"type":"string"}}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getDevicesWithTag","method":"get","path":"/tags/{tagId}/devices"}}