Skip to main content

ILogoutTokenService Interface

Abblix.Oidc.Server​

Abblix.Oidc.Server.Features.Tokens​

ILogoutTokenService Interface​

Issues OpenID Connect Back-Channel Logout tokens (OIDC Back-Channel Logout 1.0 §2.4): JWTs with an events claim containing the back-channel logout event URI, addressed to a specific RP and identifying the affected end-user via sub and/or sid. The nonce claim is prohibited per the specification.

public interface ILogoutTokenService

Derived
↳ LogoutTokenService

Methods​

ILogoutTokenService.CreateLogoutTokenAsync(ClientInfo, LogoutContext) Method​

Asynchronously generates a logout token that encapsulates information about a user's logout event. This token is sent to clients to initiate the back-channel logout process, enabling them to clean up user sessions in accordance with the OpenID Connect back-channel logout specification.

System.Threading.Tasks.Task<Abblix.Oidc.Server.Features.Tokens.EncodedJsonWebToken> CreateLogoutTokenAsync(Abblix.Oidc.Server.Features.ClientInformation.ClientInfo clientInfo, Abblix.Oidc.Server.Features.LogoutNotification.LogoutContext logoutContext);

Parameters​

clientInfo ClientInfo​

Details about the client application that will receive the logout token. This includes the client's identifier and other relevant configuration settings that may affect the token generation process.

logoutContext LogoutContext​

Contextual information related to the logout event, such as the user's identifier (sub) and the session identifier (sid) that uniquely identifies the session being logged out. Additional information about the logout event, such as the reason for logout, can also be included if supported by the implementation.

Returns​

System.Threading.Tasks.Task<EncodedJsonWebToken>
A task that returns a JsonWebToken. This token is specifically formatted to conform to the OpenID Connect back-channel logout specification, containing claims such as 'sub', 'sid', and 'events' to indicate the logout event to the client.