In this article

Overview

Use the Java Web Token (JWT) Validator policy to authenticate a request with a token. When you apply this policy, API consumers must use their JWT credentials to sign their JWT. Before allowing API access to the consumer, the policy does the following:

The policy checks if the JWT token is valid
If valid, the policy processes the request
If invalid, the policy discards the request

The JWT token works with the Authorize by Role policy. The value for the JWT role is the value for the Role field in the Authorize by Role Policy.

Policy Execution Order

This JWT Validator policy executes after the request has been authorized.

Expression Enabled Fields in API Policies

All expression enabled fields take expressions from the SnapLogic Expression Language and the API Policy Manager functions.

Settings

Parameter Name	Description	Default Value	Example
Label	Required. The name for the API policy.	JWT Validator	Task JWT Validator
When this policy should be applied	An expression enabled field that determines the condition to be fulfilled for the API policy to execute. For example, if the value in this field is request.method == "POST", the API policy is executed only if the request method is a POST.	True	request.method == "POST"
Signing Algorithm	RSA HSA ECDSA	RSA	ECDSA
Key·	None	N/A	·················
Extract into $token	Required. Specifies the location to find the key in the request. If one of the given locations is not found, this API policy will pass the request through to the next API policy.	N/A	N/A
Custom Header Keys	The names of the headers. If more than one header is given, they will all be checked. Click + to add more custom header keys.	N/A	N/A
Key	The name of the custom header key.		$.aud
Custom Query String Parameter Keys	The names of the query parameters. If more than one name is given, they will all be checked. Click + to add more custom query string parameters.	N/A	N/A
Key	The name of the custom query string parameter.		$key
Custom Cookie Key	The names of the cookies. You can add more than one cookie. Click + to add more custom cookies. The value input in the Cookie is to be replaced with the access token while using Postman or any other tool.	N/A	N/A
Key	The name of the Custom Cookie Key		Cookie_1
Authorization Header Type	If the key is in the Authorization header, this value is used as the “type” to check.	N/A
Extract User Info*	Required. Specifies how to extract information about the user from the working object.	N/A	N/A
User ID Expression	An expression that returns a string to be used as the user ID.	N/A	$qty
Roles Expression	An expression that returns the list of roles for the user.	N/A	$aud
Status	Indicates whether the API policy is enabled or disabled.	Enabled	Disabled