BUbudibase
users

Update a user

Changed on
put/users/{userId}

Request

  • Base URL
    https://budibase.app/api/public/v1
  • URL
    https://budibase.app/api/public/v1/users/{userId}
  • Auth
    API key in header x-budibase-api-key

Path parameters

userIdstring required

The ID of the user which this request is targeting.

Request body

emailstring required

The email address of the user, this must be unique.

passwordstring

The password of the user if using password based login - this will never be returned. This can be left out of subsequent requests (updates) and will be enriched back into the user structure.

status'active'

The status of the user, if they are active.

firstNamestring

The first name of the user

lastNamestring

The last name of the user

forceResetPasswordboolean

If set to true forces the user to reset their password on first login.

rolesobject

Contains the roles of the user per app (assuming they are not a builder user). This field can only be set on a business or enterprise license.

userGroupsstring[]

The IDs of the user's groups. Find group IDs using GET /workspaces/{workspaceId}/groups or the Copy group ID button in Settings > People > Groups. Requires a global admin and the user groups and expanded public API features. On update, replaces memberships; omit to preserve them or provide an empty array to remove all memberships. SCIM-managed memberships cannot be added or removed. New users without group assignments receive the default group, if configured.

Response

Returns the updated user.

Changes

  • 00f3e37c4d30Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

  • 7400aae8fd5cRevision changes
    • breaking

      the response property / became optional for the status

    • info

      the request property became optional