Package com.authlete.common.dto

Class BackchannelLogoutTokenRequest

java.lang.Object

com.authlete.common.dto.BackchannelLogoutTokenRequest

All Implemented Interfaces:

Serializable

public class BackchannelLogoutTokenRequest
extends Object
implements Serializable

Request to 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.

Since:

4.43, Authlete 3.0.32

See Also:

OpenID Connect Back-Channel Logout 1.0, Serialized Form

Constructor Summary

Constructors

Constructor	Description
BackchannelLogoutTokenRequest()

Method Summary

Modifier and Type	Method	Description
String	getClientIdentifier()	Get the client identifier.
String	getSessionId()	Get the session ID.
String	getSubject()	Get the subject of the end-user.
BackchannelLogoutTokenRequest	setClientIdentifier(String identifier)	Set the client identifier.
BackchannelLogoutTokenRequest	setSessionId(String sessionId)	Set the session ID.
BackchannelLogoutTokenRequest	setSubject(String subject)	Set the subject of the end-user.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackchannelLogoutTokenRequest

public BackchannelLogoutTokenRequest()

Method Detail

getClientIdentifier

public String getClientIdentifier()

Get the client identifier. This request parameter is mandatory.

Returns:

The client identifier.

setClientIdentifier

public BackchannelLogoutTokenRequest setClientIdentifier(String identifier)

Set the client identifier. This request parameter is mandatory.

Parameters:

identifier - The client identifier.

Returns:

this object.

getSubject

public String getSubject()

Get the subject of the end-user. At least one of this subject request parameter or the sessionId request parameter is required.

This value is used as the value of the sub claim in the Logout Token.

Returns:

The subject of the end-user.

setSubject

public BackchannelLogoutTokenRequest setSubject(String subject)

Set the subject of the end-user. At least one of this subject request parameter or the sessionId request parameter is required.

This value is used as the value of the sub claim in the Logout Token.

Parameters:

subject - The subject of the end-user.

Returns:

this object.

getSessionId

public String getSessionId()

Get the session ID. At least one of this sessionId request parameter or the subject request parameter is required.

This value is used as the value of the sid claim in the Logout Token.

If the backchannel_logout_session_supported server metadata parameter of your server is true (= if the backchannelLogoutSessionSupported property of your Service is true), this request parameter should be included.

Returns:

The session ID.

setSessionId

public BackchannelLogoutTokenRequest setSessionId(String sessionId)

Set the session ID. At least one of this sessionId request parameter or the subject request parameter is required.

This value is used as the value of the sid claim in the Logout Token.

If the backchannel_logout_session_supported server metadata parameter of your server is true (= if the backchannelLogoutSessionSupported property of your Service is true), this request parameter should be included.

Parameters:

sessionId - The session ID.

Returns:

this object.