Create Onezone user
Creates a new Onezone user account with Basic (username & password) authentication enabled.
Example cURL requests
Create Onezone user with username & password
curl -H "X-Auth-Token: $TOKEN" -X POST https://$OZ_PANEL_HOST/api/v3/onepanel/zone/users \
-H "Content-Type: application/json" -d '{
"username": "someUser",
"password": "somePassword"
}'
{
"id": "b519b3ac46823b2b83b6cb85e1b16f4fchaa0f"
}
Request body
The user configuration details.
User's human-readable identifier, unique across the system. Makes it easier to identify the user and can be used for signing in with password.
User's password (in plaintext).
User's full name (given names + surname).
Ids of Onezone groups to which the user should be added. The groups must already exist.
Request Examples
{
"username": "admin",
"password": "somePassword",
"groups": [
"admins"
]
}Responses
Invalid request.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Forbidden request.
Internal server error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}