retrieve_all_users: Retrieve a list of all users in a profile

Description Usage Arguments Value Examples

View source: R/users.R

Description

Retrieves a list of all users in a profile. Core API call Retrieve a List of Users

Usage

1
retrieve_all_users(server_name, profile_id, access_token)

Arguments

server_name

String of the iFormBuilder server name

profile_id

Integer of the iFormBuilder profile ID.

access_token

Access token produced by get_iform_access_token

Value

Dataframe containing all usernames and user IDs in the profile.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
## Not run: 
# Get access_token
access_token <- get_iform_access_token(
  server_name = "your_server_name",
  client_key_name = "your_client_key_name",
  client_secret_name = "your_client_secret_name")

# Get a list of all usernames and user IDs in a profile
all_users_info <- retrieve_all_users(
  server_name = "your_server_name",
  profile_id = 123456,
  access_token = access_token)

user_id = all_users_info$id[1]

## End(Not run)

arestrom/iformr documentation built on Nov. 25, 2021, 11:21 p.m.