Users

Get users.

get

Retrieve a list of platform users.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

filterstringOptionalDeprecated

Filter results by user attribute.

Example: runai.is_local:true

filterBystring[]Optional

Filter results by a parameter. Use the format field-name operator value. Operators are <= Less than or equal, >= Greater than or equal, =@ contains. Dates are in ISO 8601 timestamp format and available for operators <=, >= and ==.

Example: ["username=@test,lastLogin>=2024-09-24T00:00:00.00Z,isLocal==false"]

sortBystring · enumOptional

Sort results by a parameters.

Possible values:

sortOrderstring · enumOptional

Sort results in descending or ascending order.

Default: ascPossible values:

offsetinteger · int32Optional

The offset of the first item returned in the collection.

Example: 100

limitinteger · int32 · min: 1 · max: 500Optional

The maximum number of entries to return.

Default: 500

searchstringOptional

Filter results by a free text search.

Example: test@run

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/users

HTTPcURLJavaScriptPython

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

[
  {
    "id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
    "username": "[email protected]",
    "createdBy": "[email protected]",
    "createdAt": "2020-01-01T00:00:00Z",
    "updatedAt": "2022-01-01T00:00:00Z",
    "lastLogin": "2023-02-01T00:00:00Z",
    "isLocal": true,
    "groups": [
      "groupA",
      "groupB"
    ]
  }
]

Create a local user.

post

Use to create a local platform user.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

emailstring · min: 5 · max: 254Required

The email of the user. Must be a valid email address.

Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

resetPasswordboolean · nullableOptional

notifyboolean · nullableOptional

When true, send an email to the user. The email includes a link to reset the password.

Responses

201

Created 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/users

HTTPcURLJavaScriptPython

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

{
  "email": "[email protected]",
  "resetPassword": false,
  "notify": true
}

{
  "id": "0eeaf222-e503-4f35-9d9c-c419816272e3",
  "username": "[email protected]",
  "tempPassword": "asdasidjn9d"
}

Count users

get

count users

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

filterBystring[]Optional

Filter results by a parameter. Use the format field-name operator value. Operators are <= Less than or equal, >= Greater than or equal, =@ contains. Dates are in ISO 8601 timestamp format and available for operators <=, >= and ==.

Example: ["username=@test,lastLogin>=2024-09-24T00:00:00.00Z,isLocal==false"]

searchstringOptional

Filter results by a free text search.

Example: test@run

Responses

200

ok

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/users/count

HTTPcURLJavaScriptPython

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

{
  "count": 1
}

Logout a user.

post

Use to force a user to logout.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

userIdstringRequired

The id of the user

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

post

/api/v1/users/{userId}/logout

HTTPcURLJavaScriptPython

POST /api/v1/users/{userId}/logout HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Reset a user's password.

post

Use to to reset a user's password.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

userIdstringRequired

The id of the user

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/users/{userId}/password

HTTPcURLJavaScriptPython

POST /api/v1/users/{userId}/password HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "tempPassword": "asdasidjn9d"
}

Get a user by id.

get

Retrieve a user's details by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

userIdstringRequired

The id of the user

Responses

200

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

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/users/{userId}

HTTPcURLJavaScriptPython

GET /api/v1/users/{userId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
  "username": "[email protected]",
  "createdBy": "[email protected]",
  "createdAt": "2020-01-01T00:00:00Z",
  "updatedAt": "2022-01-01T00:00:00Z",
  "lastLogin": "2023-02-01T00:00:00Z",
  "isLocal": true,
  "groups": [
    "groupA",
    "groupB"
  ]
}

Delete a user by id.

delete

Use to delete a user by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

userIdstringRequired

The id of the user

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/users/{userId}

HTTPcURLJavaScriptPython

DELETE /api/v1/users/{userId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

change user password

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

currentPasswordstring · min: 8 · max: 255Required

newPasswordstring · min: 8 · max: 255Required

Responses

200

Password changed 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/me/password

HTTPcURLJavaScriptPython

POST /api/v1/me/password HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "currentPassword": "Abcd!234",
  "newPassword": "Zxcv!567"
}

{
  "tempPassword": "Abcd!234"
}