Powered by Redocly

/config/user/{name}

A user configuration (account).

Get /config/user/{name}

SecurityApiKey
Request
path Parameters
name
required
string

The name of a user. Must consist of alpha-numeric characters or underscores (_).

query Parameters
max-depth
integer >= 1

Limit output depth of the response. See Max-Depth.

Example: max-depth=2
filter
string

Response filter string. See Filter-Spec.

Example: filter={foo,bar}
Responses
200

Normal response.

401

Unauthorized response.

get/config/user/{name}
Request samples 
Response samples 
application/json
{
  • "result": "jsmith",
  • "error": "Error message (present if an error occurred)."
}
Replace /config/user/{name}
SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a user.  Must consist of alpha-numeric characters or
underscores (_).


 
Request Body schema: application/json
priv
Array of strings (configUserNamePriv) 
The list of privileges the user possesses.


 
hash
string (configUserNameHash) 
The hash of the user's password.
Writing an empty hash string disables the account.


This resource is write-only.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/user/{name}
Request samples 
application/json
"jsmith"
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/user/{name}
SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a user.  Must consist of alpha-numeric characters or
underscores (_).


 
Request Body schema: application/json
priv
Array of strings (configUserNamePriv) 
The list of privileges the user possesses.


 
hash
string (configUserNameHash) 
The hash of the user's password.
Writing an empty hash string disables the account.


This resource is write-only.


 
Responses 
200
Normal response.


401
Unauthorized response.


post/config/user/{name}
Request samples 
application/json
"jsmith"
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /config/user/{name}
Delete this user account.


SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a user.  Must consist of alpha-numeric characters or
underscores (_).


 
Responses 
200
Normal response.


401
Unauthorized response.


delete/config/user/{name}
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /config/user/{name}/priv