Permissions

Permissions define the actions that users can perform on specific resources within the NVIDIA Run:ai platform. Each permission consists of a resource type and an allowed action. The Permission Sets API provides a catalog of all available permission sets in the NVIDIA Run:ai platform. Each permission set is a predefined collection of permissions that represent the permissions required for a role to perform specific operations. Permission sets serve as the building blocks for roles and are used in both NVIDIA Run:ai predefined roles and custom roles defined through the Roles API.

Get permission sets.

get

Retrieve a list of all available permission sets. Each permission set defines a collection of permissions grouped by resource type and associated actions (such as create, read, update, or delete).

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Responses

200

Executed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/authorization/permission-sets

HTTPcURLJavaScriptPython

GET /api/v1/authorization/permission-sets HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "permissionSets": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "test",
      "description": "text",
      "permissions": [
        {
          "resourceType": "department",
          "actions": [
            "create"
          ]
        }
      ]
    }
  ]
}

Get permission set by id.

get

Returns information about a single permission set, including its name, description, and the list of permissions it contains.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

permissionSetIdstring · uuidRequired

Responses

200

Executed successfully.

application/json

idstring · uuidRequired

The universally unique ID (UUID) of the permission set.

namestringRequired

The name of the permission set.

Example: test

descriptionstringOptional

A description of the permission set.

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/authorization/permission-sets/{permissionSetId}

HTTPcURLJavaScriptPython

GET /api/v1/authorization/permission-sets/{permissionSetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "test",
  "description": "text",
  "permissions": [
    {
      "resourceType": "department",
      "actions": [
        "create"
      ]
    }
  ]
}

Get a summary of user permissions.

get

Retrieve a summary of user permissions.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Responses

200

Executed successfully.

application/json

resourceTypestring · enumRequired

Resource type enum for authorization.

Note: The 'apps' resource type is DEPRECATED. Please use 'service-account' instead for managing service accounts.

Possible values:

displayNamestringRequiredExample: Projects

groupIdstring · enumRequiredPossible values:

401

Unauthorized

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/authorization/permissions

HTTPcURLJavaScriptPython

GET /api/v1/authorization/permissions HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "resourceType": "department",
    "displayName": "Projects",
    "groupId": "organization",
    "actions": [
      "create"
    ]
  }
]

Calculate permitted scopes.

post

Use to calculate user permitted scopes for an action on a resource.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

resourceTypestring · enumRequired

Resource type enum for authorization.

Note: The 'apps' resource type is DEPRECATED. Please use 'service-account' instead for managing service accounts.

Possible values:

actionstring · enum · nullableOptionalPossible values:

Responses

200

Executed successfully.

application/json

401

Unauthorized

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/authorization/permitted-scopes

HTTPcURLJavaScriptPython

POST /api/v1/authorization/permitted-scopes HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "resourceType": "department",
  "action": "create"
}

{
  "create": {
    "system": false,
    "tenants": [
      "1"
    ],
    "clusters": [
      "a418ed33-9399-48c0-a890-122cadd13bfd"
    ],
    "departments": [
      "7"
    ],
    "projects": [
      "text"
    ]
  },
  "read": {
    "system": false,
    "tenants": [
      "1"
    ],
    "clusters": [
      "a418ed33-9399-48c0-a890-122cadd13bfd"
    ],
    "departments": [
      "7"
    ],
    "projects": [
      "text"
    ]
  },
  "update": {
    "system": false,
    "tenants": [
      "1"
    ],
    "clusters": [
      "a418ed33-9399-48c0-a890-122cadd13bfd"
    ],
    "departments": [
      "7"
    ],
    "projects": [
      "text"
    ]
  },
  "delete": {
    "system": false,
    "tenants": [
      "1"
    ],
    "clusters": [
      "a418ed33-9399-48c0-a890-122cadd13bfd"
    ],
    "departments": [
      "7"
    ],
    "projects": [
      "text"
    ]
  }
}