Skip to contents

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(origin = origin, email = email, password = password, api_token =
    api_token),
  origin = pal::pkg_config_val("origin"),
  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

character(1)
E-mail address of the user to invite.

role

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

id_base

character(1)
NocoDB base identifier as returned by base_id().

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.

quiet

logical(1)
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.