NVIDIA Run:ai

Service Accounts

Service accounts enable programmatic access to the NVIDIA Run:ai API, allowing applications or automated systems to authenticate and interact securely. Each service account is associated with an access key which includes a client ID and secret used to generate access token. Service accounts can be managed organization-wide or with a defined scope.

Get a list of service accounts.

Retrieve a list of service accounts.

SecuritybearerAuth
Responses
200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/service-accounts
Response samples
application/json
[
  • {
    }
]

Create a service account.

Used to create a service account.

SecuritybearerAuth
Request
Request Body schema: application/json
required

Service account object to create

name
required
string^[a-z][-_a-z0-9]*[a-z0-9]$

The name of the service account. The name must be unique within the organization and can only contain lowercase alphanumeric characters and hyphens. It must start and end with a letter.

Responses
201

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

409

The specified resource already exists

500

unexpected error

503

unexpected error

post/api/v1/service-accounts
Request samples
application/json
{
  • "name": "service-account-123"
}
Response samples
application/json
{
  • "id": "0eeaf222-e503-4f35-9d9c-c419816272e3",
  • "name": "service-account-123",
  • "clientSecret": "asdasidjn9d",
  • "clientId": "service-account-123"
}

Get service account by id.

Retrieve the details of a service account by id.

SecuritybearerAuth
Request
path Parameters
serviceAccountId
required
string

Service account id

Example: 6d2894ba-f998-4039-bba1-caba57caf681
Responses
200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/service-accounts/{serviceAccountId}
Response samples
application/json
{
  • "name": "service-account-123",
  • "createdBy": "test@run.ai",
  • "createdAt": "2020-01-01T00:00:00Z",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "enabled": true,
  • "tenantId": 1234567890,
  • "lastLogin": "2020-01-01T00:00:00Z",
  • "id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
  • "clientId": "service-account-123"
}

Update service account details by id.

Use to update the details of a service account by id.

SecuritybearerAuth
Request
path Parameters
serviceAccountId
required
string

Service account id

Example: 6d2894ba-f998-4039-bba1-caba57caf681
Request Body schema: application/json

Service account object that needs to be updated.

enabled
required
boolean

Indicates whether the service account is enabled.

Responses
200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

patch/api/v1/service-accounts/{serviceAccountId}
Request samples
application/json
{
  • "enabled": true
}
Response samples
application/json
{
  • "code": 400,
  • "message": "Required parameter is missing"
}

Delete a service account by id.

Use to delete a service account by id.

SecuritybearerAuth
Request
path Parameters
serviceAccountId
required
string

Service account id

Example: 6d2894ba-f998-4039-bba1-caba57caf681
Responses
204

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

delete/api/v1/service-accounts/{serviceAccountId}
Response samples
application/json
{
  • "code": 400,
  • "message": "Required parameter is missing"
}

Regenerate a service account secret.

Use to regenerate the service account secret by id.

SecuritybearerAuth
Request
path Parameters
serviceAccountId
required
string

Service account id

Example: 6d2894ba-f998-4039-bba1-caba57caf681
Responses
200

Regenerated successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

post/api/v1/service-accounts/{serviceAccountId}/secret
Response samples
application/json
{
  • "clientSecret": "189ej2ijd92fj092k049fk0"
}
➔ Next to Roles