Skip to content

fix(api keys): Query API Keys correctly returns valid API key name if not present #234083

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SiddharthMantri merged 4 commits into from
Sep 9, 2025
Merged

fix(api keys): Query API Keys correctly returns valid API key name if not present #234083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a97ff24
fix(api keys): Query API Keys correctly returns valid API key name
SiddharthMantri Sep 4, 2025
c0acbe3
use API key id
SiddharthMantri Sep 5, 2025
3133fea
Merge branch 'main' into api-keys-query-fix-null-name
elasticmachine Sep 5, 2025
22020a4
Merge branch 'main' into api-keys-query-fix-null-name
elasticmachine Sep 9, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions x-pack/platform/plugins/shared/security/server/routes/api_keys/query.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,4 +227,42 @@ describe('Query API Keys route', () => {
);
});
});

describe('validate API Key names', () => {
it('should substitute an empty string for keys with `null` names', async () => {
esClientMock.asCurrentUser.security.queryApiKeys.mockRestore();
esClientMock.asCurrentUser.security.queryApiKeys.mockResponse({
api_keys: [
{ id: 'with_name', name: 'foo', invalidated: false },
{ id: 'undefined_name', invalidated: false },
{ id: 'null_name', name: null, invalidated: false },
],
} as any);

const response = await routeHandler(
mockContext,
httpServerMock.createKibanaRequest(),
kibanaResponseFactory
);

expect(response.status).toBe(200);
expect(response.payload.apiKeys).toEqual([
{
id: 'with_name',
name: 'foo',
invalidated: false,
},
{
id: 'undefined_name',
name: 'undefined_name',
invalidated: false,
},
{
id: 'null_name',
name: 'null_name',
invalidated: false,
},
]);
});
});
});
13 changes: 12 additions & 1 deletion x-pack/platform/plugins/shared/security/server/routes/api_keys/query.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
* 2.0.
*/

import type { SecurityApiKey } from '@elastic/elasticsearch/lib/api/types';

import { schema } from '@kbn/config-schema';
import type { QueryApiKeyResult } from '@kbn/security-plugin-types-common';

Expand All @@ -16,6 +18,15 @@ interface QueryClause {
[key: string]: any;
}

const transformAPIKeyNames = (keys: SecurityApiKey[]) => {
return keys.map((key) => {
if (!key.name) {
key.name = key.id;
}
return key;
});
};

export function defineQueryApiKeysAndAggregationsRoute({
router,
getAuthenticationService,
Expand Down Expand Up @@ -165,7 +176,7 @@ export function defineQueryApiKeysAndAggregationsRoute({

queryResult = {
// @ts-expect-error Elasticsearch client types do not know about Cross-Cluster API keys yet.
apiKeys: queryResponse.api_keys,
apiKeys: transformAPIKeyNames(queryResponse.api_keys),
total: queryResponse.total,
count: queryResponse.api_keys.length,
};
Expand Down