permissions: Permissions

In Saint-Louis-University/fac180: R Bindings to Faculty180

Description

Retrieve details of users' permissions.

Usage

fac_get_users_permissions(userlist, rights = c("1,2", "1", "2"), unitid,
  data = c("count", "summary", "detailed"), q, limit, offset, ...)

fac_get_user_permissions(userid, rights, unitid, data = c("count",
  "summary", "detailed"), q, limit, offset, ...)

Arguments

userlist	comma separated vector of string Enter user(s) to retrieve permissions information. When defined, limits the bulk GET to the users in the list. When undefined, all faculty and their permissions are listed
rights	string Defaults to “1,2” when nothing is sent or the value is invalid. When set to “1”, the system will only report users with Full Admin Rights. When set to “2”, the system will only report users with Report Rights. When set to “1,2” all rights will be returned.
unitid	comma separated vector of integer Retrieve a user with specific unitid(s). When defined, only returns permissions for selected unitids. When undefined, all units are selected. Multiple values can be sent as a comma separated list.
data	string Determines the extent of data that will be returned. Count: Returns count of all activities found. Summary: Returns an array of sections and counts of activities within that section. Detailed: Returns an array of sections and a subarray of activityids for each section.
q	string Search term. Use '*' as wildcard.
limit	integer Limit query to specified number of records.
offset	integer Used with limit to return records in batches, e.g., if limit = 20 and offset = 21, records 21-40 will be returned.
...	additional arguments passed to GET.
userid	string Retrieves permission details on the specified user.

Value

a response object

Note

API documentation: https://faculty180.interfolio.com/swagger/ui/#tag/Permissions

Examples

## Not run: 
## retrieves a listing of users and basic identifying information for each
r <- fac_get_users_permissions(userlist = "m123456,m789123")
content(r)

##retrieves a listing of users and basic identifying information for each
# need ask interfolio
#r <- fac_get_user_permissions(userlist = "m123456,m789123", rights = 1)
#content(r)

## retrieves a listing of users and basic identifying information for each
r <- fac_get_users_permissions(userid = "m123456", data = "detailed")
content(r)

## retrieves a listing of users and basic identifying information for each
# need ask interfolio
#r <- fac_get_user_permissions(userid = "m123456", data = "detailed", unitid = 2)
#content(r)

## End(Not run)

Saint-Louis-University/fac180 documentation built on Oct. 30, 2019, 11:46 p.m.