Usage of "User Session Note Mapper" #45891

sanbernas · 2026-01-30T10:44:24Z

sanbernas
Jan 30, 2026

I'm trying to store a claim from a upstream IdP token as session note (User Session Note Mapper) and write this claim into the access token towards the client.
Background:
Reason for that is, that I don't want to store this sensitive information on the user object in the keycloak DB. Otherwise I could use a mapper type "Attribute Importer". Furthermore, the users are "Read only" beacuse they are also fetched from a LDAP Directory.

So as I understand the "User Session Note Mapper" is suitable for this use case. But it's not working, the desired claim is missing in the token for the client. I'm not sure if I do it the right way. Here my approach:

Create the Session Note Mapper on the relevant IdP (Assume, that the IdP provides a Claim "foo" with value "bar" in the Id Token)

Adding a Session Note Mapper in the Client Configuration (in the dedicated scope)

Is that the way the feature should work for the described usecase?

In the IdP Mapper I'm not really sure how this should be used. My understanding is:

Name: only local relevance, not used for reference on the client side
Claim key: The key of the session note which is stored in the session
Claim value: The name of the claim in the upstream token

Keycloak Version: 26.4.1

Many thanks for any help.

sanbernas · 2026-02-04T18:19:48Z

sanbernas
Feb 4, 2026
Author

Ok got it. In the IdP "Session Note Mapper" the Token "Key" is the name of the source claim in the Token from the IdP.
I had to configure Key "foo", Value ".* and activate Regex Claim Values.
The name then of the session note is foo. If required a translation can be done on the client mapper side.

0 replies

Navigation Menu

Repository navigation

Usage of "User Session Note Mapper" #45891

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 1 comment

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

Usage of "User Session Note Mapper" #45891

Uh oh!

Uh oh!

sanbernas Jan 30, 2026

Replies: 1 comment

Uh oh!

sanbernas Feb 4, 2026 Author

sanbernas
Jan 30, 2026

sanbernas
Feb 4, 2026
Author