Deletes the specified user on a NocoDB server via its
DELETE /api/v1/users/{id_user}
API endpoint.
Usage
delete_user(
id_user,
hostname = pal::pkg_config_val("hostname"),
email = pal::pkg_config_val("email"),
password = pal::pkg_config_val("password"),
quiet = FALSE
)
Arguments
- id_user
NocoDB user identifier as returned by
user_id()
. A character scalar.- hostname
NocoDB server hostname. A character scalar.
E-mail address of the NocoDB user to authenticate with.
- password
Password of the NocoDB user to authenticate with.
- quiet
Whether or not to suppress printing status output from internal processing.
Details
This API endpoint does not support authentication via API tokens.
API errors
If you encounter a
Cannot read properties of undefined (reading 'roles')
error, it likely means the specifiedid_user
is invalid (i.e. doesn't exist).If you encounter a
userDelete - : Not allowed
error, it means the authenticating user doesn't have sufficient privileges (must be"org-level-creator"
).
See also
Other functions to manage NocoDB users:
add_user()
,
base_users()
,
delete_base_user()
,
invite_base_user()
,
invite_user()
,
resend_base_user_invitation()
,
sign_up_user()
,
update_base_user()
,
update_user()
,
user_id()
,
users()
,
validate_user_email()
,
whoami()