add_app_user {polished}

Polished API - Add a User to an App

Description

Polished API - Add a User to an App

Usage

add_app_user(
  app_uid,
  user_uid = NULL,
  email = NULL,
  is_admin = FALSE,
  send_invite_email = FALSE,
  api_key = get_api_key()
)

Arguments

app_uid

the app uid.

user_uid

an optional user uid for the user to be invited to the app.

email

an optional email address for the user to be invited to the app.

is_admin

boolean (default: FALSE) - whether or not the user is a Polished admin.

send_invite_email

boolean - whether or not to send the user an invite email notifying them they have been invited to access the app.

api_key

your Polished API key. Set your polished api key using set_api_key() so that you do not need to supply this argument with each function call.

Details

supply either the user_uid or email. If both are provided, then the user_uid will be used, and the email will be ignored.

Value

an object of class polished_api_res. When successful, the content of the polished_api_res is list(message = "success"). In the case of an error, the content is list(error = "<error message>").

See Also

get_app_users() update_app_user() delete_app_user()