Registration Class Reference

The SYS.OAuth2.Registration class contains the client side methods to support OpenID Connect Discovery and Dynamic Client Registration. More...

Inheritance diagram for Registration:

Collaboration diagram for Registration:

Static Public Member Functions
_.Library.Status	DeleteClientRegistration (_.Library.String applicationName)
	The SYS.OAuth2.Registration class contains the client side methods to support OpenID Connect Discovery and Dynamic Client Registration. More...
_.Library.Status	Discover (_.Library.String issuerEndpoint, _.Library.String sslConfiguration, OAuth2.ServerDefinition server)
	The Discover method uses the OpenID Connect Discovery protocol to obtain the server metadata. More...
_.Library.Status	ReadClient (_.Library.String applicationName)
	The ReadClient method uses the OpenID Connect Dynamic Registration protocol to read the client metadata. More...
_.Library.Status	RegisterClient (_.Library.String applicationName)
	The RegisterClient method uses the OpenID Connect Dynamic Registration protocol to register the client. More...
_.Library.Status	UpdateClient (_.Library.String applicationName)
	The UpdateClient method uses the Dynamic Client Registration protocol (RFC 7592) to uptate the client metadata. More...

Detailed Description

The SYS.OAuth2.Registration class contains the client side methods to support OpenID Connect Discovery and Dynamic Client Registration.

Member Function Documentation

DeleteClientRegistration()

_.Library.Status DeleteClientRegistration ( _.Library.String  applicationName )

static

The SYS.OAuth2.Registration class contains the client side methods to support OpenID Connect Discovery and Dynamic Client Registration.

The DeleteClientRegistration method uses the Dynamic Client Registration protocol (RFC 7592) to delete the client metadata

of a dynamically registered client. The local OAuth2.Client instance is unchanged.

Discover()

_.Library.Status Discover ( _.Library.String  issuerEndpoint, _.Library.String  sslConfiguration, OAuth2.ServerDefinition  server  )

static

The Discover method uses the OpenID Connect Discovery protocol to obtain the server metadata.

for a client. The Discover method saves the server metadata in an existing or new OAuth2.ServerDefinition instance for the specified issuerEndpoint.

ReadClient()

_.Library.Status ReadClient ( _.Library.String  applicationName )

static

The ReadClient method uses the OpenID Connect Dynamic Registration protocol to read the client metadata.

of a dynamically registered client. The ReadClient method saves the response properties and response client metadata in the OAuth2.Client instance.

RegisterClient()

_.Library.Status RegisterClient ( _.Library.String  applicationName )

static

The RegisterClient method uses the OpenID Connect Dynamic Registration protocol to register the client.

specified by applicationName. The RegisterClient method saves the response properties and response client metadata in the OAuth2.Client instance.

UpdateClient()

_.Library.Status UpdateClient ( _.Library.String  applicationName )

static

The UpdateClient method uses the Dynamic Client Registration protocol (RFC 7592) to uptate the client metadata.

of a dynamically registered client on the server. The UpdateClient method saves the updated response properties and response client metadata in the OAuth2.Client instance.