feat: add admin.users.getExpiration method (#1543)

srtaalej · web-flow · commit f48758d8e720 · 2025-12-18T16:26:58.000-05:00
diff --git a/json-logs/samples/api/admin.users.getExpiration.json b/json-logs/samples/api/admin.users.getExpiration.json
@@ -0,0 +1,14 @@
+{
+  "ok": true,
+  "error": "",
+  "needed": "",
+  "provided": "",
+  "user": {
+    "id": "W00000000",
+    "email": "",
+    "is_restricted": false,
+    "is_ultra_restricted": true,
+    "expiration_ts": 12345
+  }
+}
+
diff --git a/metadata/web-api/rate_limit_tiers.json b/metadata/web-api/rate_limit_tiers.json
@@ -77,6 +77,7 @@
   "admin.usergroups.listChannels": "Tier2",
   "admin.usergroups.removeChannels": "Tier2",
   "admin.users.assign": "Tier2",
+  "admin.users.getExpiration": "Tier4",
   "admin.users.invite": "Tier2",
   "admin.users.list": "Tier3",
   "admin.users.remove": "Tier2",
diff --git a/slack-api-client/src/main/java/com/slack/api/methods/AsyncMethodsClient.java b/slack-api-client/src/main/java/com/slack/api/methods/AsyncMethodsClient.java
@@ -696,6 +696,10 @@ CompletableFuture<AdminConversationsWhitelistListGroupsLinkedToChannelResponse>
 
     CompletableFuture<AdminUsersAssignResponse> adminUsersAssign(RequestConfigurator<AdminUsersAssignRequest.AdminUsersAssignRequestBuilder> req);
 
+    CompletableFuture<AdminUsersGetExpirationResponse> adminUsersGetExpiration(AdminUsersGetExpirationRequest req);
+
+    CompletableFuture<AdminUsersGetExpirationResponse> adminUsersGetExpiration(RequestConfigurator<AdminUsersGetExpirationRequest.AdminUsersGetExpirationRequestBuilder> req);
+
     CompletableFuture<AdminUsersInviteResponse> adminUsersInvite(AdminUsersInviteRequest req);
 
     CompletableFuture<AdminUsersInviteResponse> adminUsersInvite(RequestConfigurator<AdminUsersInviteRequest.AdminUsersInviteRequestBuilder> req);
diff --git a/slack-api-client/src/main/java/com/slack/api/methods/Methods.java b/slack-api-client/src/main/java/com/slack/api/methods/Methods.java
@@ -182,6 +182,7 @@ private Methods() {
     // ------------------------------
 
     public static final String ADMIN_USERS_ASSIGN = "admin.users.assign";
+    public static final String ADMIN_USERS_GET_EXPIRATION= "admin.users.getExpiration";
     public static final String ADMIN_USERS_INVITE = "admin.users.invite";
     public static final String ADMIN_USERS_LIST = "admin.users.list";
     public static final String ADMIN_USERS_REMOVE = "admin.users.remove";
diff --git a/slack-api-client/src/main/java/com/slack/api/methods/MethodsClient.java b/slack-api-client/src/main/java/com/slack/api/methods/MethodsClient.java
@@ -977,6 +977,12 @@ AdminUsersAssignResponse adminUsersAssign(
             RequestConfigurator<AdminUsersAssignRequest.AdminUsersAssignRequestBuilder> req)
             throws IOException, SlackApiException;
 
+    AdminUsersGetExpirationResponse adminUsersGetExpiration(AdminUsersGetExpirationRequest req) throws IOException, SlackApiException;
+
+    AdminUsersGetExpirationResponse adminUsersGetExpiration(
+            RequestConfigurator<AdminUsersGetExpirationRequest.AdminUsersGetExpirationRequestBuilder> req)
+            throws IOException, SlackApiException;
+
     AdminUsersInviteResponse adminUsersInvite(AdminUsersInviteRequest req) throws IOException, SlackApiException;
 
     AdminUsersInviteResponse adminUsersInvite(
diff --git a/slack-api-client/src/main/java/com/slack/api/methods/MethodsRateLimits.java b/slack-api-client/src/main/java/com/slack/api/methods/MethodsRateLimits.java
@@ -184,6 +184,7 @@ public static void setRateLimitTier(String methodName, MethodsRateLimitTier tier
 
         // Tier4
         final List<String> adminApiMethods_Tier4 = Arrays.asList(
+                ADMIN_USERS_GET_EXPIRATION,
                 ADMIN_USERS_SESSION_GET_SETTINGS,
                 ADMIN_USERS_SESSION_SET_SETTINGS,
                 ADMIN_USERS_SESSION_CLEAR_SETTINGS,
diff --git a/slack-api-client/src/main/java/com/slack/api/methods/RequestFormBuilder.java b/slack-api-client/src/main/java/com/slack/api/methods/RequestFormBuilder.java
@@ -913,6 +913,13 @@ public static FormBody.Builder toForm(AdminUsersAssignRequest req) {
         return form;
     }
 
+    public static FormBody.Builder toForm(AdminUsersGetExpirationRequest req) {
+        FormBody.Builder form = new FormBody.Builder();
+        setIfNotNull("user_id", req.getUserId(), form);
+        setIfNotNull("target_team", req.getTargetTeam(), form);
+        return form;
+    }
+
     public static FormBody.Builder toForm(AdminUsersInviteRequest req) {
         FormBody.Builder form = new FormBody.Builder();
         setIfNotNull("channel_ids", req.getChannelIds().stream().collect(joining(",")), form);
diff --git a/slack-api-client/src/main/java/com/slack/api/methods/impl/AsyncMethodsClientImpl.java b/slack-api-client/src/main/java/com/slack/api/methods/impl/AsyncMethodsClientImpl.java
@@ -1105,6 +1105,16 @@ public CompletableFuture<AdminUsersAssignResponse> adminUsersAssign(RequestConfi
         return adminUsersAssign(req.configure(AdminUsersAssignRequest.builder()).build());
     }
 
+    @Override
+    public CompletableFuture<AdminUsersGetExpirationResponse> adminUsersGetExpiration(AdminUsersGetExpirationRequest req) {
+        return executor.execute(ADMIN_USERS_GET_EXPIRATION, toMap(req), () -> methods.adminUsersGetExpiration(req));
+    }
+
+    @Override
+    public CompletableFuture<AdminUsersGetExpirationResponse> adminUsersGetExpiration(RequestConfigurator<AdminUsersGetExpirationRequest.AdminUsersGetExpirationRequestBuilder> req) {
+        return adminUsersGetExpiration(req.configure(AdminUsersGetExpirationRequest.builder()).build());
+    }
+
     @Override
     public CompletableFuture<AdminUsersInviteResponse> adminUsersInvite(AdminUsersInviteRequest req) {
         return executor.execute(ADMIN_USERS_INVITE, toMap(req), () -> methods.adminUsersInvite(req));
diff --git a/slack-api-client/src/main/java/com/slack/api/methods/impl/MethodsClientImpl.java b/slack-api-client/src/main/java/com/slack/api/methods/impl/MethodsClientImpl.java
@@ -1146,6 +1146,16 @@ public AdminUsersAssignResponse adminUsersAssign(RequestConfigurator<AdminUsersA
         return adminUsersAssign(req.configure(AdminUsersAssignRequest.builder()).build());
     }
 
+    @Override
+    public AdminUsersGetExpirationResponse adminUsersGetExpiration(RequestConfigurator<AdminUsersGetExpirationRequest.AdminUsersGetExpirationRequestBuilder> req) throws IOException, SlackApiException {
+        return adminUsersGetExpiration(req.configure(AdminUsersGetExpirationRequest.builder()).build());
+    }
+
+    @Override
+    public AdminUsersGetExpirationResponse adminUsersGetExpiration(AdminUsersGetExpirationRequest req) throws IOException, SlackApiException {
+        return postFormWithTokenAndParseResponse(toForm(req), Methods.ADMIN_USERS_GET_EXPIRATION, getToken(req), AdminUsersGetExpirationResponse.class);
+    }
+
     @Override
     public AdminUsersInviteResponse adminUsersInvite(AdminUsersInviteRequest req) throws IOException, SlackApiException {
         return postFormWithTokenAndParseResponse(toForm(req), Methods.ADMIN_USERS_INVITE, getToken(req), AdminUsersInviteResponse.class);
diff --git a/slack-api-client/src/main/java/com/slack/api/methods/request/admin/users/AdminUsersGetExpirationRequest.java b/slack-api-client/src/main/java/com/slack/api/methods/request/admin/users/AdminUsersGetExpirationRequest.java
@@ -0,0 +1,29 @@
+package com.slack.api.methods.request.admin.users;
+
+import com.slack.api.methods.SlackApiRequest;
+import lombok.Builder;
+import lombok.Data;
+
+/**
+ * https://docs.slack.dev/reference/methods/admin.users.getExpiration/
+ */
+@Data
+@Builder
+public class AdminUsersGetExpirationRequest implements SlackApiRequest {
+
+    /**
+     * Authentication token bearing required scopes.
+     */
+    private String token;
+
+    /**
+     * The ID of the user to add to the workspace.
+     */
+    private String userId;
+
+    /**
+     * Workspace Id.
+     */
+    private String targetTeam;
+}
+
diff --git a/slack-api-client/src/main/java/com/slack/api/methods/response/admin/users/AdminUsersGetExpirationResponse.java b/slack-api-client/src/main/java/com/slack/api/methods/response/admin/users/AdminUsersGetExpirationResponse.java
@@ -0,0 +1,24 @@
+package com.slack.api.methods.response.admin.users;
+
+import com.slack.api.methods.SlackApiTextResponse;
+import com.slack.api.model.ErrorResponseMetadata;
+import com.slack.api.model.User;
+import lombok.Data;
+
+import java.util.List;
+import java.util.Map;
+
+@Data
+public class AdminUsersGetExpirationResponse implements SlackApiTextResponse {
+
+    private boolean ok;
+    private String warning;
+    private String error;
+    private String needed;
+    private String provided;
+    private transient Map<String, List<String>> httpResponseHeaders;
+
+    private ErrorResponseMetadata responseMetadata;
+    private User user;
+}
+
diff --git a/slack-api-client/src/test/java/test_locally/api/MethodsTest.java b/slack-api-client/src/test/java/test_locally/api/MethodsTest.java
diff --git a/slack-api-client/src/test/java/test_locally/api/methods_admin_api/AdminApiTest.java b/slack-api-client/src/test/java/test_locally/api/methods_admin_api/AdminApiTest.java
diff --git a/slack-api-client/src/test/java/test_with_remote_apis/methods_admin_api/AdminApi_users_Test.java b/slack-api-client/src/test/java/test_with_remote_apis/methods_admin_api/AdminApi_users_Test.java
