library(QualtricsInR) #> ✔ API token successfully loaded!
To get started, a useful function lists all the user accounts in the organisaion:
lst_users <- list_users()
Once you have access to user ids from the previous call, you can perform a number of actions:
get_userto retrieve user specific information, including permissions
update_userto retrieve user specific information, including permissions
get_user_api_tokento retrieve user specific information, including permissions
create_user_api_tokento retrieve user specific information, including permissions
The api token service is quiete useful if you need, as a brand admit, to interect with multiple user accounts through the API. Provided the API is enabled for these accounts, as an administrator, you will be able to retrieve or generate an API token successively through many accounts.
This can be useful if you building a summary analysis accross all you user accounts, for example. Be cautious of creating new API tokens for API enabled accounts as this will invalidated previously generated tokens by the account user.
A useful utility function to keep track of where you are is the
To create a user, you must a list of parameters to define the user account properties. An example is given below:
user_definitions <- list( "username" = "email@example.com", "firstName" = "first name", "lastName" = "last name", "userType" = "UT_012345678912345", "email" = "firstname.lastname@example.org", "password" = "$123456789!", "language" = "en", "timeZone" = NULL, "divisionId" = NULL, "accountExpirationDate" = NULL ) create_user(user_definitions)
One can obviously also delete a user.