MT-EQuAl REST API
GET user/create
Creates a user account with the specified username, password, and email. Username and email must be unique.
Endpoint
GET http(s)://hostname/api/user/create
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. |
role | string | Optional. The user's role. |
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",
"id": "The user's id",
"email": "The user's email",
"username": "The user's username"
}
}
Example
curl -X GET "https://hostname/api/user/create?username=ellen&email=ellen@company.com&password=xyz"
{
"header": {
"date": "Wednesday, 2016-06-08 12:00:44 Europe\/Paris",
"description": "Creates a user account with the specified username, password, and email. Username and email must be unique.",
"status": "200"
},
"result": {
"X-Api-key": "2065485420-15759886cafaax",
"id": 3,
"email": "ellen@company.com",
"username": "ellen"
}
}