1 of 2

Logout Handling

Overview

Logout handling for all apps. An application can have a default logout landing page or it can use a custom logout page. A custom page can use all look and feel functions for e.g. overlay.

Configuration

To use a custom configuration for a logout page, the following configuration should be used.

Information endpoint module

The information endpoint module is configured to handle the logout endpoint in the application.

Please see the for detailed information.

Add the Information endpoint module to the application. Use the one-file-per-module pattern and create this file (logout.json) in the modules folder.

Examples

{
  "name": "InformationEndpoint",
  "config": {
    "http_context": "/forms",
    "endpoint": [
      {
        "context_path": "/logout",
        "template": "logout.template",
        "overlay_dirs": [<overlay_folders>]
      }
    ]
  }
}

{
  "name": "InformationEndpoint",
  "config": {
    "http_context": "/pwdreset",
    "endpoint": [
      {
        "context_path": "/logout",
        "template": "logout.template",
        "overlay_dirs": [<overlay_folders>]
      }
    ]
  }
}

{
  "name": "InformationEndpoint",
  "config": {
    "http_context": "/portal",
    "endpoint": [
      {
        "context_path": "/logout",
        "template": "logout.template",
        "overlay_dirs": [<overlay_folders>]
      }
    ]
  }
}

Application configuration

Change the application property for logout to point to the information endpoint.

"logout_endpoint_url": "<logout endpoint>",

Examples

{
  "name": "Forms",
  "config": {
    "http_context": "/forms",
    "logout_endpoint_url": "/forms/logout",
    "overlay_dirs": ["config/locale_overlay", "config/ui_overlay"],
    "flows": "@include:../flows/*/flow.json"
  }
}

{
  "name": "PasswordReset",
  "config": {
    "http_context": "/pwdreset",
    "logout_endpoint_url": "/pwdreset/logout",
    "overlay_dirs": ["config/locale_overlay", "config/ui_overlay"],
    "flows": "@include:../flows/*/flow.json"
  }
}

{
  "name": "Portal",
  "config": {
    "http_context": "/portal",
    "logout_endpoint_url": "/portal/logout",
    "overlay_dirs": ["config/locale_overlay", "config/ui_overlay"],
    "flows": "@include:../flows/*/flow.json"
  }
}

Overlay handling

Testing the UI

To test the logout UI point your browser to the logout endpoint, example below for a local installation.

http://localhost:8080/forms/logout/

Note that the actual user logout is performed via the authenticator module when the Logout button or similar is clicked in the application UI.

Configuration

To use a custom configuration for a logout page, the following configuration should be used.

Information endpoint module

The information endpoint module is configured to handle the logout endpoint in the application.

Please see the for detailed information.

Add the Information endpoint module to the application. Use the one-file-per-module pattern and create this file (logout.json) in the modules folder.

Examples

{
  "name": "InformationEndpoint",
  "config": {
    "http_context": "/forms",
    "endpoint": [
      {
        "context_path": "/logout",
        "template": "logout.template",
        "overlay_dirs": [<overlay_folders>]
      }
    ]
  }
}

{
  "name": "InformationEndpoint",
  "config": {
    "http_context": "/pwdreset",
    "endpoint": [
      {
        "context_path": "/logout",
        "template": "logout.template",
        "overlay_dirs": [<overlay_folders>]
      }
    ]
  }
}

{
  "name": "InformationEndpoint",
  "config": {
    "http_context": "/portal",
    "endpoint": [
      {
        "context_path": "/logout",
        "template": "logout.template",
        "overlay_dirs": [<overlay_folders>]
      }
    ]
  }
}

Application configuration

Change the application property for logout to point to the information endpoint.

"logout_endpoint_url": "<logout endpoint>",

Examples

{
  "name": "Forms",
  "config": {
    "http_context": "/forms",
    "logout_endpoint_url": "/forms/logout",
    "overlay_dirs": ["config/locale_overlay", "config/ui_overlay"],
    "flows": "@include:../flows/*/flow.json"
  }
}

{
  "name": "PasswordReset",
  "config": {
    "http_context": "/pwdreset",
    "logout_endpoint_url": "/pwdreset/logout",
    "overlay_dirs": ["config/locale_overlay", "config/ui_overlay"],
    "flows": "@include:../flows/*/flow.json"
  }
}

{
  "name": "Portal",
  "config": {
    "http_context": "/portal",
    "logout_endpoint_url": "/portal/logout",
    "overlay_dirs": ["config/locale_overlay", "config/ui_overlay"],
    "flows": "@include:../flows/*/flow.json"
  }
}

Overlay handling

Overlay for the logout page can now be configured as for any application. See for details.

Testing the UI

To test the logout UI point your browser to the logout endpoint, example below for a local installation.

http://localhost:8080/forms/logout/

Note that the actual user logout is performed via the authenticator module when the Logout button or similar is clicked in the application UI.