Click or drag to resize

IJwtService Interface

Generate a JSON Web Token (JWT) single-sign-on token. As described by the IETF (https://tools.ietf.org/html/rfc7519): A JSON Web Token (JWT) is a compact, URL-safe means of representing claims to be transferred between two parties. The claims in a JWT are encoded as a JSON object that is used as the payload of a JSON Web Signature(JWS) structure or as the plaintext of a JSON Web Encryption(JWE) structure, enabling the claims to be digitally signed or integrity protected with a Message Authentication Code (MAC) and/or encrypted.

Namespace:  NetQuarry.Services
Assembly:  EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
public interface IJwtService : IServiceInfo, 
	ICloneable, IEAPBase

The IJwtService type exposes the following members.

Properties
  NameDescription
Public propertyApplication
Gets or Sets the IAppContext object for the service.
(Inherited from IServiceInfo.)
Public propertyAttributes
Gets/Sets the service attributes.
(Inherited from IServiceInfo.)
Public propertyCategory
Gets/Sets the service category.
(Inherited from IServiceInfo.)
Public propertyComponentID
Gets/Sets the service ComponentID.
(Inherited from IServiceInfo.)
Public propertyID
Gets/Sets the service ID.
(Inherited from IServiceInfo.)
Public propertyName
Gets/Sets the service name.
(Inherited from IServiceInfo.)
Public propertyProperties
The Properties collection of Property objects for this object.
(Inherited from IEAPBase.)
Public propertyTextItems
The TextItems collection of TextItem localized text objects for this object.
(Inherited from IEAPBase.)
Public propertyType
Gets/Sets the service type.
(Inherited from IServiceInfo.)
Public propertyVersion
Gets/sets the version of this object's assembly.
(Inherited from IEAPBase.)
Top
Methods
  NameDescription
Public methodClone
Creates a new object that is a copy of the current instance.
(Inherited from ICloneable.)
Public methodExec
The Exec method provides extended functionality.
(Inherited from IEAPBase.)
Public methodGenerateToken
Generate the JWT token.
Public methodGetServiceUrl
Gets the url for the JWT service call.
Public methodOnWebhook
Handles an invocation of a "webhook" event for the service. You should implement this event if you want your service to handle webhooks through the standard platform webhook wiring. The raw wiring for the webhook would look like handler.ashx?req=webhook&service=sss&appkey=aaa&token=ttt where sss is the name of the service, aaa is the application key, and ttt is the authentication token. When wired up in the manner, the platform will instantiate an IAppContext object, authenticate the request based on the provided token, obtain an instance of the service from the Services collection, and invoke this method on the service. If the webhook is wired up in this manner, you must override the base implementation of this method or an exception will be thrown.
(Inherited from IServiceInfo.)
Public methodServiceLoaded
Called after the ServiceInfo object is loaded
(Inherited from IServiceInfo.)
Top
See Also