Skip to content

Use Passkey Authentication

Review Checklist

  1. Should this be enabled for Pleasanter.net (dedicated environment)?
  2. Should we purchase a security key for operational verification?

Limitations

  1. Passkey authentication is only available in HTTPS contexts.
  2. If a password manager extension is installed in the browser, it may take priority over Windows Security. To use Windows Security authentication, cancel the extension's process.
  3. If a certain amount of time passes during the authentication process, it will time out and the user will be notified. The same applies if the user cancels the authentication. Please repeat the procedure as necessary.
  4. Passkey authentication is supported on Windows 11 and later, macOS 13.0 (Ventura) and later, iOS 16.0 and later, iPad OS and later, and Android 9.0 and later.
  5. Please keep your web browser updated to the latest version.
  6. Use the standard camera app of each OS to read QR codes.
  7. If you cannot read QR codes with the camera app on Android, please use Google Lens.

Overview

To use passkey authentication, the following configuration is required.

Server-side Configuration

Configure each parameter under PasskeyParameters in "Authentication.json".

{
    ...
    "PasskeyParameters": {
        "Enabled": true,
        "ServerName": "Pleasanter",
        "ServerDomain": "localhost",
        "Origins": [ "https://localhost:44331" ]
    },
    ...
}

PasskeyParameters Parameter List

Parameter Name Example Description
Enabled true Enable or disable passkey authentication. Default value is false.
ServerName "Pleasanter" Specifies the server name.
ServerDomain "localhost" This is an identifier that indicates the name of this service. It is used to link the passkey with the service. Please set only the domain name, such as pleasanter.net.
Origins ["https://localhost:443"] This setting is used to verify that the URL the user accesses in their browser completely matches the registered URL. Login attempts from unregistered URLs will be rejected. Register the entire URL displayed in the browser's address bar. If the port number is different, it will be treated as a separate URL.

Client-side Configuration

On the client side, you need to create and save a passkey. The procedure differs depending on where you save the passkey.

📱 Save to Smartphone

This section explains how to create a passkey and save it to your smartphone. Please turn on Bluetooth in your smartphone's settings app beforehand.

  1. Log in to Pleasanter with the account for which you want to create a passkey. Use an authentication method other than passkey authentication for this login.
  2. Click "User" in the navigation menu.
  3. Click "Edit profile".
  4. Click the "Passkey" button in the command button area.
    The command button area of the profile edit screen with the 'Passkey' button
  5. The "Passkey" dialog will be displayed. Click the "New" button.
    The 'Passkey' dialog with the 'New' button
  6. Change the passkey storage location to your smartphone. Click "Change".
    The screen showing the passkey storage location with a 'Change' option
  7. Click "iPhone, iPad, or Android device".
    The list of passkey storage locations including 'iPhone, iPad, or Android device'
  8. Read the displayed QR code with your smartphone's camera app and tap "Save a passkey".
    The QR code displayed on the PC for saving a passkey The smartphone screen with 'Save a passkey' after scanning the QR code
  9. Add the passkey to your smartphone. Tap the "Add Passkey" button. You will be prompted for smartphone user authentication at this time.
    The smartphone screen showing the 'Add Passkey' button
  10. Once the passkey is saved to your smartphone, the created key will be displayed in the "Passkey" dialog. Click the "Close" button.
    The 'Passkey' dialog showing the newly created passkey
💻 Save to Windows

This section explains how to create a passkey and save it to Windows.

  1. Log in to Pleasanter with the account for which you want to create a passkey. Use an authentication method other than passkey authentication for this login.
  2. Click "User" in the navigation menu.
  3. Click "Edit profile".
  4. Click the "Passkey" button in the command button area.
    The command button area of the profile edit screen with the 'Passkey' button
  5. The "Passkey" dialog will be displayed. Click the "New" button.
    The 'Passkey' dialog with the 'New' button
  6. Click the "Continue" button.
    The screen for saving a passkey to Windows, with the 'Continue' button
  7. Complete identity verification with Windows Hello. Below is an authentication screen using a PIN.
    The Windows Hello identity verification screen using a PIN
  8. Once identity verification is complete, the created key will be displayed in the "Passkey" dialog. Click the "Close" button.
    The 'Passkey' dialog showing the passkey saved to Windows
🔑 Save to Other Storage Locations

In addition to the above, you can use the following as passkey storage locations. Please refer to each product's documentation for details.

  1. Security key
  2. Third-party password managers provided as browser extensions
  3. Password managers built into browsers

If you select "3. Password managers built into browsers" from the above, please cancel passkey storage by Windows Security.

The Windows Security passkey save screen that you cancel

It will fallback and become selectable.

The screen that lets you choose another passkey storage location after cancelling

Login Procedure

For login procedures when "🔑 Save to Other Storage Locations" is selected, please follow the on-screen instructions.

📱 Log in with a Passkey Saved to Smartphone
  1. Open the login screen with the account for which you created the passkey and click the "Log in with passkey" button.
    The Pleasanter login screen with the 'Log in with passkey' button
  2. Select the saved passkey type. Click "iPhone, iPad, or Android device".
    The passkey type list including 'iPhone, iPad, or Android device'
  3. Read the displayed QR code with your smartphone's camera app and tap "Sign in with a passkey".
    The QR code displayed on the PC for logging in with a passkey The smartphone screen with 'Sign in with a passkey' after scanning the QR code
  4. A confirmation message will appear at the bottom of your smartphone screen. Tap the "Use Passkey" button. You will be prompted for smartphone user authentication at this time.
    The confirmation message at the bottom of the smartphone with the 'Use Passkey' button

You can now log in to Pleasanter.

💻 Log in with a Passkey Saved to Windows
  1. Open the login screen with the account for which you created the passkey and click the "Log in with passkey" button.
    The Pleasanter login screen with the 'Log in with passkey' button
  2. Complete identity verification with Windows Hello. Below is an authentication screen using a PIN.
    The Windows Hello identity verification screen using a PIN at login

You can now log in to Pleasanter.

Editing Passkeys

You can change the title (name) of a created passkey or delete unnecessary passkeys from Pleasanter.

Change Passkey Title
  1. Log in to Pleasanter.
  2. Click "User" in the navigation menu.
  3. Click "Edit profile".
  4. Click the "Passkey" button in the command button area.
  5. In the "Passkey" dialog, click the passkey you want to change.
    The 'Passkey' dialog where you click the passkey you want to change
  6. The "Edit Passkey" dialog will be displayed. Edit the "Title" and click the "Change" button.
    The 'Edit Passkey' dialog where the title is edited and changed
  7. The "Edit passkey" dialog will close and you can confirm the title change. Click the "Close" button.
    The 'Passkey' dialog showing the changed title
Delete Passkey
  1. Log in to Pleasanter.
  2. Click "User" in the navigation menu.
  3. Click "Edit profile".
  4. Click the "Passkey" button in the command button area.
  5. Click the checkbox on the left side of the passkey you want to delete to enable it, then click the "Delete" button.
    The 'Passkey' dialog with a passkey checked and the 'Delete' button
  6. A confirmation dialog will appear, so check the content and click the "OK" button.
    The confirmation dialog for deleting a passkey, with the 'OK' button
  7. The "Operation" dialog will close and you can confirm that the passkey has been deleted.
    The 'Passkey' dialog after the passkey has been deleted
  8. If necessary, delete the saved passkey from each OS or web browser. Check each product's manual for the storage location.

Supported Versions

Supported Version Details
1.5.1.0 and later Feature added