Skip to main content

Users

GET /v1/users.list

List users

This endpoint allows you to get users in your workspace.

Query Parameters

ParameterTypeDescription
searchstringSearch filter for searching the user by name or email
pageintegerUsed for pagination
sizeintegerResources per page limit

Response


{
"ok": true,
"users": [{
"id": "d3f89247-9162-4b94-ba88-2f09807415f3",
"workspace_id": "79bdb14f-c5cf-4141-8266-43270097a462",
"created_at": 1579440838,
"role": "owner",
"name": "John Doe",
"email": "john.doe@acme.inc",
"self": true
}],
"total": 1
}

GET /v1/users.machines.connected.list

List Connected User Machines

This endpoint allows you to get connected agents of a user.

Response


{
"ok": true,
"machines": [
{
"arch": "amd64",
"id": "6bf58919f2b540c7bd5c6ae8ca207aaf",
"ip": "10.244.0.111",
"machine_name": "john",
"os": "linux",
"user": "92d0d9e8-15e9-4514-8c91-709f1aa849c6",
"workspace_id": "039353ae-bce4-4288-8062-55ab8fbb7331"
}
]
}

GET /v1/users.robots.connected.list

List Connected User Robots

This endpoint allows you to get connected robots of a user.

Response


{
"ok": true,
"robots": [
{
"arch": "amd64",
"id": "94f7dca1-67dc-4d6b-aae1-17a61f91281c",
"ip": "10.244.0.111",
"machine_id": "6ca58919f2b540c7bd5c6ae8ca207aaf",
"name": "Avory",
"os": "linux",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAq/imkvTF+rGIQWm6tO1j\ncLwAIPwsoCzBmOFgA2iKqs5vMHVnHlg3Yds/oflImxddYl4AYtEHv9X7AxR3qEFQ\nKcAzTWCpyNPZdS5yqDLNfSXR7EXL2Z77LZPO/v9AQtZ7pSyH5LvoOBWShTGGxR4M\nQKyO5lDaxXcPmynuBd68gyNFAl/QdN37DSQNMEuVDRLBvBHrrB4wCTqSmVsmz+56\n9kTN2afjFD6LIsVSI/YeE3vMHIeSwUxMyD6kvi8pwB0J0ARAT+z7/37RymdIREsq\nGNs3jBbZAgOG7CNZaivEpMx0TsXcyNv00pwFppWzA3wlneUdGX71QL4P+ZAqVigW\nvwIDAQAB\n-----END PUBLIC KEY-----\n",
"type": "development",
"user": "92d0d9e8-15e9-4514-8c91-709f1aa849c6",
"version": "1.16.0",
"workspace_id": "039353ae-bce4-4288-8062-55ab8fbb7331"
}
]
}

POST /v1/users.edit

Edit User

This endpoint allows you to edit your user information.

Body Parameters

ParameterTypeDescription
full_namestring
emailstring

Response

POST /v1/users.invite

Invite Users

This endpoint allows you to invite a user to your workspace.

Body Parameters

ParameterTypeDescription
namestring
emailstring
rolestringmember, guest or admin

Response


{
"id": "d58d5911-963b-4c41-bb96-b5176e7c62ec",
"ok": true
}

POST /v1/users.update

Update Users

This endpoint allows to update a user information.

Body Parameters

ParameterTypeDescription
user_idstringWorkspace user id
full_namestringFull name of the workspace user
workspace_rolestringmember, guest or admin

Response


{
"ok": true
}

DELETE /v1/users.delete

Delete User

This endpoint allows to delete a user from the workspace.

Body Parameters

ParameterTypeDescription
user_idstringWorkspace user id

Response


{
"ok": true
}

DELETE /v1/users.invitation.delete

Delete a User Invitation

This endpoint allows to delete a user invitation from the workspace.

Body Parameters

ParameterTypeDescription
idstring

Response


{
"ok": true
}