Add optional returnTo parameter to getLogoutUrl (#264)

workos · Jan 15, 2025 · f4c389e · f4c389e
1 parent cffbbd7
commit f4c389e
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/src/main/kotlin/com/workos/usermanagement/UserManagementApi.kt b/src/main/kotlin/com/workos/usermanagement/UserManagementApi.kt
@@ -466,10 +466,13 @@ class UserManagementApi(private val workos: WorkOS) {
   }
 
   /** End a user's session. The user's browser should be redirected to this URL. */
-  fun getLogoutUrl(sessionId: String): String {
+  fun getLogoutUrl(sessionId: String, returnTo: String? = null): String {
     return URIBuilder(workos.baseUrl)
       .setPath("/user_management/sessions/logout")
-      .addParameter("session_id", sessionId)
+      .apply {
+        addParameter("session_id", sessionId)
+        returnTo?.let { addParameter("return_to", it) }
+      }
       .toString()
   }
 }
diff --git a/src/test/kotlin/com/workos/test/user_management/UserManagementApiTest.kt b/src/test/kotlin/com/workos/test/user_management/UserManagementApiTest.kt
@@ -1622,4 +1622,14 @@ class UserManagementApiTest : TestBase() {
       url
     )
   }
+
+  @Test
+  fun getLogoutUrlWithReturnToShouldReturnValidUrlResponse() {
+    val url = workos.userManagement.getLogoutUrl("session_123", returnTo = "https://your-app.com")
+
+    assertEquals(
+      "http://localhost:${getWireMockPort()}/user_management/sessions/logout?session_id=session_123&return_to=https%3A%2F%2Fyour-app.com",
+      url
+    )
+  }
 }