@aws-amplify/auth/src/providers/cognito/apis/deleteUser.ts

Auth category of aws-amplify

// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

import { AmplifyContext } from '@aws-amplify/core';
import {
	AuthAction,
	assertTokenProviderConfig,
	resolveCtxArgs,
} from '@aws-amplify/core/internals/utils';

import { getRegionFromUserPoolId } from '../../../foundation/parsers';
import { assertAuthTokens } from '../utils/types';
import { DeleteUserException } from '../types/errors';
import { resolveTokenOrchestrator } from '../tokenProvider';
import { getAuthUserAgentValue } from '../../../utils';
import { createDeleteUserClient } from '../../../foundation/factories/serviceClients/cognitoIdentityProvider';
import { createCognitoUserPoolEndpointResolver } from '../factories';

import { signOut } from './signOut';

export async function deleteUser(ctx: AmplifyContext): Promise<void>;

/**
 * Deletes a user from the user pool while authenticated.
 *
 * @throws - {@link DeleteUserException}
 * @throws AuthTokenConfigException - Thrown when the token provider config is invalid.
 */
export async function deleteUser(): Promise<void>;
export async function deleteUser(...args: any[]): Promise<void> {
	const [ctx] = resolveCtxArgs<[]>(args);
	const authConfig = ctx.resourcesConfig.Auth?.Cognito;
	assertTokenProviderConfig(authConfig);
	const { userPoolEndpoint, userPoolId } = authConfig;
	const { tokens } = await ctx.fetchAuthSession();
	assertAuthTokens(tokens);
	const serviceDeleteUser = createDeleteUserClient({
		endpointResolver: createCognitoUserPoolEndpointResolver({
			endpointOverride: userPoolEndpoint,
		}),
	});
	await serviceDeleteUser(
		{
			region: getRegionFromUserPoolId(userPoolId),
			userAgentValue: getAuthUserAgentValue(AuthAction.DeleteUser),
		},
		{
			AccessToken: tokens.accessToken.toString(),
		},
	);
	await resolveTokenOrchestrator(ctx).clearDeviceMetadata();
	await signOut(ctx);
}