com.launchkey.sdk.http.AuthControllerInterface Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of launchkey-sdk Show documentation

SDK for interacting with the LaunchKey distributed authentication and authorization platform

There is a newer version: 4.0.0

package com.launchkey.sdk.http;

/**
 * Created by adame on 1/23/15.
 */
public interface AuthControllerInterface {
    JSONResponse pingGet();

    JSONResponse authsPost(String launchKeyTime, String publicKey, String userName, boolean session, boolean userPushId);

    JSONResponse pollGet(String launchKeyTime, String publicKey, String authRequest);

    JSONResponse logsPut(String authRequest, String launchKeyTime, String publicKey, String action, boolean status);

    /**
     * Create a LaunchKey user
     *  
     * @param launchKeyTime LaunchKey time from the most recent poll request
     * @param publicKey LaunchKey pubic key from the most recent poll request
     * @param identifier How the user is identified to your application. This should be a static value such as a
     * user's ID or UUID value rather than an email address which may be subject to change, This identifier will be used
     * authenticate the user as well as pair devices additional devices to the user's account within your white label
     * group.
     * @return JSON response whose JSONObject contains the following on success:
     *    qrcode - The URL to a QR Code for the device to scan
     *    code - Manual code for the user to type into their device if they are unable to scan the QR Code
     */
    JSONResponse usersPost(String launchKeyTime, String publicKey, String identifier);

    void setAppKey(String appKey);

    String getAppKey();

    void setSecretKey(String secretKey);

    String getSecretKey();

    void setPrivateKey(String privateKey);

    String getPrivateKey();
}