PRIM_SRVM.HttpJsonWebToken (PRIM_SRVM.HttpJsonWebToken)
JSON Web Token (JWT) is a compact claims representation format intended for space constrained environments such as HTTP Authorization headers and URI query parameters.
Ancestors - Object (PRIM_OBJT)
No detailed help is available for this feature
| Name | Description |
|---|---|
| AudienceClaim | The audience claim identifies the recipients that the JWT is intended for. In the general case, the value is an array of case-sensitive strings, each containing a StringOrURI value. In the special case when the JWT has one audience, the value may be a single case-sensitive string containing a StringOrURI value. The interpretation of audience values is generally application specific. Use of this claim is optional. |
| Claims | A child JSON DOM object that encapsulates private claims. Private claims are statements about an entity (typically, the user) and additional data. |
| ComponentClassName | ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT) |
| ComponentMembers | ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT) |
| ComponentPatternName | ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT) |
| ComponentTag | Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT) |
| ComponentType | ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT) |
| ComponentTypeName | ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT) |
| ExpirationClaim | The expiration claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing. Use of this claim is optional. |
| IdClaim | The Id claim provides a unique identifier for the JWT and can be used to prevent the JWT from being replayed. The value is a case-sensitive string. Use of this claim is optional. |
| IssuedAtClaim | The "issued at" claim identifies the time at which the JWT was issued. This claim can be used to determine the age of the JWT. Although the use of this claim is optional, invoking the IssueToken method will automatically assign a value. |
| IssuerClaim | The issuer claim identifies the principal that issued the JWT and is a case-sensitive string containing a StringOrURI value. The processing of this claim is generally application specific. Use of this claim is optional. |
| IssueTokenTimespan | Number of minutes until JWT expires. Default is 15 minutes. The IssueToken method uses positive values to trigger the generation of the IssuedAt and Expiration claims while a value of zero stops this behaviour. |
| Name | Name identifies the component Inherited from Object (PRIM_OBJT) |
| NotBeforeClaim | The "not before" claim identifies the time before which the JWT MUST NOT be accepted for processing. The processing of this claim requires that the current date/time MUST be after or equal to the not-before date/time listed in this claim. Use of this claim is optional. |
| Owner | Owner owns this component Inherited from Object (PRIM_OBJT) |
| Parent | The component instance to which this instance is attached. The visual container for a control or the collector of a set of child instances Inherited from Object (PRIM_OBJT) |
| Payload | A child JSON DOM object that encapsulates the registered, public and private claims. Use this property to maintain public claims not currently supported by the JWT component. |
| SubjectClaim | The subject claim identifies the principal that is the subject of the JWT and is a case-sensitive string containing a StringOrURI value. The processing of this claim is generally application specific. Use of this claim is optional. |
| TokenStatus | Property that describes the current status of the JWT. This status can be used to explain why an invocation of TryVerifyToken failed. |
| Name | Description |
|---|---|
| CreateInstance | CreateInstance is signalled when an instance of a component is created Inherited from PRIM_SRVM.HttpJsonWebToken (PRIM_SRVM.HttpJsonWebToken) |
| DestroyInstance | DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from PRIM_SRVM.HttpJsonWebToken (PRIM_SRVM.HttpJsonWebToken) |