Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity

feat: get api tokens by name (#4507)

Browse Source
This commit is contained in:
Mateusz Kwasniewski 2023-08-16 11:41:20 +02:00 committed by GitHub
parent 5d89a93a55
commit fb4b0f8cf3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 57 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
src/lib/routes/admin-api/api-token.ts
View File

@ -48,6 +48,9 @@ import { OperationDeniedError } from '../../error';
interface TokenParam {
token: string;
}
interface TokenNameParam {
name: string;
}
export const tokenTypeToCreatePermission: (
tokenType: ApiTokenType,
) => string = (tokenType) => {
@ -168,6 +171,26 @@ export class ApiTokenController extends Controller {
],
});
this.route({
method: 'get',
path: '/:name',
handler: this.getApiTokensByName,
permission: [ADMIN, READ_CLIENT_API_TOKEN, READ_FRONTEND_API_TOKEN],
middleware: [
openApiService.validPath({
tags: ['API tokens'],
operationId: 'getApiTokensByName',
summary: 'Get API tokens by name',
description:
'Retrieves all API tokens that match a given token name. Because token names are not unique, this endpoint will always return a list. If no tokens with the provided name exist, the list will be empty. Otherwise, it will contain all the tokens with the given name.',
responses: {
200: createResponseSchema('apiTokensSchema'),
...getStandardResponses(401, 403),
},
}),
],
});
this.route({
method: 'post',
path: '',
@ -259,6 +282,22 @@ export class ApiTokenController extends Controller {
);
}
async getApiTokensByName(
req: IAuthRequest<TokenNameParam>,
res: Response<ApiTokensSchema>,
): Promise<void> {
const { user } = req;
const { name } = req.params;
const tokens = await this.accessibleTokensByName(name, user);
this.openApiService.respondWithValidation(
200,
res,
apiTokensSchema.$id,
{ tokens: serializeDates(tokens) },
);
}
async createApiToken(
req: IAuthRequest,
res: Response<ApiTokenSchema>,
@ -361,6 +400,14 @@ export class ApiTokenController extends Controller {
res.status(200).end();
}
private async accessibleTokensByName(
tokenName: string,
user: User,
): Promise<IApiToken[]> {
const allTokens = await this.accessibleTokens(user);
return allTokens.filter((token) => token.tokenName === tokenName);
}
private async accessibleTokens(user: User): Promise<IApiToken[]> {
const allTokens = await this.apiTokenService.getAllTokens();

12
src/test/e2e/api/admin/api-token.e2e.test.ts
View File

@ -157,8 +157,8 @@ test('creates a lot of client tokens', async () => {
);
}
await Promise.all(requests);
expect.assertions(2);
return app.request
expect.assertions(4);
await app.request
.get('/api/admin/api-tokens')
.expect('Content-Type', /json/)
.expect(200)
@ -166,6 +166,14 @@ test('creates a lot of client tokens', async () => {
expect(res.body.tokens.length).toBe(10);
expect(res.body.tokens[2].type).toBe('client');
});
await app.request
.get('/api/admin/api-tokens/default-client')
.expect('Content-Type', /json/)
.expect(200)
.expect((res) => {
expect(res.body.tokens.length).toBe(10);
expect(res.body.tokens[2].type).toBe('client');
});
});
test('removes api token', async () => {