Get Tags - Cloud Security API

{"type":"api","title":"Get Tags","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 tags in the organization.","summary":"Get Tags","operationId":"getTags","tags":["Tags","Umbrella"],"security":[{"oauthFlow":["deployments.tags:read"]}],"parameters":[{"name":"limit","description":"The number of items to return from the collection in the response.","schema":{"type":"integer","default":10},"in":"query","required":false,"example":10,"$$ref":"#/components/parameters/limit"},{"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"}],"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 tag information for the device.","required":["id","organizationId","name","originsModifiedAt","createdAt","modifiedAt"],"properties":{"id":{"type":"integer","description":"The unique ID of the tag.","example":12345678,"$$ref":"#/components/schemas/id"},"organizationId":{"type":"integer","description":"The organization ID.","example":2456789,"$$ref":"#/components/schemas/organizationId"},"name":{"type":"string","description":"The name of the tag.","example":"tag-one","$$ref":"#/components/schemas/name"},"originsModifiedAt":{"type":"string","format":"date-time","description":"The date and time (timestamp) that Umbrella modified the roaming computers.\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/originsModifiedAt"},"createdAt":{"type":"string","format":"date-time","description":"The date and time (timestamp) that Umbrella added the tag to the roaming computer.\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/createdAt"},"modifiedAt":{"type":"string","format":"date-time","description":"The date and time (timestamp) that Umbrella updated the tag on the roaming computer.\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/modifiedAt"}},"example":{"id":12345,"organizationId":567893,"name":"tag-one","originsModifiedAt":"2022-04-12T23:20:50.52Z","createdAt":"2022-04-12T23:20:50.52Z","modifiedAt":"2022-04-12T23:20:50.52Z"},"$$ref":"#/components/schemas/tagInformation"}},"example":[{"id":67747,"organizationId":3056800,"name":"tag-two","originsModifiedAt":"2022-04-12T23:20:50.52Z","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":"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":{"Error":{"type":"string"}}}}},"$$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":{"Error":{"type":"string"}}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getTags","method":"get","path":"/tags"}}