---
title: "NGC Roles"
method: GET
path: "/roles"
tags: ["Services"]
---

# NGC Roles

`GET /roles`

List of roles in NGC and their scopes

## Query parameters

- `show-hidden` boolean

## Response `200`

OK

- UserRoleDefinitionsResponse — Response containing all the roles defined in NGC and their allowed actions
  - `requestStatus` RequestStatus
    - `serverId` string
    - `statusCode` 'UNKNOWN' | 'SUCCESS' | 'UNAUTHORIZED' | 'PAYMENT_REQUIRED' | 'FORBIDDEN' | 'TIMEOUT' | 'EXISTS' | 'NOT_FOUND' | 'INTERNAL_ERROR' | 'INVALID_REQUEST' | 'INVALID_REQUEST_VERSION' | 'INVALID_REQUEST_DATA' | 'METHOD_NOT_ALLOWED' | 'CONFLICT' | 'UNPROCESSABLE_ENTITY' | 'TOO_MANY_REQUESTS' | 'INSUFFICIENT_STORAGE' | 'SERVICE_UNAVAILABLE' | 'PAYLOAD_TOO_LARGE' | 'NOT_ACCEPTABLE' | 'UNAVAILABLE_FOR_LEGAL_REASONS' | 'BAD_GATEWAY' — Describes response status reported by the server.
    - `statusDescription` string
    - `requestId` string
  - `roles` UserRoleDefinition[] — List of roles
    - `shortDisplayName` string — Short Display Name of the role
    - `product` RoleProduct — Product information of the role
      - `displayName` string — Display Name of the product from the product catalog to which this role is associated with
      - `name` string — Name of the product from the product catalog to which this role is associated with
    - `displayName` string — Display Name of the role
    - `name` string — Name of the role
    - `allowedActions` ServiceAccess[] — List of actions that this role allows
      - `service` string — Service that this role allows
      - `accessLevels` string[] — List of access levels that this role allows

## Other responses

- `302` — Found
- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `403` — Forbidden
- `404` — Not Found
- `405` — Method Not Allowed
- `409` — Object Exists
- `415` — Unsupported Media Type
- `422` — Unprocessable Entity
- `429` — Too Many Requests
- `451` — Unavailable For Legal Reasons
- `500` — Internal Error
- `501` — Not Implemented
- `502` — Bad Gateway
- `503` — Service Unavailable

---

[API](https://skmtc.net/brevdev/apis/ngc-api-documentation.md) · [All operations](https://skmtc.net/brevdev/apis/ngc-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/brevdev/ngc-api-documentation/revisions/7f0aa99cc03e/schema)