Sign in
Users

Update user

Changed on

Update a user record.

<div> <code>update:users</code> </div>
patch/api/v1/user

Request

  • Base URL: https://your_kinde_subdomain.kinde.com
  • URL: https://your_kinde_subdomain.kinde.com/api/v1/user
  • Auth: HTTP bearer

Query parameters

idstring required

The user's id.

Request body

given_namestring

User's first name.

family_namestring

User's last name.

picturestring

The user's profile picture.

is_suspendedboolean

Whether the user is currently suspended or not.

is_password_reset_requestedboolean

Prompt the user to change their password on next sign in.

provided_idstring

An external id to reference the user.

Response

User successfully updated.

idstring

Unique ID of the user in Kinde.

given_namestring

User's first name.

family_namestring

User's last name.

emailstring

User's preferred email.

is_suspendedboolean

Whether the user is currently suspended or not.

is_password_reset_requestedboolean

Whether a password reset has been requested.

picturestring nullable

User's profile picture URL.

Changes

  • 2d09422a38e4Revision changes
    • breaking

      added the new required header request parameter Accept to all path's operations

    • info

      the endpoint scheme security kindeBearerAuth was added to the API

    • info

      the endpoint scheme security ManagementAPI was removed from the API

  • 6b937fa6da4eRevision changes
    • breaking

      removed the media type application/json; charset=utf-8 for the response with the status

    • breaking

      removed the media type application/json; charset=utf-8 for the response with the status

    • breaking

      the response property became nullable for the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status