Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NVIDIA Run:ai Roles API

A role is a group of permissions that can be granted. Permissions are a set of actions that can be applied to entities.For more information, see [Roles](https://run-ai-docs.nvidia.com/saas/infrastructure-setup/authentication/roles).

NVIDIA Run:ai Roles API is one of 62 APIs that NVIDIA Run:ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 2 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version latest.

Requests are made against a single base URL, https://app.run.ai.

2 operations 2 paths 9 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
latest
Base URL
https://app.run.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

NVIDIA Run:ai Roles API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer authentication

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Roles 2

A role is a group of permissions that can be granted. Permissions are a set of actions that can be applied to entities. For more information, see [Roles](https://run-ai-docs.nvidi…

GET
/api/v1/authorization/roles
Get a list of roles.
get_roles_v1 → 200400401403500503
GET
/api/v1/authorization/roles/{roleIdPath}
Get a role by id.
get_role_v1 1 param → 200400401403404500503

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are RoleV1 (12 properties), Permission (4 properties), Error (3 properties), KubernetesPermissions (1 property). Each schema is shown below with its type and property counts.

RoleV1
object
12 properties 9 required
KubernetesPermissions
object
This object indicate what kubernetes cluster permission should this role should get
1 property
Permission
object
4 properties 4 required
RolesV1
array
Permissions
array
ResourceTypeGroupId
string
ResourceType
string
Resource type enum for authorization. Note: The 'apps' resource type is DEPRECATED. Please use 'service-account' instead for managing service accounts.
Action
string
Error
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-roles-api-openapi.yml Raw ↑

Other APIs NVIDIA Run:ai publishes across the network.

NVIDIA Run:ai Access Keys API
NVIDIA Run:ai Access rules API
NVIDIA Run:ai Administrator Command Line Interface API
NVIDIA Run:ai AI Applications API
NVIDIA Run:ai Applications API
NVIDIA Run:ai AuditLogs API
NVIDIA Run:ai Clusters API
NVIDIA Run:ai Compute API
NVIDIA Run:ai ConfigMap API
NVIDIA Run:ai Credentials API
NVIDIA Run:ai Datasources API
NVIDIA Run:ai Datavolumes API