Skip to main content


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.

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


property ClientId as %String (ZENURL = "ClientId");
ID for edit. Null if adding new client.
Property methods: ClientIdDisplayToLogical(), ClientIdGet(), ClientIdIsValid(), ClientIdLogicalToDisplay(), ClientIdLogicalToOdbc(), ClientIdNormalize(), ClientIdSet()
property EditPage as %String [ InitialExpression = ..Link("%25CSP.UI.Portal.OAuth2.Server.Client.zen",,1) ];
Property methods: EditPageDisplayToLogical(), EditPageGet(), EditPageIsValid(), EditPageLogicalToDisplay(), EditPageLogicalToOdbc(), EditPageNormalize(), EditPageSet()
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 = 4 ];
Property methods: NumTabsDisplayToLogical(), NumTabsGet(), NumTabsIsValid(), NumTabsLogicalToDisplay(), NumTabsNormalize(), NumTabsSet(), NumTabsXSDToLogical()
property addRedirectURL as %Boolean [ InitialExpression = 1 ];
Property methods: addRedirectURLDisplayToLogical(), addRedirectURLGet(), addRedirectURLIsValid(), addRedirectURLLogicalToDisplay(), addRedirectURLLogicalToXSD(), addRedirectURLNormalize(), addRedirectURLSet(), addRedirectURLXSDToLogical()
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()


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
Inherited description: Get the (localized) name of the page. This should be implemented in a subclass.
clientmethod 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
Inherited description: 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
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 cancelRedirectURL() [ Language = javascript ]
clientmethod changeAuthType() [ Language = javascript ]
User changed Authentication Type. Show/hide authorization signing algorithm.
clientmethod doCancel() [ Language = javascript ]
Inherited description: This method resets the modified indicator and return user to the parent page.
clientmethod doJWTChange(selection) [ Language = javascript ]
Show/hide fields after user selected a JWT option
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 doUpdateJWKS() [ Language = javascript ]
Retrieve an updated public JWKS
clientmethod modified() [ Language = javascript ]
clientmethod 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.
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 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 onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.
clientmethod removeRedirectURL() [ Language = javascript ]
User clicked the Remove button to remove an entry from the listbox.
clientmethod saveRedirectURL() [ Language = javascript ]
User clicked the OK button to save a Redirect URL.
Clear list selection and hide the edit fields afterwards.
clientmethod selectRedirectURL() [ Language = javascript ]
User clicked an existing redirect url from the listbox.
Set the value into the textbox for editing or removing.
clientmethod showHide(fieldName) [ Language = javascript ]
clientmethod tabChanged(index) [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab