add_user_role {polished}

Polished API - Add a User Role

Description

Polished API - Add a User Role

Usage

add_user_role(
  user_uid,
  role_uid = NULL,
  role_name = NULL,
  api_key = get_api_key()
)

Arguments

user_uid

a user uid.

role_uid

an optional role uid.

role_name

an optional role name.

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

one of either role_uid or role_name must be provided. If both are provided, only the role_uid will be used.

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_user_roles() delete_user_role()