This pageapplies toApigee andApigee hybrid.

View Apigee Edge documentation.

The DecodeJWT policy decodes a JWT without verifying the signature on the JWT. This is most useful when used in concert with theVerifyJWT policy, when the value of a claim from within the JWT must be known before verifying the signature of the JWT.

The JWT Decode policy works regardless of the algorithm that was used to sign the JWT. SeeJWS and JWT policies overview for a detailed introduction.

This policy is aStandard policy and can be deployed to any environment type. For information on policy types and availability with each environment type, seePolicy types.

Sample: Decode a JWT

The policy shown below decodes a JWT found in the flow variablevar.jwt. This variable must be present and contain a viable (decodable) JWT. The policy can obtain the JWT from any flow variable.

<DecodeJWTname="JWT-Decode-HS256"><DisplayName>JWTVerifyHS256</DisplayName><Source>var.jwt</Source></DecodeJWT>

The policy writes its output to context variables so that subsequent policies or conditions in the API proxy can examine those values. SeeFlow variables for a list of the variables set by this policy.

Element reference for Decode JWT

The policy reference describes the elements and attributes of the Decode JWT policy.

Attributes that apply to the top-level element

<DecodeJWT name="JWT" continueOnError="false" enabled="true" async="false">

The following attributes are common to all policy parent elements.

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

Use in addition to the name attribute to label the policy in the Apigee UI proxy editor with a different, natural-language name.

<Source>

<Source>jwt-variable</Source>

If present, specifies the flow variable in which the policy expects to find the JWT to decode.

curl -v http://52.200.92.187:9001/doctest-jwt/verify-rs256 -H "Authorization: Bearer <your JWT>"

jwt.{policy_name}.{variable_name}

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, seeWhat you need to know about policy errors andHandling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, seeWhat you need to know about policy errors.

Example error response

For error handling, the best practice is to trap theerrorcode part of the error response. Do not rely on the text in thefaultstring, because it could change.

Example fault rule

    <FaultRules>        <FaultRule name="JWT Policy Errors">            <Step>                <Name>JavaScript-1</Name>                <Condition>(fault.name Matches "InvalidToken")</Condition>            </Step>            <Condition>JWT.failed=true</Condition>        </FaultRule>    </FaultRules>