Scheduling infrastructure for absolutely everyone.
import { SUCCESS_STATUS, X_CAL_SECRET_KEY } from "@calcom/platform-constants";
import { MembershipRole } from "@calcom/platform-libraries";
import type { User } from "@calcom/prisma/client";
import {
Body,
Controller,
Delete,
Get,
HttpCode,
HttpStatus,
Logger,
NotFoundException,
Param,
ParseIntPipe,
Patch,
Post,
Query,
UseGuards,
} from "@nestjs/common";
import { ApiHeader, ApiOperation, ApiTags as DocsTags } from "@nestjs/swagger";
import { API_VERSIONS_VALUES } from "@/lib/api-versions";
import { GetOrgId } from "@/modules/auth/decorators/get-org-id/get-org-id.decorator";
import { MembershipRoles } from "@/modules/auth/decorators/roles/membership-roles.decorator";
import { ApiAuthGuard } from "@/modules/auth/guards/api-auth/api-auth.guard";
import { GetManagedUsersInput } from "@/modules/oauth-clients/controllers/oauth-client-users/inputs/get-managed-users.input";
import { CreateManagedUserOutput } from "@/modules/oauth-clients/controllers/oauth-client-users/outputs/create-managed-user.output";
import { GetManagedUserOutput } from "@/modules/oauth-clients/controllers/oauth-client-users/outputs/get-managed-user.output";
import { GetManagedUsersOutput } from "@/modules/oauth-clients/controllers/oauth-client-users/outputs/get-managed-users.output";
import { TOKENS_DOCS } from "@/modules/oauth-clients/controllers/oauth-flow/oauth-flow.controller";
import { KeysResponseDto } from "@/modules/oauth-clients/controllers/oauth-flow/responses/KeysResponse.dto";
import { OAuthClientGuard } from "@/modules/oauth-clients/guards/oauth-client-guard";
import { OAuthClientRepository } from "@/modules/oauth-clients/oauth-client.repository";
import { OAuthClientUsersService } from "@/modules/oauth-clients/services/oauth-clients-users.service";
import { OAuthClientUsersOutputService } from "@/modules/oauth-clients/services/oauth-clients-users-output.service";
import { TokensRepository } from "@/modules/tokens/tokens.repository";
import { CreateManagedUserInput } from "@/modules/users/inputs/create-managed-user.input";
import { UpdateManagedUserInput } from "@/modules/users/inputs/update-managed-user.input";
import { UsersRepository } from "@/modules/users/users.repository";
@Controller({
path: "/v2/oauth-clients/:clientId/users",
version: API_VERSIONS_VALUES,
})
@UseGuards(ApiAuthGuard, OAuthClientGuard)
@DocsTags("Deprecated: Platform / Managed Users")
@ApiHeader({
name: X_CAL_SECRET_KEY,
description: "OAuth client secret key",
required: true,
})
export class OAuthClientUsersController {
private readonly logger = new Logger("UserController");
constructor(
private readonly userRepository: UsersRepository,
private readonly oAuthClientUsersService: OAuthClientUsersService,
private readonly oauthRepository: OAuthClientRepository,
private readonly tokensRepository: TokensRepository,
private readonly oAuthClientUsersOutputService: OAuthClientUsersOutputService
) {}
@Get("/")
@ApiOperation({
summary: "Get all managed users",
description: `<Warning>These endpoints are deprecated and will be removed in the future.</Warning>`,
})
@MembershipRoles([MembershipRole.ADMIN, MembershipRole.OWNER])
async getManagedUsers(
@Param("clientId") oAuthClientId: string,
@Query() queryParams: GetManagedUsersInput
): Promise<GetManagedUsersOutput> {
this.logger.log(`getting managed users with data for OAuth Client with ID ${oAuthClientId}`);
const managedUsers = await this.oAuthClientUsersService.getManagedUsers(oAuthClientId, queryParams);
return {
status: SUCCESS_STATUS,
data: managedUsers.map((user) => this.oAuthClientUsersOutputService.getResponseUser(user)),
};
}
@Post("/")
@ApiOperation({
summary: "Create a managed user",
description: `<Warning>These endpoints are deprecated and will be removed in the future.</Warning>`,
})
@MembershipRoles([MembershipRole.ADMIN, MembershipRole.OWNER])
async createUser(
@Param("clientId") oAuthClientId: string,
@Body() body: CreateManagedUserInput
): Promise<CreateManagedUserOutput> {
this.logger.log(`Creating user for OAuth Client ${oAuthClientId}`);
const client = await this.oauthRepository.getOAuthClient(oAuthClientId);
if (!client) {
throw new NotFoundException(`OAuth Client with ID ${oAuthClientId} not found`);
}
const { user, tokens } = await this.oAuthClientUsersService.createOAuthClientUser(client, body);
return {
status: SUCCESS_STATUS,
data: {
user: this.oAuthClientUsersOutputService.getResponseUser(user),
accessToken: tokens.accessToken,
accessTokenExpiresAt: tokens.accessTokenExpiresAt.valueOf(),
refreshToken: tokens.refreshToken,
refreshTokenExpiresAt: tokens.refreshTokenExpiresAt.valueOf(),
},
};
}
@Get("/:userId")
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: "Get a managed user",
description: `<Warning>These endpoints are deprecated and will be removed in the future.</Warning>`,
})
@MembershipRoles([MembershipRole.ADMIN, MembershipRole.OWNER])
async getUserById(
@Param("clientId") clientId: string,
@Param("userId", ParseIntPipe) userId: number
): Promise<GetManagedUserOutput> {
const user = await this.validateManagedUserOwnership(clientId, userId);
return {
status: SUCCESS_STATUS,
data: this.oAuthClientUsersOutputService.getResponseUser(user),
};
}
@Patch("/:userId")
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: "Update a managed user",
description: `<Warning>These endpoints are deprecated and will be removed in the future.</Warning>`,
})
@MembershipRoles([MembershipRole.ADMIN, MembershipRole.OWNER])
async updateUser(
@Param("clientId") clientId: string,
@Param("userId", ParseIntPipe) userId: number,
@Body() body: UpdateManagedUserInput,
@GetOrgId() organizationId: number
): Promise<GetManagedUserOutput> {
await this.validateManagedUserOwnership(clientId, userId);
this.logger.log(`Updating user ${userId} for OAuth Client ${clientId}`);
const user = await this.oAuthClientUsersService.updateOAuthClientUser(
clientId,
userId,
body,
organizationId
);
return {
status: SUCCESS_STATUS,
data: this.oAuthClientUsersOutputService.getResponseUser(user),
};
}
@Delete("/:userId")
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: "Delete a managed user",
description: `<Warning>These endpoints are deprecated and will be removed in the future.</Warning>`,
})
@MembershipRoles([MembershipRole.ADMIN, MembershipRole.OWNER])
async deleteUser(
@Param("clientId") clientId: string,
@Param("userId", ParseIntPipe) userId: number
): Promise<GetManagedUserOutput> {
const user = await this.validateManagedUserOwnership(clientId, userId);
await this.userRepository.delete(userId);
this.logger.warn(`Deleting user with ID: ${userId}`);
return {
status: SUCCESS_STATUS,
data: this.oAuthClientUsersOutputService.getResponseUser(user),
};
}
@Post("/:userId/force-refresh")
@HttpCode(HttpStatus.OK)
@ApiOperation({
summary: "Force refresh tokens",
description: `<Warning>These endpoints are deprecated and will be removed in the future.</Warning> If you have lost managed user access or refresh token, then you can get new ones by using OAuth credentials. ${TOKENS_DOCS}`,
})
@MembershipRoles([MembershipRole.ADMIN, MembershipRole.OWNER])
async forceRefresh(
@Param("userId", ParseIntPipe) userId: number,
@Param("clientId") oAuthClientId: string
): Promise<KeysResponseDto> {
this.logger.log(`Forcing new access tokens for managed user with ID ${userId}`);
const { id } = await this.validateManagedUserOwnership(oAuthClientId, userId);
const { accessToken, refreshToken, accessTokenExpiresAt, refreshTokenExpiresAt } =
await this.tokensRepository.forceRefreshOAuthTokens(oAuthClientId, id);
return {
status: SUCCESS_STATUS,
data: {
accessToken,
refreshToken,
accessTokenExpiresAt: accessTokenExpiresAt.valueOf(),
refreshTokenExpiresAt: refreshTokenExpiresAt.valueOf(),
},
};
}
private async validateManagedUserOwnership(clientId: string, userId: number): Promise<User> {
const user = await this.userRepository.findByIdWithinPlatformScope(userId, clientId);
if (!user) {
throw new NotFoundException(`User with ID ${userId} is not part of this OAuth client.`);
}
return user;
}
}