Skip to contents

Update NocoDB user

Source: R/nocodb.gen.R
update_user.Rd

Updates the metadata of the specified user on a NocoDB server via its PATCH /api/v1/user/profile API endpoint.

Usage

update_user(
  display_name = NULL,
  origin = pal::pkg_config_val("origin"),
  email = pal::pkg_config_val("email"),
  password = pal::pkg_config_val("password"),
  api_token = NULL
)

Arguments

display_name

character(1)
Name to be displayed for the user in NocoDB. Omitted if NULL.

origin

character(1)
NocoDB server origin.

email

character(1)
E-mail address of the NocoDB user to authenticate with.

password

character(1)
Password of the NocoDB user to authenticate with.

api_token

character(1)
NocoDB API token. Takes precedence over email and password if provided.

Value

A tibble with metadata about the updated NocoDB user, invisibly.

Details

The user is determined based on api_token or email and password (the former takes precedence).

In order for other API endpoints to reflect the updated metadata, NocoDB's internal state must update, which is only triggered by this function iff the user to be updated is the super admin and authentication is done via email and password instead of api_token.

See also

Other functions to manage NocoDB users: add_user(), base_users(), delete_base_user(), delete_user(), invite_base_user(), invite_user(), resend_base_user_invitation(), sign_up_user(), update_base_user(), user_id(), users(), validate_user_email(), whoami()