Skip to main content


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

Zen page for System Management Portal - Edit OAuth 2.0 client 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.Client.ServerConfiguration.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,OAuth 2.0,Client,Server Descriptions;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = OAuth 2.0 Client Configuration;
Displayed name of this page.
parameter PARENTPAGE = /csp/sys/sec/%CSP.UI.Portal.OAuth2.Client.ServerList.zen;
Inherited description: This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.
parameter RECENT = 0;
Inherited description: If true, register visits to this page in the recent list.
parameter RESOURCE = %Admin_OAuth2_Client;
Security requirement


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 MetadataID as %String;
MetadataID of the server metadata.
Property methods: MetadataIDDisplayToLogical(), MetadataIDGet(), MetadataIDIsValid(), MetadataIDLogicalToDisplay(), MetadataIDLogicalToOdbc(), MetadataIDNormalize(), MetadataIDSet()
property PID as %String (ZENURL = "PID");
ID for edit. Null if adding new configuration.
Property methods: PIDDisplayToLogical(), PIDGet(), PIDIsValid(), PIDLogicalToDisplay(), PIDLogicalToOdbc(), PIDNormalize(), PIDSet()
property isNew as %ZEN.Datatype.boolean (ZENURL = "isNew") [ InitialExpression = "0" ];
Property methods: isNewDisplayToLogical(), isNewGet(), isNewIsValid(), isNewLogicalToDisplay(), isNewLogicalToOdbc(), 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
Inherited description: Be sure to do ##super() when overriding.
method %OnGetPageName() as %String
Inherited description: Get the (localized) name of the page. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the page. Overrid Edit: id as text on tab display below Menu
classmethod Discovery(pValueProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Get metadata from authorization discovery endpoint.
method LoadData(PID As %String, Output sys) as %Status
Used when Editing an existing OAuth2 client configuration. Load previously defined values into fields.
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
Inherited description: Get information to display in the ribbon bar.
classmethod SaveData(pValueProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Save general association data to server Test can only be done for client, not server.
classmethod UpdateJWKS(pValueProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Call UpdateJWKS method
clientmethod 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.
clientmethod disableServer(flag) [ Language = javascript ]
Enable server fields only if user clicked Edit button
clientmethod doDiscovery() [ Language = javascript ]
Get server metadata from OpenID Connect Discovery endpoint of authorization server..
clientmethod doFinish() [ Language = javascript ]
End Add/Edit and return to list page.
clientmethod doHidden(flag) [ Language = javascript ]
clientmethod doJWTChange(selection) [ Language = javascript ]
Show/hide fields after user selected a JWT option
clientmethod doManual() [ Language = javascript ]
Enable fields that are only allowed for manual
clientmethod doSave(isDiscovery) [ Language = javascript ]
Get user input and send to server to save settings.
clientmethod doUpdateJWKS() [ Language = javascript ]
Retrieve an updated public JWKS
clientmethod getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row.
clientmethod 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.
clientmethod onloadHandler() [ Language = javascript ]
Set focus to the Name field.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab