# Admin User Resource
Admin users represent administrative users that are able to query and change\
MaxScale's configuration.
* [Admin User Resource](#admin-user-resource)
* [Resource Operations](#resource-operations)
* [Get network user](#get-network-user)
* [Response](#response)
* [Get all network users](#get-all-network-users)
* [Response](#response_1)
* [Get enabled UNIX account](#get-enabled-unix-account)
* [Get all enabled UNIX accounts](#get-all-enabled-unix-accounts)
* [Get all users](#get-all-users)
* [Response](#response_2)
* [Create a network user](#create-a-network-user)
* [Response](#response_3)
* [Enable a UNIX account](#enable-a-unix-account)
* [Response](#response_4)
* [Delete a network user](#delete-a-network-user)
* [Response](#response_5)
* [Disable a UNIX account](#disable-a-unix-account)
* [Response](#response_6)
* [Update a network user](#update-a-network-user)
* [Response](#response_7)
### Resource Operations
#### Get network user
```
GET /v1/users/inet/:name
```
Get a single network user. The *:name* in the URI must be a valid network\
user name.
**Response**
`Status: 200 OK`
```
{
"data": {
"attributes": {
"account": "admin",
"created": "Fri, 21 Jul 2023 06:46:32 GMT",
"last_login": "Fri, 21 Jul 2023 06:46:49 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 all network users
```
GET /v1/users/inet
```
Get all network users.
**Response**
`Status: 200 OK`
```
{
"data": [
{
"attributes": {
"account": "admin",
"created": "Fri, 21 Jul 2023 06:46:32 GMT",
"last_login": "Fri, 21 Jul 2023 06:46:49 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 enabled UNIX account
```
GET /v1/users/unix/:name
```
**Note:** This endpoint has been deprecated and does nothing.
#### Get all enabled UNIX accounts
```
GET /v1/users/unix
```
**Note:** This endpoint has been deprecated and does nothing.
#### Get all users
```
GET /v1/users
```
Get all administrative users.
**Response**
`Status: 200 OK`
```
{
"data": [
{
"attributes": {
"account": "admin",
"created": "Fri, 21 Jul 2023 06:46:32 GMT",
"last_login": "Fri, 21 Jul 2023 06:46:49 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/"
}
}
```
#### Create a network user
```
POST /v1/users/inet
```
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`
* `data.attributes.password`
* The password for this user
* `data.attributes.account`
* Set to `admin` for administrative users and `basic` to read-only users
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.
```
{
"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
}
}
}
```
**Response**
```
Status: 204 No Content
```
#### Enable a UNIX account
```
POST /v1/users/unix
```
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`
* `data.attributes.account`
* Set to `admin` for administrative users and `basic` to read-only users
Here is an example request body enabling the UNIX account *jdoe* for read-only operations.
```
{
"data": {
"id": "jdoe", // Account name
"type": "unix" // Account type
"attributes": {
"account": "basic" // Type of the user account in MaxScale
}
}
}
```
**Response**
```
Status: 204 No Content
```
#### Delete a network user
```
DELETE /v1/users/inet/:name
```
The *:name* part of the URI must be a valid user name.
**Response**
```
Status: 204 No Content
```
#### Disable a UNIX account
```
DELETE /v1/users/unix/:name
```
The *:name* part of the URI must be a valid user name.
**Response**
```
Status: 204 No Content
```
#### Update a network user
```
PATCH /v1/users/inet/:name
```
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.
```
{
"data": {
"attributes": {
"password": "new-password"
}
}
}
```
**Response**
```
Status: 204 No Content
```
*This page is licensed: CC BY-SA / Gnu FDL*
{% @marketo/form formId="4316" %}
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://mariadb.com/docs/maxscale/maxscale-archive/archive/mariadb-maxscale-23-02/mariadb-maxscale-23-02-rest-api/mariadb-maxscale-2302-admin-user-resource.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.