Internal Console API

SSOToken

Other API in Package

Console

Console System

Console Webservice

List of Classes

InternalConsoleController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

CommonPacket

ConsoleManager

ConsolePacket

ConsoleResponse

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

FtpRequest

GeoUtil

GroupConcat

ImageFile

Inspector

Installer

InstallerPal

InternalAcmeService

InternalApiMonitor

InternalAuthManager

InternalCloud

InternalCloudDomain

InternalCloudSubscriptionManager

InternalCloudSubscriptionService

InternalDesktopProduct

InternalDevelopmentPal

InternalDomainManager

InternalEmail

InternalEmailManager

InternalEmailSettings

InternalEnterprise

InternalGroupManager

InternalKey

InternalKeyFeatures

InternalKeyManager

InternalKeyPricing

InternalLogoManager

InternalPalChain

InternalPalInfo

InternalPalManager

InternalPalStore

InternalPalStoreInfo

InternalPalStoreInvite

InternalPalStoreItem

InternalProfile

InternalProfileManager

InternalPseudoKey

InternalRequest

InternalResponse

InternalSecuritySettings

InternalStatBuilder

InternalStatement

InternalStorageManager

InternalStorageProvider

InternalSupportIncident

InternalSupportProfile

InternalSystemInformation

InternalSystemLog

InternalSystemManager

InternalTunnelManager

InternalUser

InternalWebAlias

InternalZone

InternalZoneManager

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

MobileManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

TextEmail

TextMessage

TiffBuilder

TransactionPacket

TransactionUtil

Tunnel

TunnelResult

UnknownFile

Upload

User

VCardFile

Validator

ValidityCheck

Wizard

WorkflowResponse

XMLReader

ZoneAccess

SSOToken is used for accessing secure parts of the platform from a third party authentication system via web pals.

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

top
String getEmail()

Returns the email address associated with this token.

Returns:  String

Since: 01-11-2021

top
String getFirstName()

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

Returns:  String

Since: 01-11-2021

top
String getId()

Returns the ID of this token

Returns:  String

Since: 02-24-2022

top
String getLastName()

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

Returns:  String

Since: 01-11-2021

top
String getLogoutUrl()

Returns the logout URL.

Returns:  String

Since: 01-11-2021

top
String getProfileId()

Returns the profileId associated with this token.

Returns:  String

Since: 05-02-2022

top
String getProvider()

Returns the provider name.

Returns:  String

Since: 01-11-2021

top
boolean isEnabled()

Returns true if the token is enabled.

Returns:  boolean

Since: 01-11-2021

top
boolean isExclusive()

Returns true if exclusive is enabled.

Returns:  boolean

Since: 01-11-2021

top
boolean isRedirect()

Returns true if redirect is enabled.

Returns:  boolean

Since: 01-11-2021

top
rejectExclusive()

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

Since: 01-11-2021

top
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

top
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

top
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

top
setLogoutUrl(String url)

Sets logout URL. Must start with https.

Parameters:

  • String   url Maximum allowed size of parameter: 255

Since: 01-11-2021

top
setProvider(String provider)

Sets provider associated with this token.

Parameters:

  • String   provider Maximum allowed size of parameter: 80

Since: 01-11-2021

top
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

top
String toString()

Returns a description of this object.

Returns:  String

Since: 01-11-2021

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Nov 22, 2024 11:54 AM