Skip to main content


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

Page to define OAuth2 authorization server configuration

Property Inventory

Method Inventory


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;
Inherited description: 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;
Inherited description: 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;
Inherited description: If true, register visits to this page in the recent list.
parameter RESOURCE = %Admin_OAuth2_Server;
Security requirement


property AvaRoles as %String;
Property methods: AvaRolesDisplayToLogical(), AvaRolesGet(), AvaRolesIsValid(), AvaRolesLogicalToDisplay(), AvaRolesLogicalToOdbc(), AvaRolesNormalize(), AvaRolesSet()
property ClientPage as %String [ InitialExpression = ..Link("%25CSP.UI.Portal.OAuth2.Server.ClientList.zen",,1) ];
Property methods: ClientPageDisplayToLogical(), ClientPageGet(), ClientPageIsValid(), ClientPageLogicalToDisplay(), ClientPageLogicalToOdbc(), ClientPageNormalize(), ClientPageSet()
property IsEditForm as %Boolean [ InitialExpression = 1 ];
Inherited description: If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.
Property methods: IsEditFormDisplayToLogical(), IsEditFormGet(), IsEditFormIsValid(), IsEditFormLogicalToDisplay(), IsEditFormLogicalToXSD(), IsEditFormNormalize(), IsEditFormSet(), IsEditFormXSDToLogical()
property NAMESPACE as %ZEN.Datatype.string (ZENURL = "$NAMESPACE");
Property methods: NAMESPACEDisplayToLogical(), NAMESPACEGet(), NAMESPACEIsValid(), NAMESPACELogicalToDisplay(), NAMESPACELogicalToOdbc(), NAMESPACENormalize(), NAMESPACESet()
property NumTabs as %Integer [ InitialExpression = 5 ];
Property methods: NumTabsDisplayToLogical(), NumTabsGet(), NumTabsIsValid(), NumTabsLogicalToDisplay(), NumTabsNormalize(), NumTabsSet(), NumTabsXSDToLogical()
property SelectedRoles as %String;
Property methods: SelectedRolesDisplayToLogical(), SelectedRolesGet(), SelectedRolesIsValid(), SelectedRolesLogicalToDisplay(), SelectedRolesLogicalToOdbc(), SelectedRolesNormalize(), SelectedRolesSet()
property currIndex as %Integer;
Property methods: currIndexDisplayToLogical(), currIndexGet(), currIndexIsValid(), currIndexLogicalToDisplay(), currIndexNormalize(), currIndexSet(), currIndexXSDToLogical()
property isNew as %Boolean;
Property methods: isNewDisplayToLogical(), isNewGet(), isNewIsValid(), isNewLogicalToDisplay(), isNewLogicalToXSD(), isNewNormalize(), isNewSet(), isNewXSDToLogical()
property jwksAvailable as %Boolean;
Property methods: jwksAvailableDisplayToLogical(), jwksAvailableGet(), jwksAvailableIsValid(), jwksAvailableLogicalToDisplay(), jwksAvailableLogicalToXSD(), jwksAvailableNormalize(), jwksAvailableSet(), jwksAvailableXSDToLogical()


Return the array of links to show in the locator bar.
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.
clientmethod cancelRedirectURL() [ Language = javascript ]
clientmethod createJWT(checked) [ Language = javascript ]
clientmethod doClient() [ Language = javascript ]
clientmethod doDelete(action) as %Boolean [ Language = javascript ]
clientmethod doRotate() [ Language = javascript ]
Rotate keys of JWKS
clientmethod 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.
clientmethod getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row.
clientmethod getRedirectURL() [ Language = javascript ]
Get redirect URL upon user changing any of server address/port/prefix.
clientmethod modified() [ Language = javascript ]
clientmethod 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.
clientmethod onlayoutHandler(load) [ Language = javascript ]
This method is necessary for the svgTabArea and tabBar to show properly.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod removeSupportedScope() [ Language = javascript ]
User clicked the Remove button to remove an entry from the listbox.
clientmethod saveSupportedScope() [ Language = javascript ]
User clicked the OK button to save a Redirect URL.
Clear list selection and hide the edit fields afterwards.
clientmethod selectSupportedScope(currIndex) [ Language = javascript ]
User clicked an existing redirect url from the listbox.
Set the value into the textbox for editing or removing.
clientmethod showJWT(flag) [ Language = javascript ]
clientmethod tabChanged(index) [ Language = javascript ]
clientmethod validatePage() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab