Delete a passkey

Your users might want to delete their passkeys. You can do this using the @passlock/browser and @passlock/server libraries. For deletion, we flip the order of operations, although strictly this is not required. Delete the passkey in your vault, then delete it from the user’s password manager.

Tip

You can also remove an orphaned passkey during an authentication operation. See the full passkey deletion and handling missing passkeys guides for more information.

Backend

Use the @passlock/server library to delete the passkey from your vault.

Default (safe)

import { Passlock } from "@passlock/server";

// get these from your development tenancy settings
const tenancyId = "myTenancyId";
const apiKey = "myApiKey";
const passlock = new Passlock({ tenancyId, apiKey });

const result = await passlock.deletePasskey({ passkeyId });

if (result.success) {
  // remove the mapping between the passkey and your local user account
  await unlinkPasskey(passkeyId);

  console.log("deleted");
} else {
  console.error(result.error.message);
}

Unsafe

import { Passlock } from "@passlock/server/unsafe";

// get these from your development tenancy settings
const tenancyId = "myTenancyId";
const apiKey = "myApiKey";
const passlock = new Passlock({ tenancyId, apiKey });

const result = await passlock.deletePasskey({ passkeyId });

// remove the mapping between the passkey and your local user account
await unlinkPasskey(passkeyId);

console.log("passkey deleted");

Functions (safe)

import { deletePasskey } from "@passlock/server";

const result = await deletePasskey({ passkeyId }, { tenancyId, apiKey });

if (result.success) {
  // remove the mapping between the passkey and your local user account
  await unlinkPasskey(passkeyId);

  console.log("deleted");
} else {
  console.error(result.error.message);
}

Functions (unsafe)

import { deletePasskey } from "@passlock/server/unsafe";

const result = await deletePasskey({ passkeyId }, { tenancyId, apiKey });

// remove the mapping between the passkey and your local user account
await unlinkPasskey(passkeyId);

console.log("passkey deleted");

Choose your code style

Frontend

Use the @passlock/browser library to delete the passkey from the user’s device.

Default (safe)

import { Passlock } from "@passlock/browser";

// get this from your development tenancy settings
const tenancyId = "myTenancyId";
const passlock = new Passlock({ tenancyId });

const result = await passlock.deletePasskey({ passkeyId }, { tenancyId });

if (result.success) {
  console.log("deleted");
} else {
  console.error(result.error.message);
  alert("Please remove your jdoe@example.com passkey");
}

Unsafe

import { Passlock } from "@passlock/browser/unsafe";

// get this from your development tenancy settings
const tenancyId = "myTenancyId";
const passlock = new Passlock({ tenancyId });

await passlock.deletePasskey({ passkeyId }, { tenancyId });

console.log("passkey deleted");

Functions (safe)

import { deletePasskey } from "@passlock/browser";

// get this from your development tenancy settings
const tenancyId = "myTenancyId";

const result = await deletePasskey({ passkeyId }, { tenancyId });

if (result.success) {
  console.log("deleted");
} else {
  console.error(result.error.message);
  alert("Please remove your jdoe@example.com passkey");
}

Functions (unsafe)

import { deletePasskey } from "@passlock/browser/unsafe";

// get this from your development tenancy settings
const tenancyId = "myTenancyId";

await deletePasskey({ passkeyId }, { tenancyId });

console.log("passkey deleted");

Choose your code style