Documentation Index
Fetch the complete documentation index at: https://docs-staging.auth0-mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
This list of actions allows you to generate, verify, and decode JWTs in your flows.
Learn how to configure a Vault Connection for your JSON Web Token Flow Actions at JWT Vault Connection.
Sign JSON web token
Generates a JSON web token.
| Parameter | Description |
|---|
| Payload | Data to encode. We recommend to format it according to OpenID standards. |
| Subject | Identifies the subject of the JWT. |
| Issuer | Identifies principal that issued the JWT. |
| Audience | Identifies the recipients that the JWT is intended. For example: admin.your_domain.com |
| Expires in | Identifies the expiration time on and after which the JWT must not be accepted for processing. |
Output object
| Property | Type | Description |
|---|
token | String | A JSON web token string. |
Output object example
{
"token": "eyJhbGciOiJIUzI1N..."
}
Decode JSON web token
Decodes a provided JSON web token.
| Parameter | Description |
|---|
| Token (required) | JSON web token string that will be decoded. |
Output object
| Property | Type | Description |
|---|
payload | object | The decoded and valid JSON web token content |
Output object example
{
"header": {
"alg": "HS256",
"typ": "JWT"
},
"payload": {
"sub": "1234567890",
"name": "John Doe",
"iat": 1516239022
},
"signature": "SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}
Verify JSON web token
Verifies the JSON web token data, to determine if it remains intact or has been modified, in order to guarantee its authenticity.
| Parameter | Description |
|---|
| Token (required) | JSON web token string that will be verified. |
| Issuer | The issuer of the JWT that will be verified. |
| Audience | The recipient audience of the JWT is intended that will be verified. |
Output object
| Property | Type | Description |
|---|
valid | Boolean | Returns true or false depending on whether or not the JWT has a valid signature. |
cause | String | If the valid property is false a message is displayed. |
payload | Object | The decoded and valid JSON web token content. |
Output object example
{
"valid": true,
"header": {
"alg": "HS256",
"typ": "JWT"
},
"payload": {
"sub": "1234567890",
"name": "Jane Doe",
"iat": 1516239022
},
"signature": "SflKxwRJSMe..."
}
{
"valid": false,
"cause": "INVALID_SIGNATURE"
}
