Add active_only flag to Get API Key REST spec (#103621) (#103644)

#98259 added a new flag for the Get API key API. I missed adding it to the REST API spec originally. This PR corrects the REST spec. Co-authored-by: Elastic Machine <[email protected]>
elastic · Dec 21, 2023 · 4b41e8e · 4b41e8e
1 parent f737e81
commit 4b41e8e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/security.get_api_key.json b/rest-api-spec/src/main/resources/rest-api-spec/api/security.get_api_key.json
@@ -45,6 +45,11 @@
         "type":"boolean",
         "default":false,
         "description": "flag to show the limited-by role descriptors of API Keys"
+      },
+      "active_only":{
+        "type":"boolean",
+        "default":false,
+        "description": "flag to limit response to only active (not invalidated or expired) API keys"
       }
     }
   }

diff --git a/x-pack/plugin/src/yamlRestTest/resources/rest-api-spec/test/api_key/10_basic.yml b/x-pack/plugin/src/yamlRestTest/resources/rest-api-spec/test/api_key/10_basic.yml
@@ -191,6 +191,7 @@ teardown:
         Authorization: "Basic YXBpX2tleV91c2VyOngtcGFjay10ZXN0LXBhc3N3b3Jk" # api_key_user
       security.get_api_key:
         owner: true
+        active_only: true
   - length: { "api_keys" : 1 }
   - match: { "api_keys.0.username": "api_key_user" }
   - match: { "api_keys.0.invalidated": false }