Skip to content

The open alternative to Salesforce, designed for AI.

Prevent reactivating revoked API keys (#25918)

Weiko6dee33bacee4
diff --git a/packages/twenty-server/src/engine/core-modules/api-key/api-key.resolver.ts b/packages/twenty-server/src/engine/core-modules/api-key/api-key.resolver.ts
index 3ddf9ee1b7e..b203c32867c 100644
--- a/packages/twenty-server/src/engine/core-modules/api-key/api-key.resolver.ts
+++ b/packages/twenty-server/src/engine/core-modules/api-key/api-key.resolver.ts
@@ -105,7 +105,16 @@ export class ApiKeyResolver {
updateData.revokedAt = input.revokedAt ? new Date(input.revokedAt) : null;
}
- return this.apiKeyService.update(input.id, workspace.id, updateData);
+ try {
+ return await this.apiKeyService.update(
+ input.id,
+ workspace.id,
+ updateData,
+ );
+ } catch (error) {
+ apiKeyGraphqlApiExceptionHandler(error);
+ throw error;
+ }
}
@UseGuards(RequireAccessTokenGuard)
diff --git a/packages/twenty-server/src/engine/core-modules/api-key/controllers/api-key.controller.ts b/packages/twenty-server/src/engine/core-modules/api-key/controllers/api-key.controller.ts
index 3d10f225224..68f8dad1930 100644
--- a/packages/twenty-server/src/engine/core-modules/api-key/controllers/api-key.controller.ts
+++ b/packages/twenty-server/src/engine/core-modules/api-key/controllers/api-key.controller.ts
@@ -105,7 +105,7 @@ export class ApiKeyController {
if (updateApiKeyDto.revokedAt !== undefined) {
updateData.revokedAt = updateApiKeyDto.revokedAt
? new Date(updateApiKeyDto.revokedAt)
- : undefined;
+ : null;
}
return this.apiKeyService.update(id, workspace.id, updateData);
diff --git a/packages/twenty-server/src/engine/core-modules/api-key/services/api-key.service.ts b/packages/twenty-server/src/engine/core-modules/api-key/services/api-key.service.ts
index 493b4744426..13a3fab1348 100644
--- a/packages/twenty-server/src/engine/core-modules/api-key/services/api-key.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/api-key/services/api-key.service.ts
@@ -1,6 +1,7 @@
import { Injectable } from '@nestjs/common';
import { msg } from '@lingui/core/macro';
+import { isNull } from '@sniptt/guards';
import { IsNull } from 'typeorm';
import { type QueryDeepPartialEntity } from 'typeorm/query-builder/QueryPartialEntity';
@@ -91,7 +92,24 @@ export class ApiKeyService {
return null;
}
- await this.apiKeyRepository.update(workspaceId, { id }, updateData);
+ const { revokedAt, ...updateDataWithoutRevokedAt } = updateData;
+ const isClearingRevokedAt = isNull(revokedAt);
+
+ if (isClearingRevokedAt && this.isRevoked(apiKey)) {
+ throw new ApiKeyException(
+ `API Key with id ${id} is revoked and cannot be reactivated`,
+ ApiKeyExceptionCode.API_KEY_REVOKED,
+ {
+ userFriendlyMessage: msg`This API key has been revoked and cannot be reactivated. Please create a new API key.`,
+ },
+ );
+ }
+
+ await this.apiKeyRepository.update(
+ workspaceId,
+ { id },
+ isClearingRevokedAt ? updateDataWithoutRevokedAt : updateData,
+ );
await this.invalidateApiKeyCache(workspaceId);
return this.findById(id, workspaceId);
diff --git a/packages/twenty-server/test/integration/metadata/suites/developers/api-keys.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/developers/api-keys.integration-spec.ts
index 316f05decdf..0885b042765 100644
--- a/packages/twenty-server/test/integration/metadata/suites/developers/api-keys.integration-spec.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/developers/api-keys.integration-spec.ts
@@ -1,10 +1,68 @@
import { gql } from 'graphql-tag';
import { makeMetadataAPIRequest } from 'test/integration/metadata/suites/utils/make-metadata-api-request.util';
+import { makeRestAPIRequest } from 'test/integration/rest/utils/make-rest-api-request.util';
describe('apiKeysResolver (e2e)', () => {
let createdApiKeyId: string | undefined;
let adminRoleId: string;
+ const createRevokedApiKey = async (name: string): Promise<string> => {
+ const createResponse = await makeMetadataAPIRequest({
+ query: gql`
+ mutation CreateApiKey($input: CreateApiKeyInput!) {
+ createApiKey(input: $input) {
+ id
+ }
+ }
+ `,
+ variables: {
+ input: {
+ name,
+ expiresAt: '2025-12-31T23:59:59Z',
+ roleId: adminRoleId,
+ },
+ },
+ });
+
+ const apiKeyId = createResponse.body.data.createApiKey.id;
+
+ createdApiKeyId = apiKeyId;
+
+ await makeMetadataAPIRequest({
+ query: gql`
+ mutation RevokeApiKey($input: RevokeApiKeyInput!) {
+ revokeApiKey(input: $input) {
+ id
+ }
+ }
+ `,
+ variables: {
+ input: { id: apiKeyId },
+ },
+ });
+
+ return apiKeyId;
+ };
+
+ const findApiKeyRevokedAt = async (
+ apiKeyId: string,
+ ): Promise<string | null> => {
+ const apiKeyResponse = await makeMetadataAPIRequest({
+ query: gql`
+ query GetApiKey($input: GetApiKeyInput!) {
+ apiKey(input: $input) {
+ revokedAt
+ }
+ }
+ `,
+ variables: {
+ input: { id: apiKeyId },
+ },
+ });
+
+ return apiKeyResponse.body.data.apiKey.revokedAt;
+ };
+
beforeAll(async () => {
const rolesResponse = await makeMetadataAPIRequest({
query: gql`
@@ -211,6 +269,78 @@ describe('apiKeysResolver (e2e)', () => {
expect(updatedApiKey.role).toBeDefined();
expect(updatedApiKey.role.id).toBe(adminRoleId);
});
+
+ it('should not reactivate a revoked API key', async () => {
+ const apiKeyId = await createRevokedApiKey('Test API Key to Reactivate');
+
+ const updateResponse = await makeMetadataAPIRequest({
+ query: gql`
+ mutation UpdateApiKey($input: UpdateApiKeyInput!) {
+ updateApiKey(input: $input) {
+ id
+ revokedAt
+ }
+ }
+ `,
+ variables: {
+ input: { id: apiKeyId, revokedAt: null },
+ },
+ });
+
+ expect(updateResponse.status).toBe(200);
+ expect(updateResponse.body.data.updateApiKey).toBeNull();
+ expect(updateResponse.body.errors).toHaveLength(1);
+ expect(updateResponse.body.errors[0].extensions.code).toBe('FORBIDDEN');
+ expect(updateResponse.body.errors[0].extensions.userFriendlyMessage).toBe(
+ 'This API key has been revoked and cannot be reactivated. Please create a new API key.',
+ );
+ expect(await findApiKeyRevokedAt(apiKeyId)).not.toBeNull();
+ });
+
+ it('should rename a revoked API key without reactivating it', async () => {
+ const apiKeyId = await createRevokedApiKey('Test API Key to Rename');
+
+ const updateResponse = await makeMetadataAPIRequest({
+ query: gql`
+ mutation UpdateApiKey($input: UpdateApiKeyInput!) {
+ updateApiKey(input: $input) {
+ id
+ name
+ revokedAt
+ }
+ }
+ `,
+ variables: {
+ input: { id: apiKeyId, name: 'Renamed Revoked API Key' },
+ },
+ });
+
+ expect(updateResponse.status).toBe(200);
+ expect(updateResponse.body.errors).toBeUndefined();
+ expect(updateResponse.body.data.updateApiKey.name).toBe(
+ 'Renamed Revoked API Key',
+ );
+ expect(updateResponse.body.data.updateApiKey.revokedAt).not.toBeNull();
+ });
+ });
+
+ describe('PATCH /rest/metadata/apiKeys/:id', () => {
+ it('should not reactivate a revoked API key', async () => {
+ const apiKeyId = await createRevokedApiKey(
+ 'Test API Key to Reactivate via REST',
+ );
+
+ const response = await makeRestAPIRequest({
+ method: 'patch',
+ path: `/metadata/apiKeys/${apiKeyId}`,
+ bearer: APPLE_JANE_ADMIN_ACCESS_TOKEN,
+ body: { revokedAt: null },
+ });
+
+ expect(response.status).toBe(400);
+ expect(response.body.code).toBe('API_KEY_REVOKED');
+ expect(await findApiKeyRevokedAt(apiKeyId)).not.toBeNull();
+ });
});
describe('apiKey query', () => {