qbr (version 1.3.0)

get_users: Get users

Description

Get all users in an account. Provides options to limit values to a set of users and/or apps.

Usage

get_users(
  subdomain,
  auth,
  agent = NULL,
  account_id = NULL,
  user_emails = NULL,
  app_ids = NULL
)

Value

A tibble.

Arguments

subdomain

Character vector with one element. Found at the beginning of the Quickbase URL. Realm specific.

auth

Character vector with one element. The Quickbase authentication scheme you are using to authenticate the request (e.g., user token).

agent

Optional. Character vector with one element. Describes user/agent making API call.

account_id

Optional. Positive integer. The account ID being used to get users. If no value is specified, the first account associated with the requesting user token is chosen.

user_emails

Optional. List of characters. Limit returned users to those specified in this list.

app_ids

Optional. List of characters. Limit returned users to those assigned to these app ID's. The provided app ID's should belong to the same account.

Examples

if (FALSE) {
   get_users(subdomain = "abc",
             auth = keyring::key_get("qb_example"))
}