Skip to contents

Sign up NocoDB user

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

Signs up the specified user on a NocoDB server via its POST /api/v1/auth/user/signup API endpoint.

If sign-up is restricted to invitees only, the user must have been invited before (via invite_user() or invite_base_user()) and an invite_token must be provided. Otherwise, the user is created straightaway (with the "org-level-viewer" role assigned).

Usage

sign_up_user(
  user_email,
  user_password,
  invite_token = NULL,
  subscribe_to_newsletter = FALSE,
  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")
)

Arguments

user_email

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

user_password

character(1)
Password of the user to sign up.

invite_token

character(1)
Invite token of the user to sign up.

subscribe_to_newsletter

logical(1)
Whether or not to subscribe the signed up user to the NocoDB newsletter.

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

The generated access token for the signed up user as a character scalar, invisibly.

API errors

  • If you did provide an invite_token and encounter a Not allowed to signup error, it means the provided user_email does not match the invite_token.

  • If you did not provide an invite_token and encounter a Not allowed to signup error, it means sign-up of new users is restricted to invitees only.

  • If you encounter an Invalid invite url error, it means the provided invite_token is either invalid or has already been used to sign up.

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(), update_base_user(), update_user(), user_id(), users(), validate_user_email(), whoami()

Other functions to manage NocoDB authentication: api_tokens(), assert_super_admin(), create_api_token(), delete_api_token(), is_signed_in(), is_super_admin(), refresh_sign_in(), req_auth(), sign_in(), sign_out()