Skip to main content

OAuth2.Response

class OAuth2.Response extends %CSP.Page

This is the landing page for responses from an OAuth 2.0 authorization server used from InterSystems IRIS OAuth 2.0 client code. The response is processed here and then redirected to the eventual target. This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Method Inventory

Parameters

parameter CSPURL = /csp/sys/oauth2/OAuth2.Response.cls;
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 UseSession = 0;
Inherited description: This parameter controls the CSP session support. By default CSP will use a persistent session which holds a license until the session is ended or times out. If you override this then this CSP page will use a transient session which is never persisted.

Methods

classmethod GetCurrentApplication(Output applicationName As %String) as %Status
Find the OAuth 2.0 application which is associated with the current CSP session. The application is determined by finding the access token referenced by the CSPOAuth2 query parameter which has been added for to the redirect URL for a login page. The applicationName is returned if successfully found. Otherwise "" is returned in applicationName with the error status as the return value. If successful the access token will be associated with the current CSP Session and the token will be automatically removed when the CSP session ends.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab