List System Users

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

data

array [object {5}]

required

id

integer

required

System user ID

username

string

required

Username for system user

deploymentKey

null

required

Deployment Key

deleteable

boolean

required

Whether system user is able to be deleted or not

created_at

string

required

Time which the system user was created at

meta

object

required

pagination

object

required

Pagination data for system user

Example

{
    "data": [
        {
            "id": 1645,
            "username": "runcloud",
            "deploymentKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDOXDS1WujnwZUjRaDCeLWZW9M56dYzQdC/OQDxjgNvmUyCTsAs5rzb39fvkorvruoOOXGxnQY7wJATYcyE4fvpuW/S9/h6LpsKSl1Bk86NSyxAARGgIqGHhBZcypgOXlPelQE2aqeKB1lUN32JTLTx2LiE1//FdZ8Ne8a5am0XEBZe1F+XnHPrBTCWvDSDryLNRv0tmePasjr0nTog/CJqX5Dnjke6MM84Cn1zO/U2L7fQ+0LdaIWdkQdApALwBj2csPtivMT5kMVQp7L2++wAiNLi0MIkaT/sbeYwynImRLtqMO2UNwoE02dXWhy22rfA8rzXhjYiO6BjF5fdIiLj GIT Deployment Key for user runcloud.",
            "deleteable": false,
            "created_at": "2024-07-09 06:41:52"
        },
        {
            "id": 1644,
            "username": "root",
            "deploymentKey": null,
            "deleteable": false,
            "created_at": "2024-07-09 06:41:52"
        },
        {
            "id": 1690,
            "username": "realuser",
            "deploymentKey": null,
            "deleteable": true,
            "created_at": "2024-07-24 06:40:23"
        }
    ],
    "meta": {
        "pagination": {
            "total": 3,
            "count": 3,
            "per_page": 15,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}