Revokes the role from the user in the specified project.

Endpoint

GET http(s)://hostname/api/user/revoke

Request Parameters

Header field
Type Value
X-Api-Key
string Required. A valid access token from a registered MT-EQuAl account. The access token must have been issued on behalf of the current user.

Request data Type Value
id string Required. The project id.

username string Required. The user name.

role string Required. The role to revoke to the specified user.

email {1,0} Optional. 1 to specify that an email must be sent to notify the revocation; 0 otherwise. Default is 0.

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"
	},
	"result": {
		"role": "The user's role within the specified project",
		"role_status": "The request status",
		"user": "The user id",
		"email": "The email address used to notify the revocation, if specified"
	}
}

Example

curl -X GET "https://hostname/api/project/invite?id=1&username=ellen&role=evaluator" -H "X-Api-Key: {user access token}"
{
	"header": {
		"date": "Wednesday, 2016-06-08 12:00:44 Europe\/Paris",
		"description": "Revokes the role from the user in the specified project.",
		"status": "200"
	},
	"result": {
		"role": "evaluator",
		"role_status": "revoked",
		"user": 3
	}
}