On this Page

Examples

Basic Use Case

The pipeline below shows a standalone JWT Validate Snap (it contains a hardcoded token for demo purposes). 

Note that:

• The Audience property is set to a string value of "sales". This means that the JWT must contain an "audience" claim, and one of those values must be "sales".
• The Access token property refers to pipeline parameter (_access_token).
• The preview shows the output when a JWT has been successfully validated and the token has been decoded.

Typical Snap Configurations

The Access token parameter must always be present. Since it is an expression, it can refer to pipeline parameter, input document parameter or a plain string.

The Audience parameter is optional. If left empty, the Snap will not perform any checks against the "audience" parameter in the token (It'll still check for a valid token signature and expiration).

Advanced Use Case

This Snap can be used at the start of a pipeline to limit access. By configuring the "audience" parameter, the pipeline will only allow calls with access token that contains that "audience" parameter.

Following on from the Advanced Use Case in JWT Generate Snap documentation, let us assume that we want to allow calls associated with "sales" department only. Further, let us assume that we only want to allow calls when "age" is greater than 21.

1. The JWT Validate Snap is configured as shown in the "Typical Snap Configuration" section above.
2. If a token was generated for a different audience (for e.g. "Engineering"), then the Snap validation fails.
   
3. With a valid token, the Validation succeeds and the contents of the decoded JWT are written to the output document.
4. The next step after JWT Validate can perform further filtering or validation. In this example, we configure a Filter snap to only pass calls with an "age" value of greater than 21.
   

Downloads

Snap Pack History