FLAT
CouperSevenval TechnologiesDocker ImageGithub
master
master
  • Changelog
  • FLAT
  • Administration
    • Configuration
    • Docker
    • Logging
  • Cookbook
    • Using the Built-in Mocking
    • Performing Additional Checks on JWT Access Tokens
    • Logging Custom Fields
    • Using Environment Variables
    • Handling Errors with an Error Flow
    • File Serving
    • Forwarding a Request to an Upstream API
    • Extracting Common Initialization Flow Tasks
    • Encoding and Decoding JWT
    • Passing Header Fields to the Client
    • How can I pass an arbitrary header field to an upstream system?
    • Performing Additional Checks on JWT Access Tokens
    • Proxying requests to Upstream APIs
    • Increasing the Request Timeout
    • How can I see what the client requested?
    • Using Swagger UI for API Documentation
    • Testing API Requests
    • Testing with Backend Requests
    • Testing Templates
    • Sending POST Requests
    • Processing Upstream Responses
    • Protecting Access using JWT Tokens
  • Reference
    • Configuration
    • Debugging
    • flat CLI
    • Flow
    • Variables
    • OpenAPI / Swagger Integration
    • OpenAPI
      • CORS - Cross-Origin Resource Sharing
    • OpenAPI
      • Differences from Swagger
    • OpenAPI
      • Mocking
    • OpenAPI
      • Routing
    • OpenAPI
      • Security
    • OpenAPI
      • Upstream APIs
    • OpenAPI
      • Validation
    • Flow Actions
      • assert Action
      • auth Action
      • backend-flow Action
      • copy Action
      • debug Action
      • dump Action
      • echo Action
      • error Action
      • eval Action
      • log Action
      • nameshave Action
      • pass-body Action
      • proxy-request Action
      • regex Action
      • request Action
      • requests Action
      • serve Action
      • set-config Action
      • set-env Action
      • set-response-headers Action
      • set-status Action
      • sub-flow Action
      • template Action
      • test-request Action
      • xslt Action
    • Functions
      • apply-codecs()
      • array-reverse()
      • array()
      • base64-decode()
      • base64-encode()
      • body()
      • calc-signature()
      • capitalize-first()
      • content()
      • decrypt-xml()
      • decrypt()
      • encrypt()
      • ends-with()
      • file-exists()
      • fit-document()
      • fit-log()
      • fit-serialize()
      • get-log()
      • has-class()
      • html-parse()
      • join()
      • json-doc()
      • json-parse()
      • json-stringify()
      • json-to-csv()
      • json-to-xml()
      • jwt-decode()
      • jwt-encode()
      • ldap-lookup()
      • ldap-query()
      • lookup()
      • matches()
      • md5()
      • replace()
      • sort()
      • split()
      • tolower()
      • toupper()
      • trim()
      • unixtime()
      • urldecode(), url-decode()
      • urlencode(), url-encode()
      • uuid3() and uuid4()
      • verify-signature()
      • verify-xmldsig()
      • xml-parse()
      • xml-to-json()
    • Templating
      • {{,}}
      • Comment {{// …}}
      • Dot {{.}}
      • Conditional `{{if <condition>}} … {{elseif <condition> }} … {{else}} … {{end}}
      • loop
      • ?? Operator
      • Object XML Notation (OXN)
      • Pair Producer {{: …}}
      • Placeholder
      • Template Variables
      • with
    • Testing
  • Tutorial
Powered by GitBook
On this page
  • Parameters
  • Example
  • See also

Was this helpful?

  1. Reference
  2. Functions

jwt-encode()

Previousjwt-decode()Nextldap-lookup()

Last updated 4 years ago

Was this helpful?

string jwt-encode((string|OXN-node-set) jwt, string key [, number time-to-live[, string algorithm]])

packs and signs a JSON web token (JWT) as JSON web signature (JWS) in compact serialization. [, ]

Parameters

data: The payload can be provided as a JSON string or .

key: For the HMAC algorithms, a Base64URL encoded symmetric key for the digital signature. For the RSASSA based algorithms, use the PEM encoded private key (without the BEGIN and END lines and without any line breaks). The key must not be password protected.

time-to-live: Sets the time span in seconds until expiration in the exp claim of the jwt. If the TTL is 0, no exp claim is added to the token – it is valid forever. Default: 0 (no expiration).

algorithm: The signature or HMAC algorithm to use.

Supported values:

  • HS256

  • HS384

  • HS512

  • RS256

  • RS384

  • RS512

Defaults to HS256. Consult for an explanation of the individual values.

The return value is a JWS compact serialization as a string:

eyJ….….…

An empty string or false will be returned if any errors occur.

Example

The variable $json contains the JSON web token to be packed, the key is read from the environment variable $JWT_SECRET. The encoded token is stored in the variable $jws. After 600 seconds the token becomes invalid:

<template out="$jws">
{{ jwt-encode($json, $env/JWT_SECRET, 600) }}
</template>

See also

(reference)

(cookbook)

(cookbook)

RFC 7519
RFC 7515
OXN
RFC 7518, section 3.1
jwt-decode()
Encoding and Decoding JWT
Protecting Access using JWT Tokens