Skip to main content

Update a user

PUT /api/admin/user-admin/:id

Only the explicitly specified fields get updated.


Path Parameters

  • id string required




  • email string

    The user's email address. Must be provided if username is not provided.

  • name string

    The user's name (not the user's username).

  • rootRole object

    The role to assign to the user. Can be either the role's ID or its unique name.

  • integer


  • id integer required

    The user id

  • isAPI boolean deprecated

    Deprecated in v5. Used internally to know which operations the user should be allowed to perform

  • name string nullable

    Name of the user

  • email string

    Email of the user

  • username string nullable

    A unique username for the user

  • imageUrl string

    URL used for the userprofile image

  • inviteLink string

    If the user is actively inviting other users, this is the link that can be shared with other users

  • loginAttempts integer

    How many unsuccessful attempts at logging in has the user made

  • emailSent boolean

    Is the welcome email sent to the user or not

  • rootRole object

    Which root role this user is assigned. Usually a numeric role ID, but can be a string when returning newly created user with an explicit string role.

  • integer
  • seenAt date-time nullable

    The last time this user logged in

  • createdAt date-time

    The user was created at this time

  • accountType string

    A user is either an actual User or a Service Account

  • permissions string[]


  • scimId string nullable

    The SCIM ID of the user, only present if managed by SCIM