User Applications

DEPRECATED: User Applications have been renamed to Access Keys. Please use the Access Keys endpoints instead.

User Applications allow users to authenticate and interact programmatically with the NVIDIA Run:ai API.

Deprecated

Get a list of users applications.

get

Retrieve a list of the users applications.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Responses

200

Executed successfully.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/user-applications

HTTPcURLJavaScriptPython

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

[
  {
    "name": "my-user-app",
    "id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
    "clientId": "3434c-12323ab-4ce2ea6",
    "createdAt": "2019-01-01T00:00:00Z",
    "lastLogin": "2020-01-01T00:00:00Z"
  }
]

Deprecated

Create a user application.

post

Used to create a user application.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

namestring · min: 2 · max: 255Required

The name of the user application. The name must be unique within the user's applications list 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

409

The specified resource already exists

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/user-applications

HTTPcURLJavaScriptPython

POST /api/v1/user-applications HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "name": "app-name"
}

{
  "id": "0eeaf222-e503-4f35-9d9c-c419816272e3",
  "clientId": "5e7b3b7b4b7b4b7b",
  "name": "app123",
  "secret": "this-is-the-app-secret",
  "createdAt": "2020-01-01T00:00:00Z"
}

Deprecated

Get user application by id.

get

Retrieve the details of a user's application by app id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

appIdstringRequired

The application id to retrieve

Responses

200

Executed successfully.

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/user-applications/{appId}

HTTPcURLJavaScriptPython

GET /api/v1/user-applications/{appId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "my-user-app",
  "id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
  "clientId": "3434c-12323ab-4ce2ea6",
  "createdAt": "2019-01-01T00:00:00Z",
  "lastLogin": "2020-01-01T00:00:00Z"
}

Deprecated

Delete a user application byid.

delete

Use to user a user application by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

appIdstringRequired

The application id to retrieve

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/user-applications/{appId}

HTTPcURLJavaScriptPython

DELETE /api/v1/user-applications/{appId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Deprecated

Regenerate a user application secret.

post

Use to regenerate the user application secret by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

appIdstringRequired

The application id to retrieve

Responses

200

Regenerated 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

500

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/user-applications/{appId}/secret

HTTPcURLJavaScriptPython

POST /api/v1/user-applications/{appId}/secret HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "clientSecret": "this-is-my-secret"
}

Deprecated

Get a list of all users applications.

get

Retrieve a list of all users applications.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

clientIdstringOptional

Filter results by clientId

Example: 3434c-12323ab-4ce2ea6-b44fc-db344d

createdBystringOptional

Filter results by creatdBy

Example: [email protected]

Responses

200

Executed successfully.

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/administration/user-applications

HTTPcURLJavaScriptPython

GET /api/v1/administration/user-applications HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "my-user-app",
    "id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
    "clientId": "1434c-123233ab-4ce2ea6-b44fc-db344d",
    "createdBy": "[email protected]",
    "createdAt": "2020-01-01T00:00:00Z",
    "lastLogin": "2020-01-01T00:00:00Z"
  }
]

Deprecated

Delete a user application by id for adminstrations.

delete

Use to delete a user application by id for adminstrations.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

appIdstringRequired

The application id to retrieve

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/administration/user-applications/{appId}

HTTPcURLJavaScriptPython

DELETE /api/v1/administration/user-applications/{appId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content