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

class %CSP.UI.Portal.OAuth2.Server.Configuration extends %CSP.UI.Portal.Template, %CSP.UI.Component.SelectBoxUtils

Page to define OAuth2 authorization server configuration

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 9 33


Summary

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

Properties
%condition %import %includeFiles %page
%resource AvaRoles ClientPage FirstFailed
HelpAddress ISREADONLY InvalidParam IsEMSReadOnly
IsEditForm LocatorHeader NAMESPACE NumTabs
OnclickArray PID ParentURL SelectedRoles
StdTitle ValidationErrorMsg aboutPage align
aux avaList 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 selList 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
CheckScopeData ConvertParameter Decrypt DeleteConfiguration
DoLogout DrawArrows DrawArrowsOld DrawAvailableList
DrawLocator DrawPageTitle DrawRibbon DrawRoleBoxes
DrawSelectList DrawSupportedScopes DrawTitle DrawUpArrowsOld
Encrypt EscapeHTML EscapeURL EvalResult
GetCSPURL GetContextLinks GetDocURL GetHomePage
GetNewURL GetQuickLinks GetRedirectURLforUI GetScopeData
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate JavaInstalled Link
LoadData OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RegisterRecent RewriteURL Rotate SaveData
ShowError StartTimer StopTimer SupportedScopeExists
ThrowError UnescapeHTML UnescapeURL XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore afterSave afterValidate
cancelPopup cancelRedirectURL changePassword childrenMutated
clearList correctIELayering createComponent createComponentNS
createJWT deleteComponent disableCommandButton doCancel
doClient doDelete doModified doRotate
doSave doSelectBoxMove doSelectBoxMoveAll doSelectBoxMoveItem
doSelectBoxMoveList dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler enableCommandButton
endModal exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getEnclosingDiv getHidden
getHintElement getLabelElement getOpener getPageTitle
getProperty getRedirectURL getSelList getSettings
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPage hideCommandButton invokeSuper
isButtonDisabled isOfType launchPopupWindow logout
makeId modified navigate newSupportedScope
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 removeSupportedScope render renderContents
renderSVG resetMsg saveSupportedScope searchBlur
searchBoxHandler searchFocus searchKeyDown searchKeyPress
selectSupportedScope setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler showAbout showCommandButton
showContact showDocumentation showHelp showJWT
showMsg startModal startProgressBar stopProgressBar
switchNamespace tabChanged trimSpace validatePage
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.Configuration.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 Configuration";
Each SMP page should set this link which points to the documentation anchor name.
• parameter PAGENAME = "OAuth 2.0 Authorization Server Configuration";
Displayed name of this page.
• parameter RECENT = 0;
If true, register visits to this page in the recent list.
• parameter RESOURCE = "%Admin_OAuth2_Server";
Security requirement

Properties

• property AvaRoles as %String;
• property ClientPage as %String [ InitialExpression = ..Link("%25CSP.UI.Portal.OAuth2.Server.ClientList.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 = 5 ];
• property SelectedRoles as %String;
• property currIndex as %Integer;
• property isNew as %Boolean;
• property jwksAvailable as %Boolean;

Methods

• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
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.
• classmethod CheckScopeData(pScope) as %String [ ZenMethod ]
Check to see if the scope name user entering is a duplicate
• classmethod DeleteConfiguration() as %String [ ZenMethod ]
• classmethod DrawPageTitle(pSeed As %String) as %Status
• method DrawRoleBoxes(pSeed As %String) as %Status
• method DrawSupportedScopes(pSeed As %String) as %Status
Manually draw html table for Supported Scopes. %session.Data($Username,"SupportedScopes") represents the current supported scopes. Initially it is sys.SupportedScopes and then it may be edited/added/removed. pSeed represents [Action]/indexnumber/scope/scopeDescription because pSeed can only be %String, we'll have to split it after arriving here. Delimiter is ^ Examples:
add^^newscope name^newscope description edit^1^newscope name^newscope description remove^1^^
• classmethod GetRedirectURLforUI(pAddress, pPort, pPrefix) as %String [ ZenMethod ]
• classmethod GetScopeData(pIndex) as %ZEN.proxyObject [ ZenMethod ]
• method LoadData(sys) as %Status
Used when Editing existing OAuth2 authantication server configuration. Load previously defined values into fields or set defaults.
• 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 Rotate(pValueProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Call RotateKeys method
• classmethod SaveData(pValueProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
• classmethod SupportedScopeExists() [ ZenMethod ]
Check to see if at least one scope is defined. Return 1 if there is.
• method cancelRedirectURL() [ Language = javascript ]
• method createJWT(checked) [ Language = javascript ]
• method doClient() [ Language = javascript ]
• method doDelete(action) as %Boolean [ Language = javascript ]
• method doRotate() [ Language = javascript ]
Rotate keys of JWKS
• 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 getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row.
• method getRedirectURL() [ Language = javascript ]
Get redirect URL upon user changing any of server address/port/prefix.
• method modified() [ Language = javascript ]
• method newSupportedScope() [ 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 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 removeSupportedScope() [ Language = javascript ]
User clicked the Remove button to remove an entry from the listbox.
• method saveSupportedScope() [ Language = javascript ]
User clicked the OK button to save a Redirect URL.
Clear list selection and hide the edit fields afterwards.
• method selectSupportedScope(currIndex) [ Language = javascript ]
User clicked an existing redirect url from the listbox.
Set the value into the textbox for editing or removing.
• method showJWT(flag) [ Language = javascript ]
• method tabChanged(index) [ Language = javascript ]
• method validatePage() [ Language = javascript ]


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