Request Class Reference

SYS.OAuth2.Request creates and manages the request JWT needed to support the request and request_uri parameters that are defined in section 6 of OpenID Connect Core document. More...

Inheritance diagram for Request:

Collaboration diagram for Request:

Public Member Functions
_.Library.String	GetJWT ()
	Get the JWT associated with this request object.
_.Library.String	GetURL (_.Library.Status sc)
	Get the URL associated with this persistent request object.

Static Public Member Functions
_.Library.Status	CleanupRequestObjects (_.Library.String applicationName, _.Library.Integer interval)
	SYS.OAuth2.Request creates and manages the request JWT needed to support the request and request_uri parameters that are defined in section 6 of OpenID Connect Core document. More...
_.Library.Status	DeleteRequestObject (_.Library.String applicationName, _.Library.String requestName)
	Delete the request object that is specified by applicationName and requestName.
_.Library.String	MakeRequestJWT (_.Library.String applicationName, _.Library.String properties, _.Library.Status sc)
	Create and return a JWT based on the specified properties. More...
_.SYS.OAuth2.Request	OpenRequestObject (_.Library.String applicationName, _.Library.String requestName, _.Library.Status sc)
	Open a persistent SYS.OAuth2.Request object which contains a JWT identified by applicationName and requestName.
_.SYS.OAuth2.Request	UpdateRequestObject (_.Library.String applicationName, _.Library.String requestName, _.Library.String properties, _.Library.Status sc)
	Create or update a persistent SYS.OAuth2.Request object which contains a. More...

Public Attributes
	ApplicationName
	The name of the client application associated with this request. More...
	JWT
	The JWT created from the request object. More...
	RequestName
	The name of this request object. More...
	State
	The base64 encoded random state associated with the request. More...
	UpdateTime
	The time when the request object was last updated. More...

Detailed Description

SYS.OAuth2.Request creates and manages the request JWT needed to support the request and request_uri parameters that are defined in section 6 of OpenID Connect Core document.

Member Function Documentation

CleanupRequestObjects()

_.Library.Status CleanupRequestObjects ( _.Library.String  applicationName, _.Library.Integer  interval  )

static

SYS.OAuth2.Request creates and manages the request JWT needed to support the request and request_uri parameters that are defined in section 6 of OpenID Connect Core document.

Clean up the request object list by deleting any request object that has not been updated

for the specified client in interval seconds

MakeRequestJWT()

_.Library.String MakeRequestJWT ( _.Library.String  applicationName, _.Library.String  properties, _.Library.Status  sc  )

static

Create and return a JWT based on the specified properties.

The JWT may be signed or encoded by the client configuration that is specified by applicationName.
To add a request parameter which is a JSON object, you must create a properties element which is a DynamicObject. For example the claims parameter that is defined by OpenID Connect.

UpdateRequestObject()

_.SYS.OAuth2.Request UpdateRequestObject ( _.Library.String  applicationName, _.Library.String  requestName, _.Library.String  properties, _.Library.Status  sc  )

static

Create or update a persistent SYS.OAuth2.Request object which contains a.

JWT based on the specified properties. The new request object is both saved and returned by this method.
The JWT may be signed or encoded by the client configuration that is specified by applicationName.
To add a request parameter which is a JSON object, you must create a properties element which is a DynamicObject. For example the claims parameter that is defined by OpenID Connect.

Member Data Documentation

ApplicationName

ApplicationName

The name of the client application associated with this request.

 

JWT

JWT

The JWT created from the request object.

 

RequestName

RequestName

The name of this request object.

 

State

State

The base64 encoded random state associated with the request.

The state is included as a fragment of in the URL in order to ensure cached requests are retrieved.  

UpdateTime

UpdateTime

The time when the request object was last updated.