Admin users represent administrative users that are able to query and change MaxScale's configuration.
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.
Response
Status: 200 OK
Note: This endpoint has been deprecated and does nothing.
Note: This endpoint has been deprecated and does nothing.
Get all administrative users.
Response
Status: 200 OK
Create a new network user. The request body must define at least the following fields.
data.id
The username
data.type
Type of the object, must be inet
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
This enables an existing UNIX account on the system for administrative operations. The request body must define at least the following fields.
data.id
The username
data.type
Type of the object, must be unix
Here is an example request body enabling the UNIX account jdoe for read-only operations.
Response
The :name part of the URI must be a valid user name.
Response
The :name part of the URI must be a valid user name.
Response
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
CC BY-SA / Gnu FDL
data.attributes.password
The password for this user
data.attributes.account
Set to admin for administrative users and basic to read-only users
data.attributes.account
Set to admin for administrative users and basic to read-only users
GET /v1/users/inet/:name{
"data": {
"attributes": {
"account": "admin",
"created": "Thu, 20 Jul 2023 15:29:02 GMT",
"last_login": "Thu, 20 Jul 2023 15:29:12 GMT",
"last_update": null,
"name": "admin"
},
"id": "admin",
"links": {
"self": "http://localhost:8989/v1/users/inet/admin/"
},
"type": "inet"
},
"links": {
"self": "http://localhost:8989/v1/users/inet/admin/"
}
}GET /v1/users/inet{
"data": [
{
"attributes": {
"account": "admin",
"created": "Thu, 20 Jul 2023 15:29:02 GMT",
"last_login": "Thu, 20 Jul 2023 15:29:12 GMT",
"last_update": null,
"name": "admin"
},
"id": "admin",
"links": {
"self": "http://localhost:8989/v1/users/inet/admin/"
},
"type": "inet"
}
],
"links": {
"self": "http://localhost:8989/v1/users/inet/"
}
}GET /v1/users/unix/:nameGET /v1/users/unixGET /v1/users{
"data": [
{
"attributes": {
"account": "admin",
"created": "Thu, 20 Jul 2023 15:29:02 GMT",
"last_login": "Thu, 20 Jul 2023 15:29:12 GMT",
"last_update": null,
"name": "admin"
},
"id": "admin",
"links": {
"self": "http://localhost:8989/v1/users/inet/admin/"
},
"type": "inet"
}
],
"links": {
"self": "http://localhost:8989/v1/users/inet/"
}
}POST /v1/users/inet{
"data": {
"id": "my-user", // The user to create
"type": "inet", // The type of the user
"attributes": {
"password": "my-password", // The password to use for the user
"account": "basic" // The type of the account
}
}
}Status: 204 No ContentPOST /v1/users/unix{
"data": {
"id": "jdoe", // Account name
"type": "unix" // Account type
"attributes": {
"account": "basic" // Type of the user account in MaxScale
}
}
}Status: 204 No ContentDELETE /v1/users/inet/:nameStatus: 204 No ContentDELETE /v1/users/unix/:nameStatus: 204 No ContentPATCH /v1/users/inet/:name{
"data": {
"attributes": {
"password": "new-password"
}
}
}Status: 204 No Content