SSOToken

Method Summary
boolean	deleteAuthToken(boolean deleteAccount) Deletes the SSOToken identified and associated with this pal. If deleteAccount is true and the user is the active user, you should immediately log the user out.
String	getEmail() Returns the email address associated with this token.
String	getFirstName() Returns the first name of the profile associated with this token.
String	getId() Returns the ID of this token
String	getLastName() Returns the last name of the profile associated with this token.
String	getLogoutUrl() Returns the logout URL.
String	getProfileId() Returns the profileId associated with this token.
String	getProvider() Returns the provider name.
boolean	isEnabled() Returns true if the token is enabled.
boolean	isExclusive() Returns true if exclusive is enabled.
boolean	isRedirect() Returns true if redirect is enabled.
	rejectExclusive() Disconnects exclusive from this token which gives the user 'normal' access to this cloud.
boolean	setEmail(String email) Sets the email of the profile associated with this token. Returns false if the email is not unique or otherwise invalid. See c.getError() on failure.
	setFirstName(String firstName) Sets the first name of the profile associated with this token.
	setLastName(String lastName) Sets the last name of the profile associated with this token.
	setLogoutUrl(String url) Sets logout URL. Must start with https.
	setProvider(String provider) Sets provider associated with this token.
	setRedirect(boolean redirect) Sets whether redirect should occur on the login screen rather than error notice. This requires setLogoutUrl to be set.
String	toString() Returns a description of this object.

Method Detail

---

boolean deleteAuthToken(boolean deleteAccount)

Deletes the SSOToken identified and associated with this pal. If deleteAccount is true and the user is the active user, you should immediately log the user out.

Parameters:

• boolean   deleteAccount

Returns:  boolean

Since: 01-11-2021

---

String getEmail()

Returns the email address associated with this token.

Returns:  String

Since: 01-11-2021

---

String getFirstName()

Returns the first name of the profile associated with this token.

Returns:  String

Since: 01-11-2021

---

String getId()

Returns the ID of this token

Returns:  String

Since: 02-24-2022

---

String getLastName()

Returns the last name of the profile associated with this token.

Returns:  String

Since: 01-11-2021

---

String getLogoutUrl()

Returns the logout URL.

Returns:  String

Since: 01-11-2021

---

String getProfileId()

Returns the profileId associated with this token.

Returns:  String

Since: 05-02-2022

---

String getProvider()

Returns the provider name.

Returns:  String

Since: 01-11-2021

---

boolean isEnabled()

Returns true if the token is enabled.

Returns:  boolean

Since: 01-11-2021

---

boolean isExclusive()

Returns true if exclusive is enabled.

Returns:  boolean

Since: 01-11-2021

---

boolean isRedirect()

Returns true if redirect is enabled.

Returns:  boolean

Since: 01-11-2021

---

rejectExclusive()

Disconnects exclusive from this token which gives the user 'normal' access to this cloud.

Since: 01-11-2021

---

boolean setEmail(String email)

Sets the email of the profile associated with this token. Returns false if the email is not unique or otherwise invalid. See c.getError() on failure.

Parameters:

• String   email Required parameter. Maximum allowed size of parameter: 255

Returns:  boolean

Since: 01-11-2021

---

setFirstName(String firstName)

Sets the first name of the profile associated with this token.

Parameters:

• String   firstName Required parameter. Maximum allowed size of parameter: 30

Since: 01-11-2021

---

setLastName(String lastName)

Sets the last name of the profile associated with this token.

Parameters:

• String   lastName Required parameter. Maximum allowed size of parameter: 30

Since: 01-11-2021

---

setLogoutUrl(String url)

Sets logout URL. Must start with https.

Parameters:

• String   url Maximum allowed size of parameter: 255

Since: 01-11-2021

---

setProvider(String provider)

Sets provider associated with this token.

Parameters:

• String   provider Maximum allowed size of parameter: 80

Since: 01-11-2021

---

setRedirect(boolean redirect)

Sets whether redirect should occur on the login screen rather than error notice. This requires setLogoutUrl to be set.

Parameters:

• boolean   redirect Required parameter.

Since: 01-11-2021

---

String toString()

Returns a description of this object.

Returns:  String

Since: 01-11-2021