MT-EQuAl REST API
GET user/update
Updates a user account in the MT-EQuAl release installed on the specified hostname.
Endpoint
GET http(s)://hostname/api/user/update
Request Parameters
Request data | Type | Value |
---|---|---|
username | string | Required. The user's name. |
password | string | Required. The user's password. |
string | Required. The user's email. |
|
firstname | string | Optional. The user's first name. |
lastname | string | Optional. The user's last name. |
affiliation | string | Optional. The user's affiliation. |
roles | string | Optional. The user's roles. |
Response
On success, the HTTP status code in the response header is 200
(OK)
and the response is structured in JSON as follow:
{
"header": {
"date": "Date and time of the response generation process",
"description": "Description of the invoked method or error message",
"status": "status/error code",
"message": "sending email notification"
},
"result": {
"X-Api-key": "The access token that grants access to that API",
"user": "The user id"
}
}
Example
curl -X GET "https://hostname/api/user/update?affiliation=ACME" -H "X-Api-Key: {user access token}"
{
"header": {
"date": "Wednesday, 2016-06-08 12:00:44 Europe\/Paris",
"description": "Creates an account in the MT-EQuAl release installed on the specified hostname.",
"status": "200",
"message": "The email has been sent to ellen"
},
"result": {
"username": "jojo",
"firstname": "John",
"lastname": "Smith",
"affiliation": "ACME",
"email": "john@company.com",
}
}