Class %CSP.UI.Portal.OAuth2.Client.Configuration

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

Zen page for System Management Portal - Edit OAuth 2.0 client configuration

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
6	9	31

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	FirstFailed	HelpAddress	ISREADONLY
InvalidParam	IsEMSReadOnly	IsEditForm	IssuerEndpoint
IssuerEndpointID	LocatorHeader	NumTabs	OnclickArray
PID	ParentURL	StdTitle	ValidationErrorMsg
aboutPage	align	aux	backgroundTimerInterval
buttonCaption	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
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
ConvertParameter	Decrypt	DoLogout	DrawHelpText
DrawLocator	DrawRibbon	DrawTitle	Encrypt
EscapeHTML	EscapeURL	EvalResult	GetCSPURL
GetContextLinks	GetDocURL	GetFrontChannelURLforUI	GetHomePage
GetIssuerEndpointID	GetNewURL	GetQuickLinks	GetRedirectURLforUI
HyperEventCall	HyperEventHead	Include	InsertHiddenField
InsertHiddenFields	IsPrivate	JavaInstalled	Link
LoadData	OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader
OnPage	OnPageError	OnPostHTTP	OnPostHyperEvent
OnPreHTTP	OnPreHyperEvent	Page	Prepare
QuoteJS	ReadMetadata	Register	RegisterRecent
RewriteURL	Rotate	SaveData	ShowError
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	addChild	addChildAfter	addChildBefore
afterSave	afterValidate	cancelPopup	changeAuthType
changeClientType	changePassword	childrenMutated	correctIELayering
createComponent	createComponentNS	createJWT	deleteComponent
disableCommandButton	doCancel	doFinish	doModified
doPrepare	doRegister	doRotate	doSave
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	enableCommandButton	endModal
exposeComponent	findElement	fireOnResizeEvent	fireOnUnloadEvent
fireOnUpdateEvent	firePopupAction	getChildIndex	getComponent
getComponentById	getEnclosingDiv	getFrontChannelURL	getHidden
getHintElement	getLabelElement	getOpener	getPageTitle
getProperty	getRedirectURL	getSettings	getTitleAreaHeight
getType	goHome	goMenu	gotoNamespace
gotoPage	hideCommandButton	invokeSuper	isButtonDisabled
isOfType	launchPopupWindow	logout	makeId
modified	navigate	onCreate	onDelete
onDisplayHandler	onEndModalHandler	onPopupAction	onRefreshContents
onSerialize	onServerMethodCall	onServerMethodError	onServerMethodReturn
onStartModalHandler	ondisabledHandler	onhandleAutoLogoutWarn	onkeydownHandler
onkeyupHandler	onlayoutHandler	onloadHandler	onlogoutHandler
onoverlayHandler	onresizeHandler	onunloadHandler	onupdateHandler
popupActionHandler	refreshContents	registerButtonHandler	removeChild
render	renderContents	renderSVG	resetMsg
searchBlur	searchBoxHandler	searchFocus	searchKeyDown
searchKeyPress	setComponentId	setConnectivityStatusMsg	setHidden
setModified	setOverlayMode	setPageTitle	setProperty
setPropertyAll	setSortMode	setSortModeHandler	setTraceOption
setViewMode	setViewModeHandler	showAbout	showCommandButton
showContact	showDocumentation	showHelp	showMsg
startModal	startProgressBar	stopProgressBar	switchNamespace
tabChanged	trimSpace	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.Client.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,OAuth 2.0,Client Configurations,Client Configuration";

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;

If true, register visits to this page in the recent list.

• parameter RESOURCE = "%Admin_OAuth2_Client";

Security requirement

Properties

• 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 IssuerEndpoint as %String(ZENURL="IssuerEndpoint");

IssuerEndpoint of the Server for client list.

• property IssuerEndpointID as %String(ZENURL="IssuerEndpointID");

IssuerEndpointID of the Server for client list.

• property NumTabs as %Integer [ InitialExpression = 4 ];

• property PID as %String(ZENURL="PID");

ID for edit. Null if adding new configuration.

• property buttonCaption as %String [ InitialExpression = "default" ];

• property currIndex as %Integer;

• property isNew as %ZEN.Datatype.boolean(ZENURL="isNew") [ InitialExpression = "0" ];

• 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

Be sure to do ##super() when overriding.

• method %OnGetPageName() as %String

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

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.

• method changeAuthType() [ Language = javascript ]

User changed Authentication Type. Show/hide authorization signing algorithm.

• method changeClientType() [ Language = javascript ]

User changed Type. Show/hide client/server credentials related fields.

• method createJWT(checked) [ Language = javascript ]

• method doFinish() [ Language = javascript ]

End Add/Edit and return to list page.

• method doPrepare(valueProxy, isRegister) [ Language = javascript ]

Get user input and prepare proxy object for save or register.

• method 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.

• method doRotate() [ Language = javascript ]

Rotate keys of JWKS

• method doSave() [ Language = javascript ]

Get user input and send to server to save settings.

• method getFrontChannelURL() [ Language = javascript ]

Get front channel logout URL upon user changing the provided front channel logout URL

• 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 onlayoutHandler(load) [ Language = javascript ]

This method is necessary for the svgTabArea and tabBar to show properly.

• method onloadHandler() [ Language = javascript ]

Set focus to the Name field.

• method registerButtonHandler() [ Language = javascript ]

Hide/show register button based on status

• method tabChanged(index) [ Language = javascript ]


[USER] > [%CSP] > [UI] > [Portal] > [OAuth2] > [Client] > [Configuration]		Private Storage