This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions pageOpens in a new window (login required).

Caché & Ensemble 2018.1.5Opens in a new window > Class Reference > %SYS namespace > %OAuth2.Server.JWT


class %OAuth2.Server.JWT extends %Library.RegisteredObject

The %OAuth2.Server.JWT is the GenerateTokernClass which creates a JWT which is included with the server. The GenerateTokenClass is specified in the Authorization Server Configuration. It must contain a GenerateAccessToken method will be used to generate an access token based on the array of properties that is returned by the ValidateUser method.

Method Inventory (Including Private)

Methods (Including Private)

classmethod AddClaims(claims As %ArrayOfObjects, properties As %OAuth2.Server.Properties, json As %DynamicObject)
Add requested claims to the JWT
classmethod GenerateAccessToken(properties As %OAuth2.Server.Properties, Output sc As %Status) as %String
The GenerateAccessToken method returns an optionally signed and/or encryypted JWT to be used as an access token. The access token may be based on the properties argument. In addition values for claims to be added to the JSON response object may be returned in the properties.ResponseProperties array.
However the method in this default class just returns a JWT which is optionally signed and/or encrypted.
classmethod IsJWT() as %Boolean
The IsJWT method returns true if the GenerateAccessToken method returns a JWT. IsJWT is used to determine inclusion of algorithms for access token in server metadata.

Inherited Members

Inherited Methods (Including Private)

FeedbackOpens in a new window