Internal Console API

InternalProfileManager

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

Method Summary
ValidityCheck checkAddProfile(Payload payload)

Sets the details for the specified profile.
String createProfile(String firstName, String lastName, String email, String licenseType)

Creates a new profile. You should then call updateProfile for additional settings and sendInvite to email a profile invitation.
Payload getProfileInfo(String profileId)

Returns details on the specified profile.
SystemDataView getProfiles()

Returns a view for accessing profiles.
boolean joinProfile(String userId, String profileId)

Joins the user to the profile.
SystemDataView searchProfiles(Data criteria)

Returns a view for accessing profiles that match the specified permissions.
  sendInvite(String profileId)

Sends an invitation email to the specified profile.
  setProfileStatus(String profileId, String status)

Sets the status of the profile.
String toString()

Returns a description of this object.
ValidityCheck updateProfile(String profileId, Payload payload)

Sets the details for the specified profile.

Method Detail

ValidityCheck checkAddProfile(Payload payload)

Sets the details for the specified profile.

Parameters:

Returns:  ValidityCheck

Since: 07-17-2023

top
String createProfile(String firstName, String lastName, String email, String licenseType)

Creates a new profile. You should then call updateProfile for additional settings and sendInvite to email a profile invitation.

Parameters:

  • String   firstName Required parameter. Maximum allowed size of parameter: 30
  • String   lastName Required parameter. Maximum allowed size of parameter: 30
  • String   email Required parameter. Maximum allowed size of parameter: 255
  • String   licenseType Required parameter. Allowed values: U, S.

Returns:  String

Since: 07-17-2023

top
Payload getProfileInfo(String profileId)

Returns details on the specified profile.

Parameters:

  • String   profileId Required parameter.

Returns:  Payload

Since: 07-17-2023

top
SystemDataView getProfiles()

Returns a view for accessing profiles.

Returns:  SystemDataView


DataList Name: Profiles
DataList Keys/Column Name Column Type Read Only
profileId String  
auditName String  
firstName String  
lastName String  
email String  
lastAccess Date  
createDate Date  
disabled Boolean  
deleted Boolean  
licenseType String  
uId String  

Since: 11-05-2020

top
boolean joinProfile(String userId, String profileId)

Joins the user to the profile.

Parameters:

  • String   userId
  • String   profileId

Returns:  boolean

Since: 07-17-2023

top
SystemDataView searchProfiles(Data criteria)

Returns a view for accessing profiles that match the specified permissions.

Parameters:

  • Data   criteria Required parameter.

Returns:  SystemDataView


DataList Name: Profiles
DataList Keys/Column Name Column Type Read Only
profileId String  
auditName String  
firstName String  
lastName String  
email String  
lastAccess Date  
createDate Date  
disabled Boolean  
deleted Boolean  
licenseType String  
uId String  

Since: 07-17-2023

top
sendInvite(String profileId)

Sends an invitation email to the specified profile.

Parameters:

  • String   profileId

Since: 07-17-2023

top
setProfileStatus(String profileId, String status)

Sets the status of the profile.

Parameters:

  • String   profileId
  • String   status Allowed values: enabled, disabled, deleted, restored.

Since: 07-17-2023

top
String toString()

Returns a description of this object.

Returns:  String

Since: 11-05-2020

top
ValidityCheck updateProfile(String profileId, Payload payload)

Sets the details for the specified profile.

Parameters:

  • String   profileId Required parameter.
  • Payload   payload

Returns:  ValidityCheck

Since: 07-17-2023

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Dec 03, 2024 10:24 AM