Users
Bearer authentication
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 ==.
["username=@test,lastLogin>=2024-09-24T00:00:00.00Z,isLocal==false"]Sort results by a parameters.
Sort results in descending or ascending order.
ascPossible values: The offset of the first item returned in the collection.
100The maximum number of entries to return.
500Filter results by a free text search.
test@runExecuted successfully.
Bad request.
Unauthorized
Forbidden
unexpected error
unexpected error
GET /api/v1/users HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
"username": "test@run.ai",
"createdBy": "devops@run.ai",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2022-01-01T00:00:00Z",
"lastLogin": "2023-02-01T00:00:00Z",
"isLocal": true,
"groups": [
"groupA",
"groupB"
]
}
]Bearer authentication
The email of the user. Must be a valid email address.
^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$When true, send an email to the user. The email includes a link to reset the password.
Created successfully.
Bad request.
Unauthorized
Forbidden
The specified resource already exists
unexpected error
unexpected error
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": "test@run.ai",
"resetPassword": false,
"notify": true
}{
"id": "0eeaf222-e503-4f35-9d9c-c419816272e3",
"username": "test@run.ai",
"tempPassword": "asdasidjn9d"
}Bearer authentication
Filter results by username. Use the format field-name operator value. Supported operators are == (exact match) and =@ (contains). Multiple entries (up to 25) are allowed only with the == operator.
["username==test@run.ai"]Filter results by a free text search across username, firstName and lastName (OR logic). Minimum 2 characters.
johnBulk lookup by user IDs (comma-separated). Returns the matching users in addition to any results from search or filterBy. Up to 25 IDs per request.
["8e3f0a4b-4d3c-4f6e-9d2a-1c5e0a8b7f6d"]The maximum number of entries to return.
500Executed successfully.
The user's unique identifier.
The user's login name. Typically an email address.
The user's first name.
The user's last name.
Bad request.
Unauthorized
Forbidden
unexpected error
unexpected error
GET /api/v1/users-minimal HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
"username": "test@run.ai",
"firstName": "John",
"lastName": "Doe"
}
]Bearer authentication
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 ==.
["username=@test,lastLogin>=2024-09-24T00:00:00.00Z,isLocal==false"]Filter results by a free text search.
test@runok
1Bad request.
Unauthorized
Forbidden
unexpected error
GET /api/v1/users/count HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 1
}Bearer authentication
The id of the user
Executed successfully.
No content
Bad request.
Unauthorized
Forbidden
The specified resource was not found
unexpected error
unexpected error
POST /api/v1/users/{userId}/logout HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Bearer authentication
The id of the user
Regenerated successfully.
Bad request.
Unauthorized
Forbidden
The specified resource was not found
unexpected error
unexpected error
POST /api/v1/users/{userId}/password HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"tempPassword": "asdasidjn9d"
}Bearer authentication
The id of the user
Executed successfully.
Bad request.
Unauthorized
Forbidden
The specified resource was not found
unexpected error
unexpected error
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": "test@run.ai",
"createdBy": "devops@run.ai",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2022-01-01T00:00:00Z",
"lastLogin": "2023-02-01T00:00:00Z",
"isLocal": true,
"groups": [
"groupA",
"groupB"
]
}Bearer authentication
The id of the user
Executed successfully.
No content
Bad request.
Unauthorized
Forbidden
The specified resource was not found
unexpected error
unexpected error
DELETE /api/v1/users/{userId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Bearer authentication
The id of the user
Executed successfully.
Bad request.
Unauthorized
Forbidden
The specified resource was not found
unexpected error
unexpected error
PATCH /api/v1/users/{userId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 37
{
"firstName": "John",
"lastName": "Doe"
}{
"id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
"username": "test@run.ai",
"createdBy": "devops@run.ai",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2022-01-01T00:00:00Z",
"lastLogin": "2023-02-01T00:00:00Z",
"isLocal": true,
"groups": [
"groupA",
"groupB"
]
}Bearer authentication
Password changed successfully.
Bad request.
Unauthorized
Forbidden
The specified resource was not found
unexpected error
unexpected error
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"
}Last updated