updateUserName()

Package: react-wallet-kit

Overview

Updates the user’s name.

• This function updates the user’s display name.
• If a userId is provided, it updates the name for that specific user; otherwise, it uses the current session’s userId.
• Automatically ensures an active session exists before making the request.
• Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
• Handles session management and error reporting for the update flow.

Parameters

params · UpdateUserNameParams · required

Show params details

params.organizationId

string

organization ID to specify the sub-organization (defaults to the current session’s organizationId).

params.stampWith

StamperType

parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).

params.userId

string

user ID to update a specific user’s name (defaults to the current session’s userId).

params.userName

string

required

new name to set for the user.

Response

A successful response returns the following fields:

returns · string · required

A promise that resolves to the userId of the updated user.