OAuth2.Server.Properties stores the properties and claims that are used to communicate between various parts of the OAuth 2.0 authorization server. More...

Inheritance diagram for Properties:

[legend]

Collaboration diagram for Properties:

[legend]

Public Member Functions
_.Library.String	GetClaimValue (_.Library.String name, type)
	OAuth2.Server.Properties stores the properties and claims that are used to communicate between various parts of the OAuth 2.0 authorization server. More...

_.Library.String	GetConvertedClaimValue (_.Library.String name, type)
	Get the value and type of the claim named by the name argument. More...

_.Library.String	NextClaimValue (_.Library.String name)
	Get the next name from the ClaimValues property.

	RemoveClaimValue (_.Library.String name)
	Remove the value of the claim named by the name argument.

	SetClaimValue (_.Library.String name, _.Library.String value, _.Library.String type)
	Set the value of the claim named by the name argument. More...

Public Member Functions inherited from Persistent
_.Library.Status	AcquireLock (_.Library.String locktype)
	Acquires a lock for the current instance. More...

_.Library.Status	LoadData (_.Library.String id)
	LoadData() - loads an object from storage. More...

_.Library.Status	OnAfterSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnBeforeSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnOpen ()
	This callback method is invoked by the <METHOD>Open</METHOD> method to. More...

_.Library.Status	OnReload ()
	This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...

_.Library.Status	OnRollBack ()
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	ReleaseLock (_.Library.String locktype)
	Releases a lock for the current instance. More...

_.Library.Status	SaveData (_.Library.String id)
	SaveData() - saves an object to disk, checks uniqueness and referential More...

Public Member Functions inherited from SwizzleObject
_.Library.Status	OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
	This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Attributes
	ClaimValues
	ClaimValues associates the value to be returned for the claim will with the claim having. More...

	CustomProperties
	CustomProperties contains the custom properties to be used to communicate between various. More...

	IDTokenClaims
	IDTokenClaims specifies the claims that are needed for the IDToken beyond the base set of required claims. More...

	IntrospectionClaims
	IntrospectionClaims specifies the claims that need to be returned by the Introspection endpoint beyond the base required claims. More...

	JWTClaims
	JWTClaims specifies the claims that are needed for the JWT access token that is returned. More...

	JWTHeaderClaims
	JWTHeaderClaims specifies the claims to include in the JOSE Header for the JWT access token that is returned. More...

	RequestProperties
	RequestProperties contains the query parameters from the authorization request. More...

	ResponseProperties
	ResponseProperties contains the properties to be added to the JSON response. More...

	ServerProperties
	ServerProperties contains properties that the authorization server chooses to share with the customization code. More...

	UserinfoClaims
	UserinfoClaims specifies the claims that need to be returned by the Userinfo endpoint beyond the base required claims. More...

Additional Inherited Members
Static Public Member Functions inherited from Persistent
_.Library.Status	DeleteData (_.Library.String id, _.Library.Integer concurrency)
	This method is normally generated by the storage class for persistent classes using. More...

_.Library.Status	KillExtentData (_.Library.Boolean killstreams)
	KillExtentData() - kills extent data in storage. More...

_.Library.Status	OnAfterBuildIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnAfterDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

_.Library.Status	OnAfterPurgeIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnBeforeBuildIndices (_.Library.String indexlist)

_.Library.Status	OnBeforePurgeIndices (_.Library.String indexlist)

_.Library.Status	OnDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

Static Public Attributes inherited from Persistent
	XCOMPACTANCESTRY
	XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...

	DATALOCATIONGLOBAL = None
	Global name containing master map data for this class. More...

	DEFAULTGLOBAL = None

	DSCONDITION = None
	DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...

	DSINTERVAL = None
	DSINTERVAL is the number of seconds between one DSTIME value and the next. More...

	DSTIME = None
	If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...

	EXTENTQUERYSPEC = None
	The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...

	EXTENTSIZE = None
	The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...

	GUIDENABLED = None
	If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...

	IDENTIFIEDBY = None
	The IDENTIFIEDBY parameter can optionally be set to the name. More...

	MANAGEDEXTENT = None
	The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...

	READONLY = None
	READONLY = 1 means that objects can be created, opened but not saved or deleted. More...

	ROWLEVELSECURITY = None
	ROWLEVELSECURITY = 1 \| <property> means that row level security is active and the list More...

	SQLPREVENTFULLSCAN = None
	SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...

	STORAGEDEFAULT = None
	STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...

	USEEXTENTSET = None

	VERSIONCLIENTNAME = None
	VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...

	VERSIONPROPERTY = None
	VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...

Static Public Attributes inherited from SwizzleObject
	DEFAULTCONCURRENCY = None
	DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...

	JOURNALSTREAM = None
	If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...

	OBJJOURNAL = None
	if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

OAuth2.Server.Properties stores the properties and claims that are used to communicate between various parts of the OAuth 2.0 authorization server.

See the description of each property of this class to understand usage of the properties and claims.
Note that storage is not in a % global. Therefore allowing the claim to be viewed from any namespace, but only opened or saved with the proper credentials.

Member Function Documentation

◆ GetClaimValue()

_.Library.String GetClaimValue	(	_.Library.String	name,
			type
	)

OAuth2.Server.Properties stores the properties and claims that are used to communicate between various parts of the OAuth 2.0 authorization server.

See the description of each property of this class to understand usage of the properties and claims.
Note that storage is not in a % global. Therefore allowing the claim to be viewed from any namespace, but only opened or saved with the proper credentials.

Get the value and type of the claim named by the name argument.

◆ GetConvertedClaimValue()

_.Library.String GetConvertedClaimValue	(	_.Library.String	name,
			type
	)

Get the value and type of the claim named by the name argument.

with $list value converted to DynamicArray

◆ SetClaimValue()

SetClaimValue	(	_.Library.String	name,
		_.Library.String	value,
		_.Library.String	type
	)

Set the value of the claim named by the name argument.

type = "string", "boolean", "number" or "object". The default type is "string" If type="object", then value is the JSON object serialized as a string. For all types, if the value is a $list, then it is an array of the specified type.

Member Data Documentation

◆ ClaimValues

ClaimValues

ClaimValues associates the value to be returned for the claim will with the claim having.

the same key in a claims array.
Each claim value is stored as $lb(type,value) where type = "string", "boolean", "number" or "object".
If type="object", then value is the JSON object serialized as a string. For all types, if the value is a $list, then it is an array of the specified type.

◆ CustomProperties

CustomProperties

CustomProperties contains the custom properties to be used to communicate between various.

pieces of customization code.
CustomProperties.GetAt(<name>) is the value of the <name> property.

◆ IDTokenClaims

IDTokenClaims

IDTokenClaims specifies the claims that are needed for the IDToken beyond the base set of required claims.

The "iss", "sub", "exp", "sid", "aud" and "azp" claims will be returned even if not in IDTokenClaims. The claims are defined based on the scope and request claims parameter. The value to be returned for the claim will have the same key in the ClaimValues property. The value of the claims will usually be set by the ValidateUser class.
IDTokenClaims.GetAt(<name>) defines the <name> claim.

◆ IntrospectionClaims

IntrospectionClaims

IntrospectionClaims specifies the claims that need to be returned by the Introspection endpoint beyond the base required claims.

The scope, client_id, username, token_type, exp, iat, nbf, sub, aud, iss and jti claims will be returned even if they are not in IntrospectionClaims. The value of the claims will usually be set by the ValidateUser class.
IntrospectionClaims.GetAt(<name>) defines the <name> claim.

◆ JWTClaims

JWTClaims

JWTClaims specifies the claims that are needed for the JWT access token that is returned.

by the default JWT based access token class (<Class>OAuth2.Server.JWT</Class>) beyond the base set of required claims. The "iss", "sub", "exp", "aud", "jti", and "scope" claims will be returned even if not in JWTClaims. The claims are defined by the customization code. The value to be returned for the claim will have the same key in the <property>ClaimValues</property> property. The value of the claims will usually be set by the ValidateUser class.
JWTClaims.GetAt(<name>) defines the <name> claim.

◆ JWTHeaderClaims

JWTHeaderClaims

JWTHeaderClaims specifies the claims to include in the JOSE Header for the JWT access token that is returned.

by the default JWT based access token class (<Class>OAuth2.Server.JWT</Class>) beyond the set of headers required by the signature or encryption options in use. The key can be either the name of a claim that exists in the <property>ClaimValues</property> property, or "jku" or "jwk". If "jku" is specified, then the "jku" field will be defined in JOSE header, containing the value of the relevant JWKS URL. If "jwk" is specified, then the "jwk" field will be defined, containing the JWK for the relvant public key. In both cases, the field will only be defined in the header if signing or encryption is being used with an asymmetric algorithm. It is not valid to specify other JOSE header fields defined by RFC 7515.
The claims are defined by the customization code. The value to be returned for the claim will have the same key in the <property>ClaimValues</property> property. The value of the claims will usually be set by the ValidateUser class.
JWTHeaderClaims.GetAt(<name>) defines the <name> claim.

◆ RequestProperties

RequestProperties

RequestProperties contains the query parameters from the authorization request.

RequestProperties.GetAt(<name>) is the value of the <name> query parameter.

◆ ResponseProperties

ResponseProperties

ResponseProperties contains the properties to be added to the JSON response.

object to a token request.
ResponseProperties.GetAt(<name>) is the value of the <name> JSON response property.

◆ ServerProperties

ServerProperties

ServerProperties contains properties that the authorization server chooses to share with the customization code.

The logo_uri, client_uri, policy_uri and tos_uri client properties are shared in this way for use by the Authentication Class.
ServerProperties.GetAt(<name>) is the value of the <name> property.

◆ UserinfoClaims

UserinfoClaims

UserinfoClaims specifies the claims that need to be returned by the Userinfo endpoint beyond the base required claims.

The "sub" claim will be returned even if not in UserinfoClaims. The claims are defined based on the scope and request claims parameter. The value to be returned for the claim will have the same key in the ClaimValues property. The value of the claims will usually be set by the ValidateUser class.
UserinfoClaims.GetAt(<name>) defines the <name> claim.

Public Member Functions

Public Attributes

Additional Inherited Members