/config/user

The user accounts.

Each user account has a name, a set of privileges, and the credentials (password) required to log into the account.

Get /config/user

SecurityApiKey

Request

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

Request samples

curl
Python
JavaScript
Go

Response samples

application/json

{"result": {"jsmith": {"priv": ["unlimited_save",
"view_settings"
]
},
"guest": {"priv": ["view_settings"
]
}
},
"error": "Error message (present if an error occurred)."
}

Replace /config/user

SecurityApiKey

Request

Request Body schema: application/json

additional property

object (configUserName)

A user configuration (account).

Responses

200

Normal response.

401

Unauthorized response.

put/config/user

Request samples

Payload
curl
Python
JavaScript
Go

application/json

{"jsmith": {"priv": ["unlimited_save",
"view_settings"
]
},
"guest": {"priv": ["view_settings"
]
}
}

Response samples

application/json

{"status": "OK",
"error": "Error message (present if an error occurred)."
}

Update /config/user

SecurityApiKey

Request

Request Body schema: application/json

additional property

object (configUserName)

A user configuration (account).

Responses

200

Normal response.

401

Unauthorized response.

post/config/user

Request samples

Payload
curl
Python
JavaScript
Go

application/json

{"jsmith": {"priv": ["unlimited_save",
"view_settings"
]
},
"guest": {"priv": ["view_settings"
]
}
}

Response samples

application/json

{"status": "OK",
"error": "Error message (present if an error occurred)."
}

Delete /config/user

Delete all user accounts.

SecurityApiKey

Responses

200

Normal response.

401

Unauthorized response.

delete/config/user

Request samples

curl
Python
JavaScript
Go

Response samples

application/json

{"status": "OK",
"error": "Error message (present if an error occurred)."
}

➔ Next to /config/user/{name}