polished (version 0.8.1)

get_users: Polished API - Get User(s)

Description

Polished API - Get User(s)

Usage

get_users(
  user_uid = NULL,
  email = NULL,
  include_two_fa = FALSE,
  api_key = get_api_key()
)

Value

an object of class polished_api_res. The content of the object is a tibble of users(s) with the following columns:

• uid

• email

• email_verified

• created_by

• created_at

• modified_by

• modified_at

• is_password_set

Arguments

user_uid

an optional user uid.

email

an optional user email.

include_two_fa

boolean, whether or not to include the 2FA information.

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

If both the user_uid and email are NULL, then all the users in your account will be returned. If either user_uid or email are not NULL, then a single user will be returned (assuming the user exists). If both the user_uid and email are provided, then the user_uid will be used, and the email will be ignored. If the user does not exists, a zero row tibble will be returned.

See Also

add_user() update_user() delete_user()