com.authlete.common.dto.NativeSsoLogoutRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of authlete-java-common Show documentation

Authlete Java library used commonly by service implementations and the Authlete server.

The newest version!

/*
 * Copyright (C) 2025 Authlete, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.authlete.common.dto;


import java.io.Serializable;


/**
 * A request to Authlete's {@code /nativesso/logout} API.
 *
 * 
 * The {@code /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
 * @since Authlete 3.0
 *
 * @see OpenID Connect Native SSO for Mobile Apps 1.0
 */
public class NativeSsoLogoutRequest implements Serializable
{
    private static final long serialVersionUID = 1L;


    /**
     * The session ID of a user's authentication session.
     */
    private String sessionId;


    /**
     * Get the session ID of a user's authentication session.
     *
     * @return
     *         The session ID.
     */
    public String getSessionId()
    {
        return sessionId;
    }


    /**
     * Set the session ID of a user's authentication session.
     *
     * @param sessionId
     *         The session ID.
     *
     * @return
     *         {@code this} object.
     */
    public NativeSsoLogoutRequest setSessionId(String sessionId)
    {
        this.sessionId = sessionId;

        return this;
    }
}