Skip to contents

Invites a new user on a NocoDB server via its POST /api/v1/users API endpoint.

Usage

invite_user(
  user_email,
  org_role = c("org-level-viewer", "org-level-creator"),
  origin = pal::pkg_config_val("origin"),
  email = pal::pkg_config_val("email", require = TRUE),
  password = pal::pkg_config_val("password", require = TRUE),
  quiet = FALSE
)

Arguments

user_email

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

org_role

character(1)
Organisation-level role to assign to the user. One of "org-level-viewer" or "org-level-creator".

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.

quiet

logical(1)
Whether or not to suppress printing status output from internal processing.

Value

NULL, invisibly.

Details

This API endpoint does not support authentication via API tokens.