MaxScale 21.06 Admin User Resource
Admin users represent administrative users that are able to query and change
MaxScale's configuration.
Resource Operations
Get network user
Get a single network user. The :name in the URI must be a valid network
user name.
Response
Status: 200 OK
Get all network users
Get all network users.
Response
Status: 200 OK
Get enabled UNIX account
Note: This endpoint has been deprecated and does nothing.
Get all enabled UNIX accounts
Note: This endpoint has been deprecated and does nothing.
Get all administrative users.
Response
Status: 200 OK
Create a network user
Create a new network user. The request body must define at least the
following fields.
Only admin accounts can perform POST, PUT, DELETE and PATCH requests. If a basic
account performs one of the aforementioned request, the REST API will respond
with a 401 Unauthorized error.
Here is an example request body defining the network user my-user with the
password my-password that is allowed to execute only read-only operations.
Response
Enable a UNIX account
This enables an existing UNIX account on the system for administrative
operations. The request body must define at least the following fields.
Here is an example request body enabling the UNIX account jdoe for read-only operations.
Response
Delete a network user
The :name part of the URI must be a valid user name.
Response
Disable a UNIX account
The :name part of the URI must be a valid user name.
Response
Update a network user
Update network user. Currently, only the password can be updated. This
means that the request body must define the data.attributes.password
field.
Here is an example request body that updates the password.
Response
This page is licensed: CC BY-SA / Gnu FDL