Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%CSP] >  [UI] >  [Portal] >  [OAuth2] >  [Server] >  [Client]
Private  Storage   

class %CSP.UI.Portal.OAuth2.Server.Client extends %CSP.UI.Portal.Template

Page to define OAuth2 server clients which have registered with the authorization server.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 9 26


Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition %import %includeFiles %page
%resource ClientId EditPage FirstFailed
HelpAddress ISREADONLY InvalidParam IsEMSReadOnly
IsEditForm LocatorHeader NAMESPACE NumTabs
OnclickArray PID ParentURL StdTitle
ValidationErrorMsg aboutPage addRedirectURL align
aux backgroundTimerInterval cellAlign cellSize
cellStyle cellVAlign children composite
contactPage containerStyle cssLevel currIndex
currSortMode currStep currViewMode disabled
dragAndDrop dragEnabled dropEnabled enableAutoRefresh
enclosingClass enclosingStyle error groupClass
groupStyle height hidden hint
hintClass hintStyle home homePage
id index isNew jwksAvailable
label labelClass labelDisabledClass labelPosition
labelStyle layout lblTitle limitPopups
name onafterdrag onbeforedrag onclick
ondrag ondrop onhide onrefresh
onshow onupdate pageModified parent
searchKey showLabel slice title
tuple useSVG useSoftModals valign
visible width window zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddLocatorLinks %AddToSaveSet %ApplyURLParms
%Attr %BindExport %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DrawAutoLogout %DrawClassDefinitions %DrawComponentHTML %DrawHTML
%DrawHTMLPage %DrawJSStrings %DrawObjectDefinitions %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetHomePage
%GetHomeParam %GetLinks %GetLocatorLinks %GetPageName
%GetParameter %GetProductName %GetValueById %GetValueByName
%GetXMLName %IsA %IsModified %Link
%LinkCSS %LinkScript %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication %OnCreatePage
%OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody %OnDrawHTMLHead
%OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask %OnGetPageName
%OnGetProductName %OnGetSmallMenu %OnGetTitle %OnMonitorBackgroundTask
%OnMutateChildren %OnObjectSynch %OnPreHTTP %OnSubmit
%OnUseSoftModals %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %Register %RemoveChild
%RemoveChildren %RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod
%Self %SerializeObject %SetBackgroundMethodStatus %SetErrorById
%SetErrorByName %SetModified %SetValueById %SetValueByName
%SetValuesByName %StartScript %ValidateObject %ZENVersion
BuildMenu CheckAllBlanks CheckContextLinks CheckEnterpriseManager
ClientTypeModified ConvertParameter Decrypt DoLogout
DrawLocator DrawRibbon DrawTitle Encrypt
EscapeHTML EscapeURL EvalResult GetCSPURL
GetContextLinks GetDocURL GetHomePage GetNewURL
GetPublicJWKS GetQuickLinks HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
JavaInstalled Link OnDrawRibbon OnGetRibbonInfo
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS RegisterRecent RewriteURL SaveData
ShowError StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL UpdateJWKS XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore afterSave afterValidate
browseSelect cancelPopup cancelRedirectURL changeAuthType
changePassword childrenMutated correctIELayering createComponent
createComponentNS deleteComponent disableCommandButton doCancel
doJWTChange doModified doSave doUpdateJWKS
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler enableCommandButton endModal
exposeComponent findElement fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction getChildIndex getComponent
getComponentById getEnclosingDiv getHidden getHintElement
getLabelElement getOpener getPageTitle getProperty
getSettings getTitleAreaHeight getType goHome
goMenu gotoNamespace gotoPage hideCommandButton
invokeSuper isButtonDisabled isOfType launchPopupWindow
logout makeId modified navigate
newRedirectURL onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondisabledHandler onhandleAutoLogoutWarn onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler onoverlayHandler
onresizeHandler onunloadHandler onupdateHandler popupActionHandler
refreshContents removeChild removeRedirectURL render
renderContents renderSVG resetMsg saveRedirectURL
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress selectRedirectURL setComponentId setConnectivityStatusMsg
setHidden setModified setOverlayMode setPageTitle
setProperty setPropertyAll setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler showAbout
showCommandButton showContact showDocumentation showHelp
showHide showMsg startModal startProgressBar
stopProgressBar switchNamespace tabChanged trimSpace
validateRequired


Parameters

• parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
• parameter CSPURL = "/csp/sys/sec/%CSP.UI.Portal.OAuth2.Server.Client.zen";
This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
• parameter HELPADDRESS = "System Administration,Security,OAuth2,Server Client Configuration";
Each SMP page should set this link which points to the documentation anchor name.
• parameter PAGENAME = "OAuth 2.0 Authorization Server Client Configuration";
Displayed name of this page.
• parameter RECENT = 0;
If true, register visits to this page in the recent list.
• parameter RESOURCE = "%Admin_OAuth2_Registration";
Security requirement

Properties

• property ClientId as %String(ZENURL="ClientId");
ID for edit. Null if adding new client.
• property EditPage as %String [ InitialExpression = ..Link("%25CSP.UI.Portal.OAuth2.Server.Client.zen",,1) ];
• property IsEditForm as %Boolean [ InitialExpression = 1 ];
If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.
• property NAMESPACE as %ZEN.Datatype.string(ZENURL="$NAMESPACE");
• property NumTabs as %Integer [ InitialExpression = 4 ];
• property addRedirectURL as %Boolean [ InitialExpression = 1 ];
• property currIndex as %Integer;
• property isNew as %Boolean;
• property jwksAvailable as %Boolean;

Methods

• method %GetLocatorLinks(Output pLink) as %Status
pLink(n)=$LB(caption,link)
• method %OnAfterCreatePage() as %Status
This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
• method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
• method ClientTypeModified() [ Language = javascript ]
• classmethod GetPublicJWKS(pFile, Output pFileContent) as %Boolean
Check if file exists. If it does then return the content of the file. Else return error message.
• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
• classmethod SaveData(pValueProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
• classmethod UpdateJWKS(pValueProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Call UpdateJWKS method
• method browseSelect(name) [ Language = javascript ]
User clicked one of the Browse buttons. Save the name of the textfield so that when you return you know which textfield to update.
• method cancelRedirectURL() [ Language = javascript ]
• method changeAuthType() [ Language = javascript ]
User changed Authentication Type. Show/hide authorization signing algorithm.
• method doCancel() [ Language = javascript ]
This method resets the modified indicator and return user to the parent page.
• method doJWTChange(selection) [ Language = javascript ]
Show/hide fields after user selected a JWT option
• method doSave(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
• method doUpdateJWKS() [ Language = javascript ]
Retrieve an updated public JWKS
• method modified() [ Language = javascript ]
• method newRedirectURL() [ Language = javascript ]
User clicked the Add URL button to add a new Redirect URL.
Clear the textbox to allow user to enter a new one.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when the a popup page launched from this page fires an action.
• method onlayoutHandler(load) [ Language = javascript ]
This method is necessary for the svgTabArea and tabBar to show properly.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.
• method removeRedirectURL() [ Language = javascript ]
User clicked the Remove button to remove an entry from the listbox.
• method saveRedirectURL() [ Language = javascript ]
User clicked the OK button to save a Redirect URL.
Clear list selection and hide the edit fields afterwards.
• method selectRedirectURL() [ Language = javascript ]
User clicked an existing redirect url from the listbox.
Set the value into the textbox for editing or removing.
• method showHide(fieldName) [ Language = javascript ]
• method tabChanged(index) [ Language = javascript ]

Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.