Introduction

Remote Login API, allows automated login and redirection to whichever environment is specified in as the endpoint (See endpoint list for environments).

We have language bindings in Shell, Javascript and Java! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication

To authorize, use this code:

    var data = "username=<USERNAME>&password=<PASSWORD>";

    var xhr = new XMLHttpRequest();
    xhr.withCredentials = true;

    xhr.addEventListener("readystatechange", function () {
        if (this.readyState === this.DONE) {
            window.location = this.responseText;
        }
    });

    xhr.open("POST", "<ENDPOINT>");
    xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
    xhr.setRequestHeader("remote-login", "true");

    xhr.send(data);

public class RemoteLogin {

private final static String endpoint = "<ENDPOINT>";
private OkHttpClient client = new OkHttpClient();

  public Response login(String user, String pass) {
    String credentials = "user=" + user + "&pass=" + pass;

    MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
    RequestBody body = RequestBody.create(mediaType, credentials);
    Request request = new Request.Builder()
      .url(endpoint)
      .post(body)
      .addHeader("content-type", "application/x-www-form-urlencoded")
      .addHeader("remote-login", "true")
      .build();

    Response response = client.newCall(request).execute();
  }

}

curl --request POST \
  --url <ENDPOINT> \
  --header 'content-type: application/x-www-form-urlencoded' \
  --header 'remote-login: true' \
  --data 'username=<USERNAME>&password=<PASSWORD>'

Make sure to replace <USERNAME> & <PASSWORD> with the users actual credentials, and <ENDPOINT> with one for the correct target environment.

Remote login expects for the HTTP header remote-login to be included in all API requests to the server in a header that looks like the following:

remote-login: true

Endpoint

Errors

The Remote Login uses the following error codes: