Sign in

v17

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-0491166902.9 KB
Back-Channel Logout

Backchannel Logout Token Issuing

The /backchannel/logout/token API issues a logout token for a client application in the context of OpenID Connect Back-Channel Logout 1.0.

post/api/{serviceId}/backchannel/logout/token

Path parameters

serviceIdstring required

A service ID.

Request body

clientIdentifierstring required

The identifier of the client application. Either a client ID or a client alias.

subjectstring

The subject (end-user) identifier. The logout token will be issued for this subject. At least one of subject or sessionId must be provided.

sessionIdstring

The session ID (sid) identifying the user session to log out. At least one of subject or sessionId must be provided.

Response

resultCodestring

The code which represents the result of the API call.

resultMessagestring

A short message which explains the result of the API call.

action'OK' | 'SERVER_ERROR' | 'CALLER_ERROR'

The next action that the API caller should take.

logoutTokenstring

The logout token issued for the client. The caller should deliver this token to the client's backchannelLogoutUri.

backchannelLogoutUristring

The backchannel logout URI of the client. The caller should POST the logoutToken to this URI.