Create a user

post

https://budibase.app/api/public/v1/users

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

required

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

password

string

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

string

enum

The status of the user, if they are active.

Allowed:

firstName

string

The first name of the user

lastName

string

The last name of the user

forceResetPassword

boolean

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

builder

object

Describes if the user is a builder user or not. This field can only be set on a business or enterprise license.

admin

object

Describes if the user is an admin user or not. This field can only be set on a business or enterprise license.

roles

object

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.

userGroups

array of strings, unique

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.

userGroups

Response

200Returns the created user.