Update Passkey #

How to update a Passkey’s name #

The updatePasskey REST call allows a user to rename a passkey associated with their account. Since users can have multiple passkeys stored on different device keychains, assigning distinct names helps differentiate them for easier identification and management.

URL #

    /api/appuser/updatePasskey

Method #

    POST

Headers #

    access-token: "<Access Token>"

Data Parameter #

    {
        keyId: "<key id from authenticators>",
        keyName: "<new key name>",
    }   

Response: #

Success: #

StatusCode: #

    200 (OK)

Contents: #

    {
        appId: <uuid>,
        appUserId: <uuid>,
        handle: <user handle>,
        displayName: <display name>,
        status: <'active', 'suspended'>,
        lastLogin: "2024-09-03T13:21:34.000Z",
        userName: <user name>,
        authenticators: [
            {
                id: <authenticator_id>,
                publicKey: <public key>,
                counter: 0,
                deviceType: "multiDevice",
                credentialBackedUp: true,
                name: <displayName-platform>,
                type: "public-key",
                transports: "internal",
                platform: <authenticator platform>,
                lastUsed: "2024-09-03T13:21:34.000Z",
                createdAt: "Mon, 02 Sep 2024 14:56:46 GMT",
                updatedAt: "Mon, 02 Sep 2024 14:56:46 GMT"
            }
        ],
        locale: <current locale>,
        jwt: <jwt token>
        access-token: <access token>,
        createdAt: "2024-09-02T08:16:07.000Z",
        updatedAt: "2024-09-03T13:21:30.000Z",
    }

Error: #

StatusCode: #

    400 (BAD REQUEST)
    500 (INTERNAL SERVER ERROR)

Content: #

    {
        code: "<internal error code>",
        message: "<readable error description>"
    }

The internal codes are integers:

• 401 - app no longer exists
• 402 - app is suspended
• 403 - missing parameter
• 404 - user account is suspended
• 405 - invalid access token
• 413 - app is migrated
• 500 - internal server error
• 602 - invalid data
• 609 - invalid locale