|
|
Method Detailboolean createAccount(String firstName, String lastName, String email, String ssoToken) Registers the user account with the cloud. Returns false if the email or token is already registered. Requires cloud level configuration and partner settings. Before calling this method, grant console access. On success, return this response for immediate access to console. For optimal security, the email address should be validated using other means before calling this method. No validation is done on the validity of the email other than checking for uniqueness.
Parameters:
Returns: boolean Since: 07-31-2018 This method has been deprecated since 01-11-2021. Use RuntimePal.createAuthToken() Data getData() Returns the Data object for this response. Returns: Data Since: 09-09-2009 boolean grantConsoleAccess(String palId, String action) Grants access to the Console Pal specified by palId once the user has authenticated. Returns false if the specified Pal does not permit Console access. This does not create a user packet.
Parameters:
Returns: boolean Since: 04-30-2009 requireEmail(String email) If the user will be creating a new account, this method requires that the account use this email address.
Parameters:
Since: 01-15-2010 saveAuthToken(String ssoToken) On successful login, associates the sso token with the user account. Requires cloud level configuration and partner settings.
Parameters:
Since: 07-31-2018 boolean setAuthCloud(String domain) Sets the cloud settings based on the given domain. Returns false if not found.
Parameters:
Returns: boolean Since: 04-07-2021 boolean setAuthToken(String ssoToken) Bypass the login screen and automatically log in the user who is associated with the specified token. Requires cloud level configuration and partner settings. Returns false if no matching token is found.
Parameters:
Returns: boolean Since: 07-31-2018 This method has been deprecated since 01-11-2021. Use useAuthToken(SSOToken) setCancelUrl(String url) Specifies the url the user should be taken to if unable to log in. If this is set, a cancel button will be shown on the login screen.
Parameters:
Since: 05-14-2009 boolean setDynamicCss(String css) Injects the given dynamic CSS into the login process. This feature requires cloud-level configuration.
Parameters:
Returns: boolean Since: 03-10-2021 boolean setHeadless(boolean runHeadless) If set to true, the console pal application will run without the standard console desktop.
Parameters:
Returns: boolean Since: 01-11-2011 boolean setIcon(String css) Injects the given iconUrl into the login process. This feature requires cloud-level configuration and the URL must start with https.
Parameters:
Returns: boolean Since: 10-26-2022 setInviteCode(String inviteCode) If this response is destined for the store, you can pass an inviteCode using this method.
Parameters:
Since: 08-07-2009 boolean setLoginPage(String loginPage) Sets the login page for this response. The loginPage must be of type login.
Parameters:
Returns: boolean Since: 11-01-2010 boolean setLogo(String logoName) Sets the logo to show, returning false on a logo not found. The logo must belong to the enterprise associated with the grantId and must be enabled, therefore call grantConsoleAccess first.
Parameters:
Returns: boolean Since: 01-20-2021 setLogout(String url) Sets the logout url for the console desktop. Requires cloud level configuration and partner settings or if using the secure url of the active pal, the active pal must be running on a secure url.
Parameters:
Since: 07-31-2018 showConsoleMenu(boolean show) Show or hide console left menu. By default it is visible.
Parameters:
Since: 09-09-2009 showCreateAccount(boolean show) Show or hide the create account button. Default is true (show).
Parameters:
Since: 05-14-2009 showLogin(boolean show) Show or hide the create login button. Default is true (show). If false, showCreateAccount(true) should be called.
Parameters:
Since: 07-05-2017 boolean switchToInstalledPal(String storeId) Upon successful authentication, launch the Console Pal if any that is associated with the user and store. The profile search order is that specified by the Pal settings (Console Profile) in Pal Manager. This method can be called more than once. The platform will attempt to find the best match.
Parameters:
Returns: boolean Since: 10-06-2009 boolean switchToPalStore(String storeId) Upon successful authentication, launch the Pal store in console with the specified Store item.
Parameters:
Returns: boolean Since: 08-07-2009 boolean switchToProductStore(String productGuid, String palId, boolean integrated) Upon successful authentication, launch the Pal store in console with the specified product item. The required parameter is the Product guid NOT the encrypted product ID. If integrated is true, the browser is running embedded and an external installer will handle the final install link.
Parameters:
Returns: boolean Since: 08-07-2009 String toString() Returns a description of this object. Returns: String Since: 04-30-2009 useAuthToken(SSOToken ssoToken) Bypass the login screen and automatically log in the user who is associated with the specified token. Requires cloud level configuration and partner settings. Returns false if no matching token is found.
Parameters:
Since: 01-11-2021 validateEmail(boolean validateEmail) Used in conjunction with creating a new user account. If this is true, we will validate the email address of the user as part of the registration process. Default is false.
Parameters:
Since: 05-14-2009 |
||||||||||||||||||||||||||||||||||||||||||||||||||
| Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. | API Date: Dec 03, 2024 10:24 AM |