My account

Update profile

Changed on

Update profile for the user, only the fields that are passed in will be updated. Updating or deleting username requires a logto-verification-id header for checking sensitive permissions. Removing any sign-in identifier, including username, is rejected if it would remove the user's last identifier.

patch/api/my-account

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/my-account
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Request body

namestring nullable

The new name for the user.

avatarstring url nullable

The new avatar for the user, must be a URL.

usernamestring regex nullable

The new username for the user, must be a valid username and unique.

customDataobject

The new custom data for the user. This will completely replace the existing customData. Requires CustomData scope.

Response

The profile was updated successfully.

idstring
usernamestring nullable
primaryEmailstring nullable
primaryPhonestring nullable
namestring nullable
avatarstring nullable
customDataobject

arbitrary

identitiesobject
lastSignInAtnumber nullable
createdAtnumber
updatedAtnumber
applicationIdstring nullable
cimdClientIdstring nullable

The identifier of the CIMD (client ID metadata document) client from the user's first consent. null unless the user's first consent was granted to a CIMD client. Mutually exclusive with applicationId. Only returned with the profile scope.

isSuspendedboolean
hasPasswordboolean
hasSecurityVerificationMethodboolean

Changes

  • f6be196bc327Revision changes
    • breaking

      the response property's maxLength was increased from 12 to 128 for the response status

    • breaking

      the // response property's maxLength was increased from 12 to 128 for the response status

  • 0287c6a59ebaRevision changes
    • info

      added the optional property to the response with the status