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.

get

Retrieve a list of service accounts.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Responses

200

Executed successfully.

application/json

namestringRequired

The name of the service account.

createdBystringRequired

The email address of the user who created the service account.

createdAtstring · date-time · nullableRequired

The timestamp for when the service account was created.

updatedAtstring · date-time · nullableRequired

The timestamp for when the service account was last updated.

enabledbooleanRequired

Indicates whether the service account is enabled.

tenantIdstringOptional

The unique identifier of the tenant.

lastLoginstring · date-time · nullableRequired

The timestamp of the last time the service account was used to authenticate.

idstringRequired

The unique identifier of the service account.

clientIdstringRequired

The client identifier associated with the service account. Used when requesting authentication tokens.

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/service-accounts

HTTPcURLJavaScriptPython

GET /api/v1/service-accounts HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "service-account-123",
    "createdBy": "[email protected]",
    "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"
  }
]

Create a service account.

post

Used to create a service account.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

namestring · min: 2 · max: 255Required

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.

Pattern: ^[a-z][-_a-z0-9]*[a-z0-9]$

Responses

201

Executed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

409

The specified resource already exists

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/service-accounts

HTTPcURLJavaScriptPython

POST /api/v1/service-accounts HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "service-account-123"
}

{
  "id": "0eeaf222-e503-4f35-9d9c-c419816272e3",
  "name": "service-account-123",
  "clientSecret": "asdasidjn9d",
  "clientId": "service-account-123"
}

Get service account by id.

get

Retrieve the details of a service account by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

serviceAccountIdstringRequired

Service account id

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

Responses

200

Executed successfully.

application/json

namestringRequired

The name of the service account.

createdBystringRequired

The email address of the user who created the service account.

createdAtstring · date-time · nullableRequired

The timestamp for when the service account was created.

updatedAtstring · date-time · nullableRequired

The timestamp for when the service account was last updated.

enabledbooleanRequired

Indicates whether the service account is enabled.

tenantIdstringOptional

The unique identifier of the tenant.

lastLoginstring · date-time · nullableRequired

The timestamp of the last time the service account was used to authenticate.

idstringRequired

The unique identifier of the service account.

clientIdstringRequired

The client identifier associated with the service account. Used when requesting authentication tokens.

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/service-accounts/{serviceAccountId}

HTTPcURLJavaScriptPython

GET /api/v1/service-accounts/{serviceAccountId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "service-account-123",
  "createdBy": "[email protected]",
  "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"
}

Delete a service account by id.

delete

Use to delete a service account by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

serviceAccountIdstringRequired

Service account id

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

Responses

204

Executed successfully.

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

delete

/api/v1/service-accounts/{serviceAccountId}

HTTPcURLJavaScriptPython

DELETE /api/v1/service-accounts/{serviceAccountId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update service account details by id.

patch

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

serviceAccountIdstringRequired

Service account id

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

Body

application/json

enabledbooleanRequired

Indicates whether the service account is enabled.

Responses

200

Executed successfully.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

patch

/api/v1/service-accounts/{serviceAccountId}

HTTPcURLJavaScriptPython

PATCH /api/v1/service-accounts/{serviceAccountId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "enabled": true
}

No content

Regenerate a service account secret.

post

Use to regenerate the service account secret by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

serviceAccountIdstringRequired

Service account id

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

Responses

200

Regenerated successfully.

application/json

clientSecretstringOptional

Secret credential paired with the client ID. Used to obtain authentication tokens. Displayed only once upon regeneration.

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/service-accounts/{serviceAccountId}/secret

HTTPcURLJavaScriptPython

POST /api/v1/service-accounts/{serviceAccountId}/secret HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "clientSecret": "189ej2ijd92fj092k049fk0"
}