Internal Console API

InternalSupportProfile extends ProfileInfo

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

Tag

TagFilter

TagManager

TextEmail

TextMessage

TiffBuilder

TransactionPacket

TransactionUtil

Tunnel

TunnelResult

UnknownFile

Upload

User

VCardFile

Validator

ValidityCheck

Wizard

WorkflowResponse

XMLReader

ZoneAccess

Method Summary
boolean changePassword(String tempPassword, String newPassword)

Sets the new password for the user. Requires cloud level configuration and is not permitted for system accounts.

ProfilePacket createPacket()

Returns the ProfilePacket associated with this Console Pal or creates one if it does not exist. Each user of the Console Pal has a single ProfilePacket. This will return null if the user has not been granted console access or otherwise has group access to console.

  deletePWA(String guid)

Deletes the PWA.

  deletePacket(boolean removeConsoleAccess)

Deletes the ProfilePacket, if any and removes console access (if personal profile).

String generateTempPassword()

Generates a temp password for subsequent save and send (you must call saveTempPassword for this to be useful).

String getBlockedEmails()

Returns a comma separated array of blocked emails or null if no emails are blocked.

Data getData()

Returns a Data object with information from this profile. The amount of information depends on what the user has enabled for public access. Minimum information available is firstName, lastName, and emailAdress and boolean: personal or enterprise.

String getEmailAddress()

Returns the email address associated with this profile.

EnterpriseInfo getEnterprise()

Returns the enterprise that owns this profile or null if it is a personal profile.

String getFirstName()

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

String getFullName()

Returns the combined first and last name of the user associated with this profile.

String getId()

Returns unique ID of profile. Returns null if profile is not registered.

String getLastName()

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

String getName()

Returns the name of the profile.

SystemDataView getPWAList()

Returns the installed PWA SystemDataView.

ProfilePacket getPacket()

Returns the ProfilePacket associated with this User and Pal. Each user of the Console Pal has a single ProfilePacket. This may return null if the user has not been granted console access or otherwise has group access to console.

Payload getSupportInfo()

Gets support information for this account.

String getUserId()

Returns unique ID of the user associated with this profile. Returns null if profile is not registered.

boolean hasConsoleAccess(String palId)

Returns true if this profile can access the specified Console Pal.

boolean hasRole(String role)
⚠Deprecated since 02-07-2011. Use hasRole(String role, String txId)

Returns true if the profile has a role on the active transaction. This method returns false if it is not called from a transaction related context (such as Navigator).

boolean hasRole(String role, String txId)

Returns true if the profile has a role on the specified transaction.

boolean isDefaultProfile()

Returns true if this profile is the default profile for the user.

boolean isEnterprise()

Returns true if this profile is an enterprise profile.

boolean isFloatingLicense()

Returns true if the licenseType for this profile is floating.

boolean isOwnedBy(String domain)

Returns true if this profile is owned by the enterprise that owns specified domain.

boolean isPersonal()

Returns true if this profile is a personal profile.

boolean isSupport()
⚠Deprecated since 05-20-2015. No replacement

Returns true if this profile is a support profile.

boolean isSupportLicense()

Returns true if the licenseType for this profile is support.

boolean isSystem()

Returns true if this profile is a system profile.

boolean isUserLicense()

Returns true if the licenseType for this profile is user.

boolean merge(InternalSupportProfile source)

Merges the source profile into this profile and deletes the source

  rejectExclusive()

Cancels the exclusive status of the account as set by 3rd party SSO tokens.

  resetLockout()

Resets the invalid login attempt lockout for this profile.

  restoreAccount()

Cancels the deletion of an account and re-enables all of the profile(s).

  saveTempPassword()

Saves the temp password generated from generateTempPassword.

  sendTempPassword()

Sends a new temporary password to the user.

  setAccountDisabled(boolean disabled)

Disables or enables the user account and all profiles associated with the user account.

  setAccountOptions(Data options)

Sets support related account options.

  setPWAEnabled(boolean enabled)

Enables/disables PWA.

boolean terminate(String reason)

Terminates the user associated with this profile from the system

String toString()

Returns a description of this object.

Method Detail


boolean changePassword(String tempPassword, String newPassword)

Sets the new password for the user. Requires cloud level configuration and is not permitted for system accounts.

Parameters:

  • String   tempPassword Required parameter. Maximum allowed size of parameter: 30
  • String   newPassword Required parameter. Maximum allowed size of parameter: 255

Returns:  boolean

Since: 07-28-2023

top

ProfilePacket createPacket()

Returns the ProfilePacket associated with this Console Pal or creates one if it does not exist. Each user of the Console Pal has a single ProfilePacket. This will return null if the user has not been granted console access or otherwise has group access to console.

Returns:  ProfilePacket

Since: 02-03-2014

top

deletePWA(String guid)

Deletes the PWA.

Parameters:

  • String   guid Required parameter.

Since: 10-14-2021

top

deletePacket(boolean removeConsoleAccess)

Deletes the ProfilePacket, if any and removes console access (if personal profile).

Parameters:

  • boolean   removeConsoleAccess

Since: 02-03-2014

top

String generateTempPassword()

Generates a temp password for subsequent save and send (you must call saveTempPassword for this to be useful).

Returns:  String

Since: 05-18-2015

top

String getBlockedEmails()

Returns a comma separated array of blocked emails or null if no emails are blocked.

Returns:  String

Since: 09-27-2021

top

Data getData()

Returns a Data object with information from this profile. The amount of information depends on what the user has enabled for public access. Minimum information available is firstName, lastName, and emailAdress and boolean: personal or enterprise.

Returns:  Data

Since: 01-19-2009

top

String getEmailAddress()

Returns the email address associated with this profile.

Returns:  String

Since: 03-15-2007

top

EnterpriseInfo getEnterprise()

Returns the enterprise that owns this profile or null if it is a personal profile.

Returns:  EnterpriseInfo

Since: 07-06-2009

top

String getFirstName()

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

Returns:  String

Since: 03-15-2007

top

String getFullName()

Returns the combined first and last name of the user associated with this profile.

Returns:  String

Since: 12-02-2009

top

String getId()

Returns unique ID of profile. Returns null if profile is not registered.

Returns:  String

Since: 02-04-2009

top

String getLastName()

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

Returns:  String

Since: 03-15-2007

top

String getName()

Returns the name of the profile.

Returns:  String

Since: 09-10-2008

top

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

top

ProfilePacket getPacket()

Returns the ProfilePacket associated with this User and Pal. Each user of the Console Pal has a single ProfilePacket. This may return null if the user has not been granted console access or otherwise has group access to console.

Returns:  ProfilePacket

Since: 02-03-2014

top

Payload getSupportInfo()

Gets support information for this account.

Returns:  Payload

Since: 05-18-2015

top

String getUserId()

Returns unique ID of the user associated with this profile. Returns null if profile is not registered.

Returns:  String

Since: 06-29-2011

top

boolean hasConsoleAccess(String palId)

Returns true if this profile can access the specified Console Pal.

Parameters:

  • String   palId

Returns:  boolean

Since: 03-30-2009

top

boolean hasRole(String role)

Returns true if the profile has a role on the active transaction. This method returns false if it is not called from a transaction related context (such as Navigator).

Parameters:

  • String   role Required parameter.

Returns:  boolean

Since: 06-01-2009

This method has been deprecated since 02-07-2011. Use hasRole(String role, String txId)

top

boolean hasRole(String role, String txId)

Returns true if the profile has a role on the specified transaction.

Parameters:

  • String   role Required parameter.
  • String   txId Required parameter.

Returns:  boolean

Since: 06-01-2009

top

boolean isDefaultProfile()

Returns true if this profile is the default profile for the user.

Returns:  boolean

Since: 11-29-2010

top

boolean isEnterprise()

Returns true if this profile is an enterprise profile.

Returns:  boolean

Since: 03-15-2007

top

boolean isFloatingLicense()

Returns true if the licenseType for this profile is floating.

Returns:  boolean

Since: 02-21-2022

top

boolean isOwnedBy(String domain)

Returns true if this profile is owned by the enterprise that owns specified domain.

Parameters:

  • String   domain

Returns:  boolean

Since: 03-15-2007

top

boolean isPersonal()

Returns true if this profile is a personal profile.

Returns:  boolean

Since: 03-15-2007

top

boolean isSupport()

Returns true if this profile is a support profile.

Returns:  boolean

Since: 11-29-2010

This method has been deprecated since 05-20-2015. No replacement

top

boolean isSupportLicense()

Returns true if the licenseType for this profile is support.

Returns:  boolean

Since: 02-21-2022

top

boolean isSystem()

Returns true if this profile is a system profile.

Returns:  boolean

Since: 11-29-2010

top

boolean isUserLicense()

Returns true if the licenseType for this profile is user.

Returns:  boolean

Since: 02-21-2022

top

boolean merge(InternalSupportProfile source)

Merges the source profile into this profile and deletes the source

Parameters:

Returns:  boolean

Since: 05-18-2015

top

rejectExclusive()

Cancels the exclusive status of the account as set by 3rd party SSO tokens.

Since: 01-11-2021

top

resetLockout()

Resets the invalid login attempt lockout for this profile.

Since: 05-18-2015

top

restoreAccount()

Cancels the deletion of an account and re-enables all of the profile(s).

Since: 05-18-2015

top

saveTempPassword()

Saves the temp password generated from generateTempPassword.

Since: 05-18-2015

top

sendTempPassword()

Sends a new temporary password to the user.

Since: 05-18-2015

top

setAccountDisabled(boolean disabled)

Disables or enables the user account and all profiles associated with the user account.

Parameters:

  • boolean   disabled

Since: 05-18-2015

top

setAccountOptions(Data options)

Sets support related account options.

Parameters:

Since: 05-18-2015

top

setPWAEnabled(boolean enabled)

Enables/disables PWA.

Parameters:

  • boolean   enabled Required parameter.

Since: 10-14-2021

top

boolean terminate(String reason)

Terminates the user associated with this profile from the system

Parameters:

  • String   reason

Returns:  boolean

Since: 08-09-2022

top

String toString()

Returns a description of this object.

Returns:  String

Since: 05-18-2015

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: May 01, 2024 05:15 AM