{"type":"api","title":"List Roles","meta":{"id":"/apps/pubhub/media/cloud-security-gov/9ead083ce611c254ac9201d1e76003bd3d4b4b6b/c24e887e-1827-3004-af8d-fdd6677097c8","info":{"title":"Cisco Umbrella for Government Users and Roles API","version":"2.0.0","description":"Manage the Umbrella user accounts and roles.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Users"},{"name":"Roles"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/admin/users-roles-overview.md","uri":"umbrella-api-reference-users-roles-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrellagov.com/{basePath}","variables":{"basePath":{"default":"admin/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrellagov.com/auth/v2/token","scopes":{"admin.users:read":"Read admin users","admin.users:write":"Write admin users","admin.roles:read":"Read admin roles"}}}}}},"spec":{"summary":"List Roles","operationId":"listRoles","tags":["Roles","Umbrella"],"description":"List the roles in the organization.","security":[{"oauthFlow":["admin.roles:read"]}],"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","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"roleId":{"type":"integer","description":"The ID of the role."},"label":{"type":"string","description":"The label for the role."},"organizationId":{"type":"integer","description":"The organization ID."}},"required":["roleId","label","organizationId"],"example":{"organizationId":1,"label":"Full Admin","roleId":1},"$$ref":"#/components/schemas/RoleObject"}},"example":[{"organizationId":1,"label":"Full Admin","roleId":1},{"organizationId":1,"label":"Read Only","roleId":2},{"organizationId":1,"label":"Block Page Bypass","roleId":3},{"organizationId":1,"label":"Reporting Only","roleId":4}]}}},"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","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"Invalid request"}}},"$$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","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"Unauthorized request"}}},"$$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","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"Forbidden"}}},"$$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","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"Not Found"}}},"$$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","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"Server error"}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"listRoles","method":"get","path":"/roles"}}