Skip to Content

JWT Generate Token activity

Introduction

A JWT Generate Token activity, using its JWT connection, generates a JSON Web Token (JWT) and is intended to be used as a target to consume data in an operation.

Create a JWT Generate Token activity

An instance of a JWT Generate Token activity is created from a JWT connection using its Generate 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 Generate Token activity can be edited from these locations:

Configure a JWT Generate Token activity

Follow these steps to configure a JWT Generate Token activity:

Step 1: Enter a name and specify settings

In this step, provide a name for the activity and specify the JWT type, JWT type-dependent settings, and optional settings. Each user interface element of this step is described below.

JWT Generate Token activity configuration step 1

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 Generate Token activity and must not contain forward slashes / or colons :.

  • JWT type: Select between signing the JWT using a JSON Web Signature (JWS) or encrypting it using JSON Web Encryption (JWE).

    Important

    If signatures or encryption are not required, select the JWS JWT type and the None Signature type.

    • JWE: If using the JWE JWT type:

      • Key management algorithm type: One of Asymmetric or Symmetric.

        • Asymmetric: If using the Asymmetric key management algorithm type:

          JWT Generate Token activity configuration step 1 jwe asym

          • Asymmetric key management algorithms: One of RSA1_5, RSA_OAEP, or RSA_OAEP_256.
          • Public encryption key: Enter a public key.

        • Symmetric: If using the Symmetric key management algorithm type:

          JWT Generate Token activity configuration step 1 jwe sym

          • Symmetric key management algorithms: One of A128KW, A192KW, or A256KW.
          • Encryption secret key: Enter a secret key.
          • Base64 Encoded: Select if Base64 encoding is required.

      • Content encryption algorithms: One of A128CBC_HS256, A128GCM, A192CBC_HS384, A192GCM, A256CBC_HS512, or A256GCM.

    • JWS: If using the JWS JWT type:

      • Signature type: One of Asymmetric, Symmetric, or None.

        • Asymmetric: If using the Asymmetric signature type:

          JWT Generate Token activity configuration step 1 jws asym

          • Signature algorithms: One of ES256, ES384, ES512, PS256, PS384, PS512, RS256, RS384, or RS512.
          • Private key: Enter a Private key.

        • Symmetric: If using the Symmetric Signature type:

          JWT Generate Token activity configuration step 1 jws sym

          • Signature algorithms: One of HS256, HS384, or HS512.
          • Secret key: Enter a secret key.
          • Base64 Encoded: Select if Base64 encoding is required.

        • None: If using the None Signature type, no additional fields appear.

  • Optional settings: Click to expand additional optional settings:

    JWT Generate Token activity configuration step 1 optional

    • Payload Properties: The JWT payload.
    • Header Properties: Metadata relevant to the JWT payload.

    As shown above, each payload and header definition has the following properties:

    • Key: The name or key of the payload or header object. For example, alg, typ, cty, or kid for header objects.
    • Value: The data associated with the key for a payload or header object.
    • Data Type: The data type representing a payload or header object's value. The data type must be one of boolean, decimal, number, or string.

    For more information on the JWT payloads and headers, refer to IETF RFC 7519: JSON Web Token (JWT).

  • 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.

JWT Generate Token activity configuration step 2

  • 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 payload and header nodes' key, value and dataType fields correspond with the properties described under Optional Settings in step 1.

    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 Generate 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 Generate Token activities can be used as a target with these operation patterns:

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.