Run:ai

User Applications

Get a list of users applications.

Retrieve a list of the users applications.

SecuritybearerAuth
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

get/api/v1/user-applications
Response samples
application/json
[
  • {
    }
]

Create a user application.

Used to create a user application.

SecuritybearerAuth
Request
Request Body schema: application/json
required

Application object to create

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

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.

Responses
201

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

409

The specified resource already exists

500

unexpected error

503

unexpected error

post/api/v1/user-applications
Request samples
application/json
{
  • "name": "app-name"
}
Response samples
application/json
{
  • "id": "0eeaf222-e503-4f35-9d9c-c419816272e3",
  • "clientId": "5e7b3b7b4b7b4b7b",
  • "name": "app123",
  • "secret": "this-is-the-app-secret",
  • "createdAt": "2020-01-01T00:00:00Z"
}

Get user application by id.

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

SecuritybearerAuth
Request
path Parameters
appId
required
string

The application id to retrieve

Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/user-applications/{appId}
Response samples
application/json
{
  • "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"
}

Delete a user application byid.

Use to user a user application by id.

SecuritybearerAuth
Request
path Parameters
appId
required
string

The application id to retrieve

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/user-applications/{appId}
Response samples
application/json
{
  • "code": 400,
  • "message": "Required parameter is missing"
}

Regenerate a user application secret.

Use to regenerate the user application secret by id.

SecuritybearerAuth
Request
path Parameters
appId
required
string

The application id to retrieve

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/user-applications/{appId}/secret
Response samples
application/json
{
  • "secret": "this-is-my-secret"
}

Get a list of all users applications.

Retrieve a list of all users applications.

SecuritybearerAuth
Request
query Parameters
clientId
string

Filter results by clientId

Example: clientId=3434c-12323ab-4ce2ea6-b44fc-db344d
createdBy
string

Filter results by creatdBy

Example: createdBy=test@run.ai
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/administration/user-applications
Response samples
application/json
[
  • {
    }
]

Delete a user application by id for adminstrations.

Use to delete a user application by id for adminstrations.

SecuritybearerAuth
Request
path Parameters
appId
required
string

The application id to retrieve

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/administration/user-applications/{appId}
Response samples
application/json
{
  • "code": 400,
  • "message": "Required parameter is missing"
}
➔ Next to AuditLogs