ServerDefinition Class Reference

OAuth2. More...

Inheritance diagram for ServerDefinition:

Collaboration diagram for ServerDefinition:

Public Member Functions
_.Library.Integer	ClientCount ()
	OAuth2. More...
_.Library.Boolean	RefreshJWKS (_.Library.Boolean force, _.Library.Boolean save, _.Library.Status sc)
	If the server's public JWKS was specified using the jwks_uri metadata parameter, this method will fetch the jwks if. More...
_.Library.Status	SetPublicJWKS (_.Library.String publicJWKS, _.Library.String jwksUri)
	Manually set the authorization server supplied public JWKS and optionally jwks_uri.
_.Library.Status	UpdateJWKS (_.Library.Status sc)
	Get and save a new public JWKS for the authorization server if the JWKS was specified using jwks_uri metadata. More...

Static Public Member Functions
_.Library.Status	DeleteId (_.Library.String id)
	Delete this server definition.
OAuth2.ServerDefinition	Open (_.Library.String serverDefinitionId, _.Library.Status sc)
	Open the OAuth2.ServerDefinition instance.
OAuth2.ServerDefinition	OpenByIssuer (_.Library.String issuerEndpoint, _.Library.Status sc)
	Open an OAuth2.ServerDefinition instance based on the IssuerEndpoint property.

Public Attributes
	AuthorizationEndpoint
	**** Moved to OAuth2.Server.Metadata when dynamic client support introduced More...
	Clients
	The clients that use this server defintion. More...
	InitialAccessToken
	The optional initial registration access token which may be specified out of band. More...
	IntrospectionEndpoint
	**** Moved to OAuth2.Server.Metadata when dynamic client support introduced More...
	IssuerEndpoint
	The endpoint URL to be used to identify the authorization server. More...
	Metadata
	The meta data which describes this authorization server,. More...
	RevocationEndpoint
	**** Moved to OAuth2.Server.Metadata when dynamic client support introduced More...
	SSLConfiguration
	The name of the activated TLS/SSL configuration to use for authorization server Discovery requests. More...
	ServerCredentials
	ServerCredentials is the alias of the SYS.X509Credentials object which contains the server's certificate. More...
	TokenEndpoint
	**** Moved to OAuth2.Server.Metadata when dynamic client support introduced More...
	UserinfoEndpoint
	**** Moved to OAuth2.Server.Metadata when dynamic client support introduced More...

Detailed Description

OAuth2.

ServerDefinition is a persistent class which defines an authorization server which is available to this InterSystems IRIS instance for OAuth 2.0 client definition. The authorization server definition may be used by multiple client application definitions.

Member Function Documentation

ClientCount()

_.Library.Integer ClientCount

(

)

OAuth2.

ServerDefinition is a persistent class which defines an authorization server which is available to this InterSystems IRIS instance for OAuth 2.0 client definition. The authorization server definition may be used by multiple client application definitions.

Get count of clients for this server definition

RefreshJWKS()

_.Library.Boolean RefreshJWKS	(	_.Library.Boolean	force,
		_.Library.Boolean	save,
		_.Library.Status	sc
	)

If the server's public JWKS was specified using the jwks_uri metadata parameter, this method will fetch the jwks if.

it has expired.

Parameters:

• force - refresh the jwks even if the cached version is still valid (default is 0)
• save - save the server definition (default is 1)
• sc (output) - Status code structure containing any errors

Returns:

• 1 - if the jwks was updated
• 0 - if the cached version was still valid

UpdateJWKS()

_.Library.Status UpdateJWKS

(

_.Library.Status

sc

)

Get and save a new public JWKS for the authorization server if the JWKS was specified using jwks_uri metadata.

Returns a status code.
This method is deprecated. New code should use <Method>RefreshJWKS</Method> instead.

Member Data Documentation

AuthorizationEndpoint

AuthorizationEndpoint

**** Moved to OAuth2.Server.Metadata when dynamic client support introduced

The endpoint URL to be used for to request an authorization code from the authorization server.
Required if ClientType is public or confidential.
Based on Authorization Server documentation.  

Clients

Clients

The clients that use this server defintion.

 

InitialAccessToken

InitialAccessToken

The optional initial registration access token which may be specified out of band.

and is used as a bearer token to authorize the synamic client registartion request.  

IntrospectionEndpoint

IntrospectionEndpoint

**** Moved to OAuth2.Server.Metadata when dynamic client support introduced

The endpoint URL to be used for to make a RFC 7662 based token introspection request using the client_id and client_secret for authorization.  

IssuerEndpoint

IssuerEndpoint

The endpoint URL to be used to identify the authorization server.

Required for all ClientTypes.
 

Metadata

Metadata

The meta data which describes this authorization server,.

 

RevocationEndpoint

RevocationEndpoint

**** Moved to OAuth2.Server.Metadata when dynamic client support introduced

The endpoint URL to be used for to make a RFC 7009 based token revocation request using the client_id and client_secret for authorization.  

SSLConfiguration

SSLConfiguration

The name of the activated TLS/SSL configuration to use for authorization server Discovery requests.

Chosen by user during configuration.  

ServerCredentials

ServerCredentials

ServerCredentials is the alias of the SYS.X509Credentials object which contains the server's certificate.

 

TokenEndpoint

TokenEndpoint

**** Moved to OAuth2.Server.Metadata when dynamic client support introduced

The endpoint URL to be used for to request an access token from the authorization server.
Required for all ClientTypes.
Based on Authorization Server documentation.  

UserinfoEndpoint

UserinfoEndpoint

**** Moved to OAuth2.Server.Metadata when dynamic client support introduced

The endpoint URL to be used for to make a userinfo request using an access token from the authorization server for authorization