Client server users
Create User
Adds a user to the server
Fields
| Name | Required? | Type | Description | Rules |
|---|---|---|---|---|
| required | string | Email address of the user | ||
| permissions | required | object | Permissions that user is permitted |
POST
/api/client/servers/{server}/usersAuthorization
ClientToken AuthorizationBearer <token>
Client API key (generated at /account/api)
In: header
Path Parameters
server*string
Server identifier (short 8-character ID)
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/client/servers/1a7ce997/users" \ -H "Content-Type: application/json" \ -d '{ "email": "[email protected]", "permissions": [ "control.console", "control.start" ] }'{ "object": "server_subuser", "attributes": { "uuid": "60a7aec3-e17d-4aa9-abb3-56d944d204b4", "username": "subuser2jvc", "email": "[email protected]", "image": "https://gravatar.com/avatar/3bb1c751a8b3488f4a4c70eddfe898d8", "2fa_enabled": false, "created_at": "2020-06-12T23:31:41+01:00", "permissions": [ "control.console", "control.start", "websocket.connect" ] }}