Contents x
    Liquit.Login
    • 12 Dec 2023
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Liquit.Login

    • Updated on 12 Dec 2023
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Article Summary

    The Liquit.Login function allows you to connect to the Liquit Workspace API with provided credentials. You can specify the identity source, username and password required to authenticate to the Liquit Workspace.

    Request parameters

    You need to specify at least a username and password to authenticate to the Liquit Workspace.

    The following parameters are available for the API:

    NameDescriptionDefault value
    identitySourceThis is the name of the identity source to authenticate the user with. Leave null for default identity source.null
    usernameThe login username used to authenticate the user.null
    passwordThe login password used to authenticate the user.null
    callbackInvoked after someone tries to log in. If the login is successful, a token is generated. If the login is not successful, the response will contain an object called "fault" with a description of what caused the failure.null

    Example

    Liquit.Login({
    identitySource: 'LOCAL',
    username : 'admin',
    password: 'password',
    callback: function (token, fault) {
    
        // Check if the request failed.
        if (fault != null) {
            alert('Error ' + fault.code + ': ' + fault.message);
            return;
        }
        
        // Call Liquit.Applications.List API to retrieve all available applications for the logged-in user.
    
    }
});
    Was this article helpful?
    What's Next