[9.2] [Security Solution] Allow generated API services to be re-scoped to other users (#241909) #243107
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ther users (elastic#241909) ## Summary We provide FTR services for our APIs, generated from our OpenAPI schemae. However, the existing services are hardcoded to the default `supertest` instance returned by `getService('supertest')`, which means we cannot change the authentication of those APIs with what is currently exposed. This PR modifies the template defining those services slightly, to both a) preserve existing APIs, and b) add a new method that will return another instance of the API methods, allowing the following: ```ts const detectionsApi = getService('detectionsApi'); const restrictedUser = { username: 'username', password: 'restricted' }; const restrictedApis = detectionsApi.withUser(restrictedUser); // ... // in test for standard user: const apiResponse = detectionsApi.performRulesBulkAction(...); // in test for restricted user: const apiResponse = restrictedApis.performRulesBulkAction(...); // or, if you want to chain it: const apiResponse = detectionsApi.withUser(restrictedUser).performRulesBulkAction(...); ``` ## How to Review Since this is an extension of existing test tooling, the fact of this PR being green on CI is validation that we're not breaking these tools with this PR. Evidence of the new functionality can be seen [on this branch](https://github.com/rylnd/kibana/pull/11/files#diff-8a7e0219eb7a142d9c996a45d4d062d8e7d5054f7037a99b0974a79e9698d474R57-R58), where we are rescoping the API clients to act as one of two different users. The changes themselves (to `src/platform/packages/shared/kbn-openapi-generator/src/template_service/templates/api_client_supertest.handlebars`; the rest of the changes are downstream codegen change) are relatively straightforward, just a few lines of code. ### TODO - [ ] update all relevant generated code (I've only run `yarn openapi:generate` within `security_solution`) - [x] better interface: allow passing of a `User` instead of a supertest instance ### Checklist Check the PR satisfies following conditions. - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) - [ ] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. --------- Co-authored-by: kibanamachine <[email protected]> (cherry picked from commit a713526) # Conflicts: # x-pack/solutions/security/packages/test-api-clients/supertest/endpoint_management.gen.ts # x-pack/solutions/security/packages/test-api-clients/supertest/entity_analytics.gen.ts
7 tasks
maximpn
approved these changes
Nov 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backport
This will backport the following commits from
mainto9.2:Questions ?
Please refer to the Backport tool documentation