Login

Authenticates the user and returns the hash that the user has to use for future requests.

This also sets a cookie for future sessions.

Action	Version	Supported
login	1.5	-

Error Codes

ErrorID	Cause of Error
1	The “username” parameter was set but empty
1	The “password” parameter was set but empty
1	The “ip_address” parameter was set but empty
3	The “username” parameter was not set
3	The “password” parameter was not set
3	The “ip_address” parameter was not set
4	The “username” parameter is not a registered user
5	Wrong username or password

Request

api.php?action=authenticate&username=USERNAME&password=PASSWORD&ip_address=IP_ADDRESS

api.php?action=authenticate&username=USERNAME&password=PASSWORD

Example

api.php?action=authenticate&username=cadox8&password=password&ip_address=127.0.0.1

api.php?action=authenticate&username=cadox8&password=password

public class Xen {
    public static void main(String... args) {
        final XenAPI api = new XenAPI("e65ef8da-ca6a-437c-ab8b-4b2e9e86cd10", "http://localhost/forum");

        final Request r = RequestBuilder.newRequest(RequestType.LOGIN).addParam(RequestParam.AUTH_USER, "cadox8").addParam(RequestParam.AUTH_PASS, "password").createRequest();

        api.getReply(r, (Callback<LoginReply>) (failCause, result) -> {
            try {
                result.checkError();
                if (failCause != null) failCause.printStackTrace();
                System.out.println("Result: " + result.toString());
            } catch (ArgsErrorException e) {
                e.printStackTrace();
            }
        });
    }
}

Reply

{
  "hash": "JDJhJDEwJEd4U2xRQUNNTVJnTzFOM282anZYd08wRk1DTC52NFJtYWtDVHZaNHo1SUZvR0hzUVpLTkU2"
}