CytobankAPI (version 2.2.0)

users: User Endpoints

Description

Interact with user endpoints. One should never analyze alone...

Usage

# S4 method for UserSession
users.list(
  UserSession,
  output = "default",
  timeout = UserSession@short_timeout
)
# S4 method for UserSession
users.show(
  UserSession,
  user_id,
  output = "default",
  timeout = UserSession@short_timeout
)

Arguments

UserSession

Cytobank UserSession object

output

character representing the output format [optional]
- users.list, users.show : ("default", "raw")

timeout

integer representing the request timeout time in seconds [optional]

user_id

integer representing a user ID

Details

users.list List all users on a Cytobank server (admin access only). Outputs a dataframe [default] or raw list with all fields present.
- Optional output parameter, specify one of the following: ("default", "raw")

users.show Show user details (admin access only, except for self). - Optional output parameter, specify one of the following: ("default", "raw")

Examples

if (FALSE) # Authenticate via username/password
cyto_session <- authenticate(site="premium", username="cyril_cytometry", password="cytobank_rocks!")
# Authenticate via auth_token
cyto_session <- authenticate(site="premium", auth_token="my_secret_auth_token")

if (FALSE) # Dataframe of all users with all fields present
users.list(cyto_session)

# Raw list of all useres with all fields present
users.list(cyto_session, output="raw")

if (FALSE) users.show(cyto_session, user_id=2)