Invite NocoDB base user

Invites a new user to the specified base on a NocoDB server via its POST /api/v2/meta/bases/{id_base}/users API endpoint.

Usage

invite_base_user(
  user_email,
  role = c("no-access", "viewer", "commenter", "editor", "creator"),
  id_base = base_id(hostname = hostname, email = email, password = password, api_token =
    api_token),
  hostname = pal::pkg_config_val("hostname"),
  email = pal::pkg_config_val("email"),
  password = pal::pkg_config_val("password"),
  api_token = pal::pkg_config_val("api_token"),
  quiet = FALSE
)

Arguments

user_email

E-mail address of the user to invite. A character scalar.

role

Base role to assign to the user. One of "no-access", "viewer", "commenter", "editor" or "creator".

id_base

NocoDB base identifier as returned by base_id(). A character scalar.

hostname

NocoDB server hostname. A character scalar.

email

E-mail address of the NocoDB user to authenticate with.

password

Password of the NocoDB user to authenticate with.

api_token

NocoDB API token. Takes precedence over email and password if provided.

quiet

Whether or not to suppress printing status output from internal processing.

Value

user_email, invisibly.

Details

Note that an invitation e-mail is sent if the specified user does not yet exist on the NocoDB server.

See also

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

Other functions to manage NocoDB bases: base(), base_id(), base_ui_acl(), base_users(), bases(), create_base(), delete_base(), delete_base_user(), resend_base_user_invitation(), update_base(), update_base_ui_acl(), update_base_user()