X4 Produktdokumentation

User Session Adapter

This adapter allows the data in the data stream to be written to the user session, read and list data from the user session, and invalidate the user session.


Properties

Operation

Operation executed by the adapter

Possible values:

  • Store Content: Writes the data in the data stream to the user session.

  • Get Content: Returns the data set specified in the key parameter from the user session.

  • List Content: Returns a list of the data in the user session.

  • Check User Session: Checks whether a user session exists and returns the user session ID.

  • Clear Session Data: Deletes the data in the user session and invalidates the user session.

Parameters

key

For the Get User Session operation: Used as a filter.

For the Store User Session operation: Used as the name used to store the data in the data stream in the user session.

Possible values:

Any string

sessionIdClaim

Name of the claim that contains the session ID in the token.

Possible values:

  • sid (default): Claim for the session ID for Keycloak

  • Any string

sessionLifetime

Sets the lifetime of the user session in minutes. When the session has expired, all data stored through the Store Content operation will be deleted. The timer is reset each time the data is accessed.

Possible values:

Any integer greater than 0 (default: 30)

Status values

1

The adapter operation was successful.

-1

An error occurred while running the adapter.

0

The adapter operation did not return any results.