Package com.authlete.common.dto

Class BackchannelLogoutTokenResponse

java.lang.Object

com.authlete.common.dto.ApiResponse

com.authlete.common.dto.BackchannelLogoutTokenResponse

All Implemented Interfaces:

Serializable

public class BackchannelLogoutTokenResponse
extends ApiResponse

Response from Authlete's /api/{serivce-id}/backchannel/logout/token API.

The Authlete API generates a Logout Token that complies with the OpenID Connect Back-Channel Logout 1.0 specification.

If the value of the action parameter in the response from the Authlete API is OK, it indicates that a Logout Token has been generated successfully. In this case, your server is expected to send a Back-Channel Logout Request containing the generated Logout Token to the client's Backchannel Logout URI.

The logoutToken parameter in the API response contains the generated Logout Token, and the backchannelLogoutUri parameter contains the client's Back-Channel Logout URI, which corresponds to the backchannel_logout_uri client metadata parameter. Using these values, the Back-Channel Logout Request can be constructed as follows.

 POST getBackchannelLogoutUri() HTTP/1.1
 Content-Type: application/x-www-form-urlencoded
 Content-Length: ...

 logout_token=getLogoutToken()

Note that the Authlete API does not verify whether the client's backchannel_logout_uri metadata parameter is configured properly. Therefore, the value of the backchannelLogoutUri response parameter may not be a valid HTTP-accessible URL. It may even be null.

Also note that the API call does not revoke any refresh tokens. If necessary, the client itself should trigger refresh token revocation (e.g., by calling the revocation endpoint).

Since:

4.43, Authlete 3.0.32

See Also:

OpenID Connect Back-Channel Logout 1.0, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BackchannelLogoutTokenResponse.Action	The next action that the API caller should take.

Constructor Summary

Constructors

Constructor	Description
BackchannelLogoutTokenResponse()

Method Summary

Modifier and Type	Method	Description
BackchannelLogoutTokenResponse.Action	getAction()	Get the next action that the API caller should take.
URI	getBackchannelLogoutUri()	Get the client's Back-Channel Logout URI, which corresponds to the backchannel_logout_uri client metadata parameter defined in the OpenID Connect Back-Channel Logout 1.0 specification.
String	getLogoutToken()	Get the issued Logout Token.
BackchannelLogoutTokenResponse	setAction(BackchannelLogoutTokenResponse.Action action)	Set the next action that API caller should take.
BackchannelLogoutTokenResponse	setBackchannelLogoutUri(URI uri)	Set the client's Back-Channel Logout URI, which corresponds to the backchannel_logout_uri client metadata parameter defined in the OpenID Connect Back-Channel Logout 1.0 specification.
BackchannelLogoutTokenResponse	setLogoutToken(String logoutToken)	Set the issued Logout Token.

Methods inherited from class com.authlete.common.dto.ApiResponse

getResponseHeaders, getResultCode, getResultMessage, setResponseHeaders, setResultCode, setResultMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BackchannelLogoutTokenResponse

public BackchannelLogoutTokenResponse()

Method Detail

getAction

public BackchannelLogoutTokenResponse.Action getAction()

Get the next action that the API caller should take. In practice, this value represents the result of the API call.

Returns:

The next action that the API caller should take.

setAction

public BackchannelLogoutTokenResponse setAction(BackchannelLogoutTokenResponse.Action action)

Set the next action that API caller should take. In practice, this value represents the result of the API call.

Parameters:

action - The next action that the API caller should take.

Returns:

this object.

getLogoutToken

public String getLogoutToken()

Get the issued Logout Token.

Returns:

The issued Logout Token.

setLogoutToken

public BackchannelLogoutTokenResponse setLogoutToken(String logoutToken)

Set the issued Logout Token.

Parameters:

logoutToken - The issued Logout Token.

Returns:

this object.

getBackchannelLogoutUri

public URI getBackchannelLogoutUri()

Get the client's Back-Channel Logout URI, which corresponds to the backchannel_logout_uri client metadata parameter defined in the OpenID Connect Back-Channel Logout 1.0 specification.

Returns:

The client's Back-Channel Logout URI.

setBackchannelLogoutUri

public BackchannelLogoutTokenResponse setBackchannelLogoutUri(URI uri)

Set the client's Back-Channel Logout URI, which corresponds to the backchannel_logout_uri client metadata parameter defined in the OpenID Connect Back-Channel Logout 1.0 specification.

Parameters:

uri - The client's Back-Channel Logout URI.

Returns:

this object.