userRoleAssignmentMethods function

Export or Import User-Role Assignments

These methods enable the user to export the user-role assignments, add assignments, or modify existing assignments.

exportUserRoleAssignments(rcon, ...)

importUserRoleAssignments(rcon, data, ...)

## S3 method for class 'redcapApiConnection'
exportUserRoleAssignments(rcon, ...)

## S3 method for class 'redcapApiConnection'
importUserRoleAssignments(rcon, data, ...)

Arguments

• rcon: A redcapConnection object.
• data: data.frame with columns username and unique_role_name. Each username must be unique. Users without a unique_role_name will not be assigned to a user role.
• ...: Arguments to pass to other methods

Returns

exportUserRoleAssignments returns a data frame with the columns:

username	Username of a user in the project.
unique_role_name	The unique role name to which the user is assigned.
data_access_group	The Data Access Group to which the user is assigned.

importUserRoleAssignments invisibly returns the number of user roles assignments added or modified.

Functions

• exportUserRoleAssignments(): Export user-role assignments from a project.
• importUserRoleAssignments(): Import user-role assignments to a project.

Examples

## Not run:

unlockREDCap(connections = c(rcon = "project_alias"), 
             url = "your_redcap_url", 
             keyring = "API_KEYs", 
             envir = globalenv())
             
# Export user-role assignments
exportUserRoleAssignments(rcon)

# Import/modify a user-role assignment
NewData <- data.frame(username = "desired_user_name", 
                      unique_role_name = "KN3430U")
importUserRolesAssignments(rcon, 
                           data = NewData)
## End(Not run)

See Also

exportUsers(),

importUsers(),

deleteUsers(),

exportUserRoles(),

importUserRoles(),

deleteUserRoles()