Skip to main content


class %CSP.UI.Portal.OAuth2.Client.Configuration 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.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,OAuth 2.0,Client Configurations,Client Configuration;
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 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 IssuerEndpoint as %String (ZENURL = "IssuerEndpoint");
IssuerEndpoint of the Server for client list.
Property methods: IssuerEndpointDisplayToLogical(), IssuerEndpointGet(), IssuerEndpointIsValid(), IssuerEndpointLogicalToDisplay(), IssuerEndpointLogicalToOdbc(), IssuerEndpointNormalize(), IssuerEndpointSet()
property IssuerEndpointID as %String (ZENURL = "IssuerEndpointID");
IssuerEndpointID of the Server for client list.
Property methods: IssuerEndpointIDDisplayToLogical(), IssuerEndpointIDGet(), IssuerEndpointIDIsValid(), IssuerEndpointIDLogicalToDisplay(), IssuerEndpointIDLogicalToOdbc(), IssuerEndpointIDNormalize(), IssuerEndpointIDSet()
property NumTabs as %Integer [ InitialExpression = 4 ];
Property methods: NumTabsDisplayToLogical(), NumTabsGet(), NumTabsIsValid(), NumTabsLogicalToDisplay(), NumTabsNormalize(), NumTabsSet(), NumTabsXSDToLogical()
property PID as %String (ZENURL = "PID");
ID for edit. Null if adding new configuration.
Property methods: PIDDisplayToLogical(), PIDGet(), PIDIsValid(), PIDLogicalToDisplay(), PIDLogicalToOdbc(), PIDNormalize(), PIDSet()
property buttonCaption as %String [ InitialExpression = "default" ];
Property methods: buttonCaptionDisplayToLogical(), buttonCaptionGet(), buttonCaptionIsValid(), buttonCaptionLogicalToDisplay(), buttonCaptionLogicalToOdbc(), buttonCaptionNormalize(), buttonCaptionSet()
property currIndex as %Integer;
Property methods: currIndexDisplayToLogical(), currIndexGet(), currIndexIsValid(), currIndexLogicalToDisplay(), currIndexNormalize(), currIndexSet(), currIndexXSDToLogical()
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
method DrawHelpText(pSeed As %String) as %Status
classmethod GetFrontChannelURLforUI(pProvidedUrl) as %String [ ZenMethod ]
method GetIssuerEndpointID() as %String
Get the issuer endpoint
classmethod GetRedirectURLforUI(pAddress, pPort, pPrefix, pSSL) as %String [ ZenMethod ]
method LoadData(PID As %String, sys As OAuth2.Client = "") as %String
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.
method Prepare(pValueProxy As %ZEN.proxyObject) as OAuth2.Client [ ZenMethod ]
Prepare object with the client data.
method ReadMetadata(pValueProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Read the updated mnetadata from a previously dynamically registered client
method Register(pValueProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Register this client and save its metadata
classmethod Rotate(pValueProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Call RotateKeys method
method SaveData(pValueProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Save general association data to server Test can only be done for client, not server.
clientmethod changeAuthType() [ Language = javascript ]
User changed Authentication Type. Show/hide authorization signing algorithm.
clientmethod changeClientType() [ Language = javascript ]
User changed Type. Show/hide client/server credentials related fields.
clientmethod createJWT(checked) [ Language = javascript ]
clientmethod doFinish() [ Language = javascript ]
End Add/Edit and return to list page.
clientmethod doPrepare(valueProxy, isRegister) [ Language = javascript ]
Get user input and prepare proxy object for save or register.
clientmethod doRegister() [ Language = javascript ]
Register this client using OpenID Connect Dynamic Registration. Discovery of the ServerDefinition must already have been done and any client defined properties set.
clientmethod doRotate() [ Language = javascript ]
Rotate keys of JWKS
clientmethod doSave() [ Language = javascript ]
Get user input and send to server to save settings.
clientmethod getFrontChannelURL() [ Language = javascript ]
Get front channel logout URL upon user changing the provided front channel logout URL
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 onlayoutHandler(load) [ Language = javascript ]
This method is necessary for the svgTabArea and tabBar to show properly.
clientmethod onloadHandler() [ Language = javascript ]
Set focus to the Name field.
clientmethod registerButtonHandler() [ Language = javascript ]
Hide/show register button based on status
clientmethod tabChanged(index) [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab