Get a list of roles. | NVIDIA Run:ai Documentation

{
  "roles": [
    {
      "name": "admin",
      "description": "can manage all resources",
      "id": 32,
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "createdBy": "user@run.ai",
      "effectiveEnabled": true,
      "permissions": [
        {
          "resourceType": "department",
          "actions": [
            "create"
          ]
        }
      ],
      "enabled": true,
      "permissionSets": [
        {
          "id": "string",
          "name": "test"
        }
      ],
      "kubernetesPermissions": {
        "predefinedRole": "12"
      },
      "deprecated": true
    }
  ],
  "next": 1
}

Retrieves a list of all available roles, including both NVIDIA Run:ai predefined roles and custom roles. Use this endpoint to review role configurations, permission sets and permissions.

Authentication

AuthorizationBearer

Bearer authentication

Query parameters

limitintegerOptional1-500Defaults to 50

The maximum number of entries to return.

offsetintegerOptional

The offset of the first item returned in the collection.

sortOrderenumOptionalDefaults to asc

Sort results in descending or ascending order.

Allowed values:

sortByenumOptional

Sort results by a parameter.

filterBylist of stringsOptional

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

searchstringOptional

Filter results by a free text search.

Response

Executed successfully.

roleslist of objects

nextintegerOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

503

Service Unavailable Error