fusionauth logo
search-interface-symbol
Quickstarts
API Docs
SDK
search-interface-symbol
talk to an expert
Log In
talk to an expert
Navigate to...
  • Welcome
  • Getting Started
    • Getting Started
    • 5-minute Setup Guide
      • Overview
      • Docker
      • Fast Path
      • Sandbox
    • Setup Wizard & First Login
    • Register a User and Login
    • Self-service Registration
    • Start and Stop FusionAuth
    • Core Concepts
      • Overview
      • Users
      • Roles
      • Groups
      • Registrations
      • Applications
      • Tenants
      • Identity Providers
      • Authentication/Authorization
      • Integration Points
    • Example Apps
      • Overview
      • Dart
      • Go
      • Java
      • JavaScript
      • .NET Core
      • PHP
      • Python
      • Ruby
    • Tutorials
      • Overview
      • Java Spring
      • Python Django
      • Ruby on Rails
  • Installation Guide
    • Overview
    • System Requirements
    • Server Layout
    • Cloud
    • Cluster
    • Docker
    • Fast Path
    • Kubernetes
      • Overview
      • Deployment Guide
      • Minikube Setup
      • Amazon EKS Setup
      • Google GKE Setup
      • Microsoft AKS Setup
    • Kickstart™
    • Homebrew
    • Marketplaces
    • Packages
    • Database
    • FusionAuth App
    • FusionAuth Search
    • Common Configuration
  • Migration Guide
    • Overview
    • General
    • Auth0
    • Keycloak
    • Amazon Cognito
    • Firebase
    • Microsoft Azure AD B2C
    • Tutorial
  • Admin Guide
    • Overview
    • Account Portal
    • Config Management
    • Editions and Features
    • Key Rotation
    • Licensing
    • Monitoring
    • Prometheus Setup
    • Proxy Setup
    • Reference
      • Overview
      • Configuration
      • CORS
      • Data Types
      • Hosted Login Pages Cookies
      • Known Limitations
      • Password Hashes
    • Releases
    • Roadmap
    • Search And FusionAuth
    • Securing
    • Switch Search Engines
    • Technical Support
    • Troubleshooting
    • Upgrading
    • WebAuthn
  • Login Methods
    • Identity Providers
      • Overview
      • Apple
      • Epic Games
      • External JWT
        • Overview
        • Example
      • Facebook
      • Google
      • HYPR
      • LinkedIn
      • Nintendo
      • OpenID Connect
        • Overview
        • Amazon Cognito
        • Azure AD
        • Discord
        • Github
        • Okta
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • SAML v2
        • Overview
        • ADFS
        • Azure AD
        • Okta
      • SAML v2 IdP Initiated
        • Overview
        • Okta
      • Xbox
    • OIDC & OAuth 2.0
      • Overview
      • Endpoints
      • Tokens
      • OAuth Modes
      • URL Validation
    • Passwordless
      • Overview
      • Magic Links
      • WebAuthn & Passkeys
    • SAML v2 IdP
      • Overview
      • Google
      • PagerDuty
      • Tableau Cloud
      • Zendesk
  • Developer Guide
    • Overview
    • API Gateways
      • Overview
      • Amazon API Gateway
      • Kong Gateway
      • ngrok Cloud Edge
    • Client Libraries & SDKs
      • Overview
      • Dart
      • Go
      • Java
      • JavaScript
      • .NET Core
      • Node
      • OpenAPI
      • PHP
      • Python
      • React
      • Ruby
      • Typescript
    • Events & Webhooks
      • Overview
      • Writing a Webhook
      • Securing Webhooks
      • Events
        • Overview
        • Audit Log Create
        • Event Log Create
        • JWT Public Key Update
        • JWT Refresh
        • JWT Refresh Token Revoke
        • Kickstart Success
        • Group Create
        • Group Create Complete
        • Group Delete
        • Group Delete Complete
        • Group Update
        • Group Update Complete
        • Group Member Add
        • Group Member Add Complete
        • Group Member Remove
        • Group Member Remove Complete
        • Group Member Update
        • Group Member Update Complete
        • User Action
        • User Bulk Create
        • User Create
        • User Create Complete
        • User Deactivate
        • User Delete
        • User Delete Complete
        • User Email Update
        • User Email Verified
        • User IdP Link
        • User IdP Unlink
        • User Login Failed
        • User Login Id Dup. Create
        • User Login Id Dup. Update
        • User Login New Device
        • User Login Success
        • User Login Suspicious
        • User Password Breach
        • User Password Reset Send
        • User Password Reset Start
        • User Password Reset Success
        • User Password Update
        • User Reactivate
        • User Reg. Create
        • User Reg. Create Complete
        • User Reg. Delete
        • User Reg. Delete Complete
        • User Registration Update
        • User Reg. Update Complete
        • User Reg. Verified
        • User 2FA Method Add
        • User 2FA Method Remove
        • User Update
        • User Update Complete
    • Guides
      • Overview
      • Application Specific Email Templates
      • Authentication Tokens
      • Exposing A Local Instance
      • JSON Web Tokens
      • Key Master
      • Localization and Internationalization
      • Multi-Factor Authentication
      • Multi-Tenant
      • Passwordless
      • Registration-based Email Verification
      • Searching With Elasticsearch
      • Securing Your APIs
      • Silent Mode
      • Single Sign-on
      • Two Factor (pre 1.26)
    • Integrations
      • Overview
      • CleanSpeak
      • Kafka
      • Twilio
    • Plugins
      • Overview
      • Writing a Plugin
      • Custom Password Hashing
    • User Control & Gating
      • Overview
      • Gate Unverified Users
      • Gate Unverified Registrations
      • User Account Lockout
  • Customization
    • Email & Templates
      • Overview
      • Configure Email
      • Email Templates
      • Email Variables
      • Message Templates
    • Lambdas
      • Overview
      • Apple Reconcile
      • Client Cred. JWT Populate
      • Epic Games Reconcile
      • External JWT Reconcile
      • Facebook Reconcile
      • Google Reconcile
      • HYPR Reconcile
      • JWT Populate
      • LDAP Connector Reconcile
      • LinkedIn Reconcile
      • Nintendo Reconcile
      • OpenID Connect Reconcile
      • SAML v2 Populate
      • SAML v2 Reconcile
      • SCIM Group Req. Converter
      • SCIM Group Resp. Convtr.
      • SCIM User Req. Converter
      • SCIM User Resp. Converter
      • Self-Service Registration
      • Sony PSN Reconcile
      • Steam Reconcile
      • Twitch Reconcile
      • Twitter Reconcile
      • Xbox Reconcile
    • Messengers
      • Overview
      • Generic Messenger
      • Twilio Messenger
    • Themes
      • Overview
      • Examples
      • Helpers
      • Localization
      • Template Variables
      • Kickstart Custom Theme
  • Premium Features
    • Overview
    • Advanced Registration Forms
    • Advanced Threat Detection
    • Application Specific Themes
    • Breached Password Detection
    • Connectors
      • Overview
      • Generic Connector
      • LDAP Connector
      • FusionAuth Connector
    • Entity Management
    • SCIM
      • Overview
      • Azure AD Client
      • Okta Client
      • SCIM-SDK
    • Self Service Account Mgmt
      • Overview
      • Updating User Data & Password
      • Add Two-Factor Authenticator
      • Add Two-Factor Email
      • Add Two-Factor SMS
      • Add WebAuthn Passkey
      • Customizing
      • Troubleshooting
    • WebAuthn
  • APIs
    • Overview
    • Authentication
    • Errors
    • API Explorer
    • Actioning Users
    • API Keys
    • Applications
    • Audit Logs
    • Connectors
      • Overview
      • Generic
      • LDAP
    • Consents
    • Emails
    • Entity Management
      • Overview
      • Entities
      • Entity Types
      • Grants
    • Event Logs
    • Families
    • Forms
    • Form Fields
    • Groups
    • Identity Providers
      • Overview
      • Links
      • Apple
      • External JWT
      • Epic Games
      • Facebook
      • Google
      • HYPR
      • LinkedIn
      • Nintendo
      • OpenID Connect
      • SAML v2
      • SAML v2 IdP Initiated
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • Xbox
    • Integrations
    • IP Access Control Lists
    • JWT
    • Keys
    • Lambdas
    • Login
    • Message Templates
    • Messengers
      • Overview
      • Generic
      • Twilio
    • Multi-Factor/Two Factor
    • Passwordless
    • Reactor
    • Registrations
    • Reports
    • SCIM
      • Overview
      • SCIM User
      • SCIM Group
      • SCIM EnterpriseUser
      • SCIM Service Provider Config.
    • System
    • Tenants
    • Themes
    • Users
    • User Actions
    • User Action Reasons
    • User Comments
    • WebAuthn
    • Webhooks
  • Release Notes

    JWT Refresh Token Revoke

    JWT Refresh Token Revoke

    This event is generated when a refresh token is revoked. The JSON includes either the User Id and User or the Application Id depending on what was revoked. It will also include the time to live duration (in seconds) for each Application. This value is used to determine if JWTs are valid or not based on their expiration instants.

    The following scenarios will cause this event to be generated:

    • A single Refresh Token is revoked

    • All Refresh Tokens owned by a single User are revoked (if there is at least one valid Refresh Token for this User)

    • All Refresh Tokens owned by a single User for an Application are revoked

    • All Refresh Tokens for an Application are revoked

    Event type
    
    jwt.refresh-token.revoke

    Event Scope

    Prior to version 1.37.0 this was a tenant or application scoped event. It can be sent to all applications or to one or more specified applications.

    The ability to limit the generation of an event for only certain applications is legacy functionality and is removed as of version 1.37.0. In earlier versions, you almost certainly want to enable this event at the tenant level and optionally filter on the tenantId when consuming the event.

    In version 1.37.0 and later this is a tenant scoped event. It can be sent to all tenants or to one or more specified tenants. Those tenants will only be sent events related to their tenant. You can optionally also filter on the applicationId when consuming the event.

    Revoking Single Refresh Token

    This example JSON would reflect a scenario where a single refresh token is revoked for a single user for a single application.

    Transaction Compatibility

    This event is transactional. The final state of the operation which caused the webhook is not persisted to FusionAuth until after the webhook finishes; learn more.

    Event Body

    event.applicationId [UUID]

    The unique Id of the Application for which the refresh token have been revoked.

    event.applicationTimeToLiveInSeconds [Map<UUID, Integer>]

    A map of Application Id to the configured time to live (TTL) for the access token (JWT). This can be used to identify the maximum amount of time after this event occurred where an un-expired access token may be held by a user.

    If you take the createInstant of this event and add the number of seconds for a specific application TTL you come up with an instant in time where you should consider all access tokens issued before this time invalid. This is because the access token will have been issued on or before the instant the refresh token was revoked.

    This map will contain a single entry for the application represented by the applicationId field.

    event.createInstant [Long]

    The instant that the event was generated.

    event.id [UUID]

    The unique Id of the event. You may receive an event more than once based upon your transaction settings. This Id may be used to identify a duplicate event.

    event.info.data [Object] Available since 1.30.0

    An object that can hold any information about the event that should be persisted.

    event.info.deviceDescription [String] Available since 1.30.0

    The description of the device associated with the event.

    event.info.deviceName [String] Available since 1.30.0

    The device name associated with the event.

    event.info.deviceType [String] Available since 1.30.0

    The type of device associated with the event.

    event.info.ipAddress [String] Available since 1.27.0

    The source IP address of the event.

    event.info.location.city [String] Available since 1.30.0

    The city where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.location.country [String] Available since 1.30.0

    The country where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.location.latitude [String] Available since 1.30.0

    The latitude where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.location.longitude [String] Available since 1.30.0

    The longitude where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.location.region [String] Available since 1.30.0

    The geographic location where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.location.zipcode [String] Available since 1.30.0

    The zip code where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.os [String] Available since 1.30.0

    The operating system associated with the event.

    event.info.userAgent [String] Available since 1.30.0

    The user agent associated with the event.

    event.refreshToken [Object] Available since 1.37.0

    The refresh token being revoked. This is only returned when a single refresh token is revoked. See the JWT API for property definitions and example JSON.

    event.tenantId [UUID] Available since 1.8.0

    The unique tenant identifier. This value may not be returned if not applicable.

    event.type [String]

    The event type, this value will always be jwt.refresh-token.revoke.

    event.userId [UUID]

    The unique Id of the User for which a refresh token has been revoked.

    event.user [Object] Available since 1.8.0

    The user for which a refresh token has been revoked. See the Users API for property definitions and example JSON.

    Example Event JSON
    
    {
      "event": {
        "applicationId": "21a8893c-51b3-4964-8a50-6afb66ee8acd",
        "applicationTimeToLiveInSeconds": {
          "21a8893c-51b3-4964-8a50-6afb66ee8acd": 600
        },
        "createInstant": 1505762615056,
        "id": "e502168a-b469-45d9-a079-fd45f83e0406",
        "info": {
          "ipAddress": "42.42.42.42",
          "location": {
            "city": "Denver",
            "country": "US",
            "displayString": "Denver, CO, US",
            "latitude": 39.77777,
            "longitude": -104.9191,
            "region": "CO"
          },
          "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36"
        },
        "refreshToken": {
          "applicationId": "21a8893c-51b3-4964-8a50-6afb66ee8acd",
          "id": "8b765761-5c7b-4f49-be88-af4eabcf4903",
          "insertInstant": 1505762505056,
          "metaData": {
            "device": {
              "lastAccessedAddress": "65.133.53.42",
              "lastAccessedInstant": 1675457978462,
              "name": "Richard's Hooli Phone",
              "type": "MOBILE"
            },
            "scopes": [
              "offline_access"
            ]
          },
          "startInstant": 1675457978462,
          "token": "ZxhAMC-Xr78DUnnuWhvADjUUXpMHUSGuahkA-EXAMPLE",
          "userId": "dfdbae16-4e65-42c2-9773-23dfd6f5671d"
        },
        "tenantId": "e872a880-b14f-6d62-c312-cb40f22af465",
        "type": "jwt.refresh-token.revoke",
        "userId": "dfdbae16-4e65-42c2-9773-23dfd6f5671d",
        "user": {
          "active": true,
          "email": "example@fusionauth.io",
          "id": "00000000-0000-0001-0000-000000000000",
          "passwordChangeRequired": false,
          "tenantId": "f24aca2b-ce4a-4dad-951a-c9d690e71415",
          "twoFactorEnabled": false,
          "usernameStatus": "ACTIVE",
          "verified": true
        }
      }
    }

    All User Refresh Tokens Revoked

    This example JSON would reflect a scenario where all refresh tokens owned by a single user are revoked.

    Event Body

    event.applicationTimeToLiveInSeconds [Map<UUID, Integer>]

    A map of Application Id to the configured time to live (TTL) for the access token (JWT). This can be used to identify the maximum amount of time after this event occurred where an un-expired access token may be held by a user.

    If you take the createInstant of this event and add the number of seconds for a specific application TTL you come up with an instant in time where you should consider all access tokens issued before this time invalid. This is because the access token will have been issued on or before the instant the refresh token was revoked.

    This map will contain an entry for each application for which the user has a refresh token.

    event.createInstant [Long]

    The instant that the event was generated.

    event.id [UUID]

    The unique Id of the event. You may receive an event more than once based upon your transaction settings. This Id may be used to identify a duplicate event.

    event.info.data [Object] Available since 1.30.0

    An object that can hold any information about the event that should be persisted.

    event.info.deviceDescription [String] Available since 1.30.0

    The description of the device associated with the event.

    event.info.deviceName [String] Available since 1.30.0

    The device name associated with the event.

    event.info.deviceType [String] Available since 1.30.0

    The type of device associated with the event.

    event.info.ipAddress [String] Available since 1.27.0

    The source IP address of the event.

    event.info.location.city [String] Available since 1.30.0

    The city where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.location.country [String] Available since 1.30.0

    The country where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.location.latitude [String] Available since 1.30.0

    The latitude where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.location.longitude [String] Available since 1.30.0

    The longitude where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.location.region [String] Available since 1.30.0

    The geographic location where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.location.zipcode [String] Available since 1.30.0

    The zip code where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.os [String] Available since 1.30.0

    The operating system associated with the event.

    event.info.userAgent [String] Available since 1.30.0

    The user agent associated with the event.

    event.tenantId [UUID] Available since 1.8.0

    The unique tenant identifier. This value may not be returned if not applicable.

    event.type [String]

    The event type, this value will always be jwt.refresh-token.revoke.

    event.userId [UUID]

    The unique Id of the User for which all refresh tokens have been revoked.

    event.user [Object] Available since 1.8.0

    The user for which a refresh token has been revoked. See the Users API for property definitions and example JSON.

    Example Event JSON
    
    {
      "event": {
        "applicationTimeToLiveInSeconds": {
          "21a8893c-51b3-4964-8a50-6afb66ee8acd": 600
        },
        "createInstant": 1505762615056,
        "id": "e502168a-b469-45d9-a079-fd45f83e0406",
        "info": {
          "ipAddress": "42.42.42.42",
          "location": {
            "city": "Denver",
            "country": "US",
            "displayString": "Denver, CO, US",
            "latitude": 39.77777,
            "longitude": -104.9191,
            "region": "CO"
          },
          "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36"
        },
        "tenantId": "e872a880-b14f-6d62-c312-cb40f22af465",
        "type": "jwt.refresh-token.revoke",
        "userId": "dfdbae16-4e65-42c2-9773-23dfd6f5671d",
        "user": {
          "active": true,
          "email": "example@fusionauth.io",
          "id": "00000000-0000-0001-0000-000000000000",
          "passwordChangeRequired": false,
          "twoFactorEnabled": false,
          "usernameStatus": "ACTIVE",
          "verified": true
        }
      }
    }

    All Applications Refresh Tokens Revoked

    This example JSON would reflect a scenario where all refresh tokens issued for a specific application are revoked.

    Event Body

    event.applicationId [UUID]

    The unique Id of the Application for which all of the refresh tokens have been revoked.

    event.applicationTimeToLiveInSeconds [Map<UUID, Integer>]

    A map of Application Id to the configured time to live (TTL) for the access token (JWT). This can be used to identify the maximum amount of time after this event occurred where an un-expired access token may be held by a user.

    If you take the createInstant of this event and add the number of seconds for a specific application TTL you come up with an instant in time where you should consider all access tokens issued before this time invalid. This is because the access token will have been issued on or before the instant the refresh token was revoked.

    event.createInstant [Long]

    The instant that the event was generated.

    event.id [UUID]

    The unique Id of the event. You may receive an event more than once based upon your transaction settings. This Id may be used to identify a duplicate event.

    event.info.data [Object] Available since 1.30.0

    An object that can hold any information about the event that should be persisted.

    event.info.deviceDescription [String] Available since 1.30.0

    The description of the device associated with the event.

    event.info.deviceName [String] Available since 1.30.0

    The device name associated with the event.

    event.info.deviceType [String] Available since 1.30.0

    The type of device associated with the event.

    event.info.ipAddress [String] Available since 1.27.0

    The source IP address of the event.

    event.info.location.city [String] Available since 1.30.0

    The city where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.location.country [String] Available since 1.30.0

    The country where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.location.latitude [String] Available since 1.30.0

    The latitude where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.location.longitude [String] Available since 1.30.0

    The longitude where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.location.region [String] Available since 1.30.0

    The geographic location where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.location.zipcode [String] Available since 1.30.0

    The zip code where the event originated.

    Note: A paid plan is required to utilize event info location.

    event.info.os [String] Available since 1.30.0

    The operating system associated with the event.

    event.info.userAgent [String] Available since 1.30.0

    The user agent associated with the event.

    event.tenantId [UUID] Available since 1.8.0

    The unique tenant identifier. This value may not be returned if not applicable.

    event.type [String]

    The event type, this value will always be jwt.refresh-token.revoke.

    Example Event JSON
    
    {
      "event": {
        "applicationId": "21a8893c-51b3-4964-8a50-6afb66ee8acd",
        "applicationTimeToLiveInSeconds": {
          "21a8893c-51b3-4964-8a50-6afb66ee8acd": 600
        },
        "createInstant": 1505762615056,
        "id": "e502168a-b469-45d9-a079-fd45f83e0406",
        "info": {
          "ipAddress": "42.42.42.42",
          "location": {
            "city": "Denver",
            "country": "US",
            "displayString": "Denver, CO, US",
            "latitude": 39.77777,
            "longitude": -104.9191,
            "region": "CO"
          },
          "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36"
        },
        "tenantId": "e872a880-b14f-6d62-c312-cb40f22af465",
        "type": "jwt.refresh-token.revoke"
      }
    }

    Feedback

    How helpful was this page?

    See a problem?

    File an issue in our docs repo

    Have a question or comment to share?

    Visit the FusionAuth community forum.

    © 2023 FusionAuth
    How-to
    Blog
    Expert Advice
    Download
    Subscribe for developer updates