Package com.authlete.common.dto

Class NativeSsoLogoutResponse

java.lang.Object

com.authlete.common.dto.ApiResponse

com.authlete.common.dto.NativeSsoLogoutResponse

All Implemented Interfaces:

Serializable

public class NativeSsoLogoutResponse
extends ApiResponse

A response from Authlete's /nativesso/logout API.

The /nativesso/logout API is provided to support the concept of "logout from all applications" in the context of Native SSO. This is accomplished by deleting access/refresh token records associated with the specified session ID.

In Authlete's implementation, access/refresh token records can be associated with a session ID only through the mechanism introduced by the "OpenID Connect Native SSO for Mobile Apps 1.0" specification ("Native SSO").

Since:

4.20, Authlete 3.0

See Also:

OpenID Connect Native SSO for Mobile Apps 1.0, Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
NativeSsoLogoutResponse()

Method Summary

Modifier and Type	Method	Description
NativeSsoLogoutResponse.Action	getAction()	Get the next action that the API caller should take.
int	getCount()	Get the number of deleted access/refresh token records.
NativeSsoLogoutResponse	setAction(NativeSsoLogoutResponse.Action action)	Set the next action that the API caller should take.
NativeSsoLogoutResponse	setCount(int count)	Set the number of deleted access/refresh token records.

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

NativeSsoLogoutResponse

public NativeSsoLogoutResponse()

Method Detail

getAction

public NativeSsoLogoutResponse.Action getAction()

Get the next action that the API caller should take.

Returns:

The next action to take.

setAction

public NativeSsoLogoutResponse setAction(NativeSsoLogoutResponse.Action action)

Set the next action that the API caller should take.

Parameters:

action - The next action to take.

Returns:

this object.

getCount

public int getCount()

Get the number of deleted access/refresh token records.

Returns:

The number of deleted access/refresh token records.

setCount

public NativeSsoLogoutResponse setCount(int count)

Set the number of deleted access/refresh token records.

Parameters:

count - The number of deleted access/refresh token records.

Returns:

this object.