JWT Validate Token activity¶
Introduction¶
A JWT Validate Token activity, using its JWT connection, validates a JSON Web Token (JWT) and is intended to be used as a target to consume data in an operation.
Create a JWT Validate Token activity¶
An instance of a JWT Validate Token activity is created from a JWT connection using its Validate Token activity type.
To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.
An existing JWT Validate Token activity can be edited from these locations:
- The design canvas (see Component actions menu in Design canvas).
- The project pane's Components tab (see Component actions menu in Project pane Components tab).
Configure a JWT Validate Token activity¶
Follow these steps to configure a JWT Validate Token activity:
-
Step 1: Enter a name and specify settings
Provide a name for the activity and specify the JWT, JWT type, and JWT type-dependent settings. -
Step 2: Review the data schemas
Any request or response schemas are displayed.
Step 1: Enter a name and specify settings¶
In this step, provide a name for the activity and specify the JWT, JWT type, and JWT type-dependent settings. Each user interface element of this step is described below.
Tip
Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [
into the field or by clicking the variable icon to display a list of the existing variables to choose from.
-
Name: Enter a name to identify the activity. The name must be unique for each JWT Validate Token activity and must not contain forward slashes
/
or colons:
. -
JWT token: Enter the JWT to validate.
-
JWT type: Select if the JWT was signed using a JSON Web Signature (JWS) or encrypted with a JSON Web Encryption (JWE).
-
JWE: If using the JWE JWT type:
- Encryption secret key: Enter a secret key.
- Base64 Encoded: Select if Base64 encoding is required.
- Private encryption key: Enter a private key.
-
JWS: If using the JWS JWT type:
- Secret key: Enter a secret key.
- Base64 Encoded: Select if Base64 encoding is required.
- Public key: Enter a public key.
-
-
Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.
-
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
-
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.
Step 2: Review the data schemas¶
Any request or response schemas are displayed. Each user interface element of this step is described below.
-
Data schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.
Note
Data supplied in a transformation takes precedence over the activity configuration.
The JWT connector uses the Java JWT library. The schema nodes and fields are based on the selections made in step 1. For more information on the JWT specification, refer to IETF RFC 7519: JSON Web Token (JWT).
-
Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the JWT endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.
-
Back: Click to temporarily store the configuration for this step and return to the previous step.
-
Finished: Click to save the configuration for all steps and close the activity configuration.
-
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.
Next steps¶
After configuring a JWT Validate Token activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.
Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.
JWT Validate Token activities can be used as a target with these operation patterns:
- Transformation pattern
- Two-transformation pattern (as the first or second target)
To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.
When ready, deploy and run the operation and validate behavior by checking the operation logs.