Skip to content
Reviactyl v26 has been released!
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Subuser

Return the users associated with this server instance

get
Path parameters
serverintegerRequired

The server ID

Responses
200Success
application/json
itemsanyOptional
get/servers/{server}/users
GET /api/client/servers/{server}/users HTTP/1.1
Host: reviactyl.test
Accept: */*
[]

Create a new subuser for the given server

post
Path parameters
serverintegerRequired

The server ID

Body
emailstring · email · min: 1 · max: 191Required
permissionsstring[] · min: 1Required
Responses
200Success
application/json
itemsanyOptional
post/servers/{server}/users
POST /api/client/servers/{server}/users HTTP/1.1
Host: reviactyl.test
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "email": "name@gmail.com",
  "permissions": [
    "text"
  ]
}
[]

Returns a single subuser associated with this server instance

get
Path parameters
serverstringRequired
userstringRequired
Responses
200Success
application/json
itemsanyOptional
get/servers/{server}/users/{user}
GET /api/client/servers/{server}/users/{user} HTTP/1.1
Host: reviactyl.test
Accept: */*
[]

Update a given subuser in the system for the server

post
Path parameters
serverintegerRequired

The server ID

userstringRequired
Body
permissionsstring[] · min: 1Required
Responses
200Success
application/json
itemsanyOptional
post/servers/{server}/users/{user}
POST /api/client/servers/{server}/users/{user} HTTP/1.1
Host: reviactyl.test
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "permissions": [
    "text"
  ]
}
[]

Removes a subusers from a server's assignment

delete
Path parameters
serverintegerRequired

The server ID

userstringRequired
Responses
204

No content

application/json
string[]Optional
delete/servers/{server}/users/{user}
DELETE /api/client/servers/{server}/users/{user} HTTP/1.1
Host: reviactyl.test
Accept: */*
[
  "text"
]

Last updated

Was this helpful?