From 725ec3ab4ab6255a77d02fe9d37dc3c6a720c908 Mon Sep 17 00:00:00 2001 From: Yosi Haran Date: Thu, 19 Nov 2026 22:54:55 +0200 Subject: [PATCH 1/2] feat(auth): log out of all sessions by logout type --- README.md | 14 +++ .../com/descope/model/auth/LogoutRequest.java | 15 +++ .../model/jwt/response/JWTResponse.java | 21 ++++ .../sdk/auth/AuthenticationService.java | 12 ++ .../auth/impl/AuthenticationServiceImpl.java | 11 ++ .../impl/AuthenticationServiceImplTest.java | 111 ++++++++++++++++++ 6 files changed, 184 insertions(+) create mode 100644 src/main/java/com/descope/model/auth/LogoutRequest.java diff --git a/README.md b/README.md index b12d8837..be0214ff 100644 --- a/README.md +++ b/README.md @@ -634,6 +634,20 @@ try { ``` +You can also pass the logout types to sign out of. This returns the server's response, which includes the +cookie domain and path to clear. + +```java +try { + JWTResponse res = as.logoutAll(refreshToken, Arrays.asList("web", "mobile")); + String cookieDomain = res.getCookieDomain(); + String cookiePath = res.getCookiePath(); +} catch (DescopeException de) { + // Handle the error +} + +``` + ## Management Functions It is very common for some form of management or automation to be required. These can be performed diff --git a/src/main/java/com/descope/model/auth/LogoutRequest.java b/src/main/java/com/descope/model/auth/LogoutRequest.java new file mode 100644 index 00000000..4dc78980 --- /dev/null +++ b/src/main/java/com/descope/model/auth/LogoutRequest.java @@ -0,0 +1,15 @@ +package com.descope.model.auth; + +import java.util.List; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +@Data +@Builder +@NoArgsConstructor +@AllArgsConstructor +public class LogoutRequest { + private List logoutType; +} diff --git a/src/main/java/com/descope/model/jwt/response/JWTResponse.java b/src/main/java/com/descope/model/jwt/response/JWTResponse.java index 763fa8c0..fb199b5b 100644 --- a/src/main/java/com/descope/model/jwt/response/JWTResponse.java +++ b/src/main/java/com/descope/model/jwt/response/JWTResponse.java @@ -2,6 +2,7 @@ import com.descope.model.auth.IDPResponse; import com.descope.model.user.response.UserResponse; +import java.util.Map; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; @@ -19,10 +20,30 @@ public class JWTResponse { private UserResponse user; private Boolean firstSeen; private IDPResponse idpResponse; + private Integer sessionExpiration; + private String externalToken; + private Map claims; + private String tenantSSOID; + private String trustedDeviceJwt; + private Integer nextRefreshSeconds; + private String cookieName; + private String sessionCookieName; + private String sessionCookieDomain; + private Boolean unsavedSSO; + private String knownDeviceJwt; + private Boolean ssoAuthenticationOnly; + private Boolean userCreationDeferred; public JWTResponse(String sessionJwt, String refreshJwt, String cookieDomain, String cookiePath, Integer cookieMaxAge, Integer cookieExpiration, UserResponse user, Boolean firstSeen) { this(sessionJwt, refreshJwt, cookieDomain, cookiePath, cookieMaxAge, cookieExpiration, user, firstSeen, null); } + + public JWTResponse(String sessionJwt, String refreshJwt, String cookieDomain, String cookiePath, + Integer cookieMaxAge, Integer cookieExpiration, UserResponse user, Boolean firstSeen, + IDPResponse idpResponse) { + this(sessionJwt, refreshJwt, cookieDomain, cookiePath, cookieMaxAge, cookieExpiration, user, + firstSeen, idpResponse, null, null, null, null, null, null, null, null, null, null, null, null, null); + } } diff --git a/src/main/java/com/descope/sdk/auth/AuthenticationService.java b/src/main/java/com/descope/sdk/auth/AuthenticationService.java index c8f3b971..bfd5bc88 100644 --- a/src/main/java/com/descope/sdk/auth/AuthenticationService.java +++ b/src/main/java/com/descope/sdk/auth/AuthenticationService.java @@ -4,6 +4,7 @@ import com.descope.model.auth.AccessKeyLoginOptions; import com.descope.model.auth.AuthenticationInfo; import com.descope.model.jwt.Token; +import com.descope.model.jwt.response.JWTResponse; import com.descope.model.user.response.UserHistoryResponse; import com.descope.model.user.response.UserResponse; import java.util.List; @@ -258,6 +259,17 @@ boolean validatePermissions(Token token, String tenant, List permissions */ void logoutAll(String refreshToken) throws DescopeException; + /** + * Used to log out of all device sessions, optionally limited to the given logout types. + * + * @param refreshToken - token + * @param logoutType - optional logout types; each must be non-empty + * @return {@link JWTResponse JWTResponse} the server's response, which carries the cookie + * settings to clear + * @throws DescopeException if there is an error + */ + JWTResponse logoutAll(String refreshToken, List logoutType) throws DescopeException; + /** * Use to retrieve current session user details. The request requires a valid refresh token. * diff --git a/src/main/java/com/descope/sdk/auth/impl/AuthenticationServiceImpl.java b/src/main/java/com/descope/sdk/auth/impl/AuthenticationServiceImpl.java index 6774c9f7..48358de3 100644 --- a/src/main/java/com/descope/sdk/auth/impl/AuthenticationServiceImpl.java +++ b/src/main/java/com/descope/sdk/auth/impl/AuthenticationServiceImpl.java @@ -15,6 +15,7 @@ import com.descope.model.auth.AccessKeyLoginOptions; import com.descope.model.auth.AuthenticationInfo; import com.descope.model.auth.ExchangeTokenRequest; +import com.descope.model.auth.LogoutRequest; import com.descope.model.client.Client; import com.descope.model.jwt.Token; import com.descope.model.jwt.response.JWTResponse; @@ -227,6 +228,16 @@ public void logoutAll(String refreshToken) throws DescopeException { apiProxy.post(logOutAllURL, null, JWTResponse.class); } + @Override + public JWTResponse logoutAll(String refreshToken, List logoutType) throws DescopeException { + if (StringUtils.isBlank(refreshToken)) { + throw ServerCommonException.missingArguments("refresh token"); + } + ApiProxy apiProxy = getApiProxy(refreshToken); + LogoutRequest request = new LogoutRequest(logoutType); + return apiProxy.post(composeLogOutAllLinkURL(), request, JWTResponse.class); + } + @Override public UserResponse me(String refreshToken) throws DescopeException { if (StringUtils.isBlank(refreshToken)) { diff --git a/src/test/java/com/descope/sdk/auth/impl/AuthenticationServiceImplTest.java b/src/test/java/com/descope/sdk/auth/impl/AuthenticationServiceImplTest.java index a930ff74..afafcb96 100644 --- a/src/test/java/com/descope/sdk/auth/impl/AuthenticationServiceImplTest.java +++ b/src/test/java/com/descope/sdk/auth/impl/AuthenticationServiceImplTest.java @@ -6,15 +6,24 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertThrows; import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.doAnswer; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.mockStatic; +import static org.mockito.Mockito.when; import com.descope.enums.DeliveryMethod; import com.descope.exception.RateLimitExceededException; +import com.descope.exception.ServerCommonException; import com.descope.model.auth.AccessKeyLoginOptions; import com.descope.model.auth.AuthenticationInfo; import com.descope.model.auth.AuthenticationServices; import com.descope.model.client.Client; import com.descope.model.jwt.Token; +import com.descope.model.jwt.response.JWTResponse; import com.descope.model.mgmt.AccessKeyResponse; import com.descope.model.mgmt.ManagementServices; import com.descope.model.user.request.UserRequest; @@ -28,11 +37,24 @@ import com.descope.sdk.mgmt.TenantService; import com.descope.sdk.mgmt.UserService; import com.descope.sdk.mgmt.impl.ManagementServiceBuilder; +import com.fasterxml.jackson.databind.ObjectMapper; +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.nio.charset.StandardCharsets; import java.util.Arrays; import java.util.Map; +import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; +import org.apache.hc.client5.http.impl.classic.HttpClients; +import org.apache.hc.core5.http.ClassicHttpRequest; +import org.apache.hc.core5.http.ClassicHttpResponse; +import org.apache.hc.core5.http.HttpEntity; +import org.apache.hc.core5.http.io.HttpClientResponseHandler; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.junitpioneer.jupiter.RetryingTest; +import org.mockito.ArgumentCaptor; +import org.mockito.MockedStatic; public class AuthenticationServiceImplTest { @@ -205,4 +227,93 @@ void testFunctionalSelectTenant() { roleService.delete(roleBName); } + + @Test + void testLogoutAllWithLogoutTypeForEmptyRefreshToken() { + ServerCommonException thrown = assertThrows(ServerCommonException.class, + () -> authenticationService.logoutAll("", Arrays.asList("web"))); + assertNotNull(thrown); + assertEquals("refresh token", thrown.getMessage()); + } + + @Test + void testLogoutAllWithLogoutTypeForSuccess() throws Exception { + ArgumentCaptor captor = ArgumentCaptor.forClass(ClassicHttpRequest.class); + CloseableHttpClient httpClient = mockHttpClient(captor, 200, + "{\"sessionJwt\":\"s\",\"refreshJwt\":\"r\",\"cookieDomain\":\"example.com\",\"cookiePath\":\"/\"," + + "\"cookieMaxAge\":1,\"cookieExpiration\":2,\"user\":{\"userId\":\"u1\"},\"firstSeen\":true," + + "\"idpResponse\":{\"idpGroups\":[\"g\"]},\"sessionExpiration\":3,\"externalToken\":\"e\"," + + "\"claims\":{\"c\":\"v\"},\"tenantSSOID\":\"t1\",\"trustedDeviceJwt\":\"td\"," + + "\"nextRefreshSeconds\":4,\"cookieName\":\"DSR\",\"sessionCookieName\":\"DS\"," + + "\"sessionCookieDomain\":\"s.example.com\",\"unsavedSSO\":true,\"knownDeviceJwt\":\"kd\"," + + "\"ssoAuthenticationOnly\":true,\"userCreationDeferred\":true,\"unknownField\":1}"); + try (MockedStatic mockedHttpClients = mockStatic(HttpClients.class)) { + mockedHttpClients.when(HttpClients::createDefault).thenReturn(httpClient); + JWTResponse response = authenticationService.logoutAll("someRefreshToken", Arrays.asList("web", "mobile")); + ClassicHttpRequest request = captor.getValue(); + assertEquals("POST", request.getMethod()); + assertTrue(request.getRequestUri().endsWith("/v1/auth/logoutall")); + assertEquals("Bearer " + TestUtils.PROJECT_ID + ":someRefreshToken", + request.getHeader("Authorization").getValue()); + Map body = requestBody(request); + assertEquals(1, body.size()); + assertEquals(Arrays.asList("web", "mobile"), body.get("logoutType")); + assertEquals("s", response.getSessionJwt()); + assertEquals("r", response.getRefreshJwt()); + assertEquals("example.com", response.getCookieDomain()); + assertEquals("/", response.getCookiePath()); + assertEquals(1, response.getCookieMaxAge()); + assertEquals(2, response.getCookieExpiration()); + assertEquals("u1", response.getUser().getUserId()); + assertTrue(response.getFirstSeen()); + assertEquals(Arrays.asList("g"), response.getIdpResponse().getIdpGroups()); + assertEquals(3, response.getSessionExpiration()); + assertEquals("e", response.getExternalToken()); + assertEquals("v", response.getClaims().get("c")); + assertEquals("t1", response.getTenantSSOID()); + assertEquals("td", response.getTrustedDeviceJwt()); + assertEquals(4, response.getNextRefreshSeconds()); + assertEquals("DSR", response.getCookieName()); + assertEquals("DS", response.getSessionCookieName()); + assertEquals("s.example.com", response.getSessionCookieDomain()); + assertTrue(response.getUnsavedSSO()); + assertEquals("kd", response.getKnownDeviceJwt()); + assertTrue(response.getSsoAuthenticationOnly()); + assertTrue(response.getUserCreationDeferred()); + } + } + + @Test + void testLogoutAllWithoutLogoutType() throws Exception { + ArgumentCaptor captor = ArgumentCaptor.forClass(ClassicHttpRequest.class); + CloseableHttpClient httpClient = mockHttpClient(captor, 200, "{\"cookieName\":null,\"user\":null}"); + try (MockedStatic mockedHttpClients = mockStatic(HttpClients.class)) { + mockedHttpClients.when(HttpClients::createDefault).thenReturn(httpClient); + JWTResponse response = authenticationService.logoutAll("someRefreshToken", null); + assertTrue(requestBody(captor.getValue()).isEmpty()); + assertNotNull(response); + assertNull(response.getUser()); + } + } + + private CloseableHttpClient mockHttpClient(ArgumentCaptor captor, int statusCode, + String responseBody) throws IOException { + CloseableHttpClient httpClient = mock(CloseableHttpClient.class); + doAnswer(inv -> { + ClassicHttpResponse response = mock(ClassicHttpResponse.class); + when(response.getCode()).thenReturn(statusCode); + HttpEntity entity = mock(HttpEntity.class); + when(entity.getContent()) + .thenReturn(new ByteArrayInputStream(responseBody.getBytes(StandardCharsets.UTF_8))); + when(response.getEntity()).thenReturn(entity); + return ((HttpClientResponseHandler) inv.getArgument(1)).handleResponse(response); + }).when(httpClient).execute(captor.capture(), any(HttpClientResponseHandler.class)); + return httpClient; + } + + private Map requestBody(ClassicHttpRequest request) throws IOException { + ByteArrayOutputStream bs = new ByteArrayOutputStream(); + request.getEntity().writeTo(bs); + return new ObjectMapper().readValue(bs.toByteArray(), Map.class); + } } From bc042b858e3d1800cee9a2baadd4b8f05759983f Mon Sep 17 00:00:00 2001 From: Yosi Haran Date: Thu, 19 Nov 2026 23:09:49 +0200 Subject: [PATCH 2/2] fix: address review comments --- .../descope/sdk/auth/impl/AuthenticationServiceImplTest.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/test/java/com/descope/sdk/auth/impl/AuthenticationServiceImplTest.java b/src/test/java/com/descope/sdk/auth/impl/AuthenticationServiceImplTest.java index afafcb96..f489370d 100644 --- a/src/test/java/com/descope/sdk/auth/impl/AuthenticationServiceImplTest.java +++ b/src/test/java/com/descope/sdk/auth/impl/AuthenticationServiceImplTest.java @@ -249,7 +249,8 @@ void testLogoutAllWithLogoutTypeForSuccess() throws Exception { + "\"ssoAuthenticationOnly\":true,\"userCreationDeferred\":true,\"unknownField\":1}"); try (MockedStatic mockedHttpClients = mockStatic(HttpClients.class)) { mockedHttpClients.when(HttpClients::createDefault).thenReturn(httpClient); - JWTResponse response = authenticationService.logoutAll("someRefreshToken", Arrays.asList("web", "mobile")); + final JWTResponse response = + authenticationService.logoutAll("someRefreshToken", Arrays.asList("web", "mobile")); ClassicHttpRequest request = captor.getValue(); assertEquals("POST", request.getMethod()); assertTrue(request.getRequestUri().endsWith("/v1/auth/logoutall"));