User section allows to read and modify all the created users in the system. The available APIs are the following:
For each of them there is an explanation in the UI of the purporse of the API and of the meaning of the parameters.
The black locker in the top-right corner means that credentials have been provided, but password checks is performed only when you execute the api, so only in that case you receive an error if you are not allowed to execute that api or the username/password are wrong.
Fetch a user configuration
This API ask only one parameter, userID, that is required to execute it. If you click on Execute button, you get the reponse:
Response is a JSON object containing 3 attributes:
Attribute | Description |
|---|---|
result | Returns if the api has been executed successfully |
retrievedObj | In case of success the object retrieved |
err | In case of failure, the error description |
The object structure is described in the schema section:
Create a new user
To create a new user, use the insertusesr api
This api does not require any parameter, but you need to provide the body of the request.
The interface provides an example of body, that has to be changed with the desidered values.
ID is the unique username
password is the plain text password (it’s automatically stored the hash value)
roles is an array of strings. You can assign multiple roles to the same user