Authenticate with REST

Authenticate a user with REST.

Method

POST /EAI/api/login

Attempt to authenticate a user.

Example cURL request

curl -X POST -H "Content-Type:application/x-www-form-urlencoded" -d "username=gordita&password=IluvTr3ats!" https://gateway.domain.com/EAI/api/login

Request parameters

Table 1. Request parameters
Parameter name Description
username The user's username.
password The provided password.

Example response

{
"status" : "Authentication successful."
}

Returns

status
200: OK for success.
401: Unauthorized for every other response.
403: Forbidden if the account is locked for any reason.
50X: If error on the server.

Upon success, the user's session cookies are returned as well.