InternalSecuritySettings

Method Summary
boolean	addEmailAddress(String emailAddress) Registers the email address for this user.
boolean	deferPasswordRule() If permitted, this defers changing of the password for the life of the session. On success you should exit the user to the profile requested in getPasswordRule
boolean	deleteAccount() Schedules the user account for deletion. Returns false on failure. Call c.getError() to find reason for failure. Note- this will always return true in test mode but will not actually delete the account.
boolean	deleteEmailAddress(String emailAddress) Deletes the email address from this user. The default email address is also the profile email address so it cannot be deleted.
	deletePWA(String guid) Deletes the PWA.
	deleteThirdPartySSO(String ssoId) Deletes the specified third party single sign on
	disableOtp() Disables OTP
String	enableExclusiveThirdPartySSO(String ssoId) Enables the specified third party single sign on. This will return a URL which you should use to immediate log the user out.
	enableOtp(String secretKey) Enables OTP with the secretKey. See EncryptionUtil.createOtpAuth.
	enableThirdPartySSO(String ssoId, boolean enabled) Enables the specified third party single sign on
String	getAlias() Returns this user's unique public alias (which might be null).
DataList	getEmails() Returns a list of all email addresses associated with this user.
SystemDataView	getOwnedEnterprises() Returns the enterprises where this user is the owner.
SystemDataView	getPWAList() Returns the installed PWA SystemDataView.
Data	getPasswordRule() Returns information on the password rule for this user including which enterprise profile to advance to once the rule is satisfied.
Data	getQuestions() Returns the user's security questions.
SystemDataView	getSecurityLogs() Returns the security logs associated with this user.
Data	getSettings() Returns the user's security settings.
SystemDataView	getThirdPartySSOList() Returns third party SSO list for this user.
String	getUsername() Returns the user's username. Only accessible from system profile manager pal.
boolean	resendValidateCode(String emailAddress) Emails the validation code again for this user. Returns false if already validated or email does not belong to the user.
boolean	setAlias(String alias, boolean persist) Sets the alias for this user. The alias must be globally unique and cannot be the username or password of this user. Requires Secure Field in the Pal: cp-alias
boolean	setDefaultEmailAddress(String emailAddress) Sets the email address as the profile default. On success, you should reload any visible email list.
	setPWAEnabled(boolean enabled) Enables/disables PWA.
boolean	setPassword(Data data, boolean persist) Changes the user's password. Returns false if the password does not meet requirements.This method gets the password information from the Data using names: currentPassword, newPassword, and confirmPassword. These fields must exist as Secure Fields in the Pal.
Data	setQuestions(Data data, boolean persist) Sets the user's security questions. Returns updated (real or temporary depending on persist parameter) questions.
Data	setSettings(Data data, boolean persist) Sets the user's security settings. Returns updated (real or temporary depending on persist parameter) settings.
boolean	setUsername(Data data, boolean persist) Changes the user's username. Returns false if the username does not meet requirements.This method gets the username/password information from the Data using parameter names: currentPassword and newUsername. These fields must exist as Secure Fields in the Pal.
String	toString() Returns a description of this object.
boolean	validateEmailAddress(String emailAddress, String code) Validates the email address.

Method Detail

---

boolean addEmailAddress(String emailAddress)

Registers the email address for this user.

Parameters:

• String   emailAddress Required parameter.

Returns:  boolean

Since: 06-05-2012

---

boolean deferPasswordRule()

If permitted, this defers changing of the password for the life of the session. On success you should exit the user to the profile requested in getPasswordRule

Returns:  boolean

Since: 11-05-2015

---

boolean deleteAccount()

Schedules the user account for deletion. Returns false on failure. Call c.getError() to find reason for failure. Note- this will always return true in test mode but will not actually delete the account.

Returns:  boolean

Since: 09-21-2012

---

boolean deleteEmailAddress(String emailAddress)

Deletes the email address from this user. The default email address is also the profile email address so it cannot be deleted.

Parameters:

• String   emailAddress Required parameter.

Returns:  boolean

Since: 06-05-2012

---

deletePWA(String guid)

Deletes the PWA.

Parameters:

• String   guid Required parameter.

Since: 10-14-2021

---

deleteThirdPartySSO(String ssoId)

Deletes the specified third party single sign on

Parameters:

• String   ssoId Required parameter.

Since: 07-31-2018

---

disableOtp()

Disables OTP

Since: 01-03-2020

---

String enableExclusiveThirdPartySSO(String ssoId)

Enables the specified third party single sign on. This will return a URL which you should use to immediate log the user out.

Parameters:

• String   ssoId Required parameter.

Returns:  String

Since: 01-11-2021

---

enableOtp(String secretKey)

Enables OTP with the secretKey. See EncryptionUtil.createOtpAuth.

Parameters:

• String   secretKey Required parameter.

Since: 01-03-2020

---

enableThirdPartySSO(String ssoId, boolean enabled)

Enables the specified third party single sign on

Parameters:

• String   ssoId Required parameter.
• boolean   enabled

Since: 07-31-2018

---

String getAlias()

Returns this user's unique public alias (which might be null).

Returns:  String

Since: 05-29-2012

---

DataList getEmails()

Returns a list of all email addresses associated with this user.

Returns:  DataList

DataList Name: emails
DataList Fields: email, validated, defaultAddress

Since: 06-07-2012

---

SystemDataView getOwnedEnterprises()

Returns the enterprises where this user is the owner.

Returns:  SystemDataView

DataList Name: OwnedEnterprises
Tag Support: No

DataList Keys/Column Name	Column Type	Read Only
id	String
name	String
address	String
city	String
state	String
zip	String
country	String
phone	String
resellerClientCode	String
invoiceDay	Number
createDate	Date

Since: 09-11-2012

---

SystemDataView getPWAList()

Returns the installed PWA SystemDataView.

Returns:  SystemDataView

DataList Name: PWAList
Tag Support: No

DataList Keys/Column Name	Column Type	Read Only
guid	String
enabled	Boolean
createDate	Date
lastAccess	Date
testPal	Boolean
palName	String
enterprise	String

Since: 10-14-2021

---

Data getPasswordRule()

Returns information on the password rule for this user including which enterprise profile to advance to once the rule is satisfied.

Returns:  Data

Since: 11-05-2015

---

Data getQuestions()

Returns the user's security questions.

Returns:  Data

Since: 05-29-2012

---

SystemDataView getSecurityLogs()

Returns the security logs associated with this user.

Returns:  SystemDataView

DataList Name: UserSecurityLogs
Tag Support: No

DataList Keys/Column Name	Column Type	Read Only
id	String
description	String
createDate	Date
eventType	String

Since: 09-11-2012

---

Data getSettings()

Returns the user's security settings.

Returns:  Data

Since: 05-29-2012

---

SystemDataView getThirdPartySSOList()

Returns third party SSO list for this user.

Returns:  SystemDataView

DataList Name: ThirdPartySSO
Tag Support: No

DataList Keys/Column Name	Column Type	Read Only
guid	String
provider	String
enabled	Boolean
createDate	Date
lastAccess	Date
testPal	Boolean
palName	String
enterprise	String

Since: 07-31-2018

---

String getUsername()

Returns the user's username. Only accessible from system profile manager pal.

Returns:  String

Since: 05-29-2012

---

boolean resendValidateCode(String emailAddress)

Emails the validation code again for this user. Returns false if already validated or email does not belong to the user.

Parameters:

• String   emailAddress

Returns:  boolean

Since: 06-07-2012

---

boolean setAlias(String alias, boolean persist)

Sets the alias for this user. The alias must be globally unique and cannot be the username or password of this user. Requires Secure Field in the Pal: cp-alias

Parameters:

• String   alias
• boolean   persist  - Pass true for production, false when developing to keep your username from changing..

Returns:  boolean

Since: 05-29-2012

---

boolean setDefaultEmailAddress(String emailAddress)

Sets the email address as the profile default. On success, you should reload any visible email list.

Parameters:

• String   emailAddress Required parameter.

Returns:  boolean

Since: 06-05-2012

---

setPWAEnabled(boolean enabled)

Enables/disables PWA.

Parameters:

• boolean   enabled Required parameter.

Since: 10-14-2021

---

boolean setPassword(Data data, boolean persist)

Changes the user's password. Returns false if the password does not meet requirements.This method gets the password information from the Data using names: currentPassword, newPassword, and confirmPassword. These fields must exist as Secure Fields in the Pal.

Parameters:

• Data   data Required parameter.
• boolean   persist  - Pass true for production, false when developing to keep your password from changing..

Returns:  boolean

Since: 05-29-2012

---

Data setQuestions(Data data, boolean persist)

Sets the user's security questions. Returns updated (real or temporary depending on persist parameter) questions.

Parameters:

• Data   data Required parameter.
• boolean   persist  - Pass true for production, false when developing to keep your username from changing..

Returns:  Data

Since: 05-29-2012

---

Data setSettings(Data data, boolean persist)

Sets the user's security settings. Returns updated (real or temporary depending on persist parameter) settings.

Parameters:

• Data   data Required parameter.
• boolean   persist  - Pass true for production, false when developing to keep your username from changing..

Returns:  Data

Since: 05-29-2012

---

boolean setUsername(Data data, boolean persist)

Changes the user's username. Returns false if the username does not meet requirements.This method gets the username/password information from the Data using parameter names: currentPassword and newUsername. These fields must exist as Secure Fields in the Pal.

Parameters:

• Data   data Required parameter.
• boolean   persist  - Pass true for production, false when developing to keep your username from changing..

Returns:  boolean

Since: 05-29-2012

---

String toString()

Returns a description of this object.

Returns:  String

Since: 05-29-2012

---

boolean validateEmailAddress(String emailAddress, String code)

Validates the email address.

Parameters:

• String   emailAddress Required parameter.
• String   code Required parameter.

Returns:  boolean

Since: 06-05-2012