apollo.users package

Module contents

Contains possible interactions with the Apollo Users Module

class apollo.users.UsersClient(webapolloinstance, **requestArgs)

Bases: apollo.client.Client

CLIENT_BASE = '/user/'
activate_user(user)

Activate a user

Parameters:user (str) – User’s email
Return type:dict
Returns:an empty dictionary
add_to_group(group, user)

Add a user to a group

Parameters:
  • user (str) – User’s email
  • group (str) – Group name
Return type:

dict
Returns:

an empty dictionary
create_user(email, first_name, last_name, password, role='user', metadata={})

Create a new user

Parameters:
  • email (str) – User’s email
  • first_name (str) – User’s first name
  • last_name (str) – User’s last name
  • password (str) – User’s password
  • role (str) – User’s default role, one of “admin” or “user”
  • metadata (dict) – User metadata
Return type:

dict
Returns:

an empty dictionary
delete_user(user)

Delete a user

Parameters:user (str) – User’s email
Return type:dict
Returns:an empty dictionary
get_organism_permissions(user)

Display a user’s organism permissions

Parameters:user (str) – User’s email
Return type:dict
Returns:a dictionary containing user’s organism permissions
get_user_creator(user)

Get the creator of a user

Parameters:user (str) – User Email
Return type:dict
Returns:a dictionary containing user information
get_users(omit_empty_organisms=False)

Get all users known to this Apollo instance

Parameters:omit_empty_organisms (bool) – Will omit users having no access to any organism
Return type:list of dicts
Returns:list of user info dictionaries
inactivate_user(user)

Activate a user

Parameters:user (str) – User’s email
Return type:dict
Returns:an empty dictionary
remove_from_group(group, user)

Remove a user from a group

Parameters:
  • user (str) – User’s email
  • group (str) – Group name
Return type:

dict
Returns:

an empty dictionary
show_user(user)

Get a specific user

Parameters:user (str) – User Email
Return type:dict
Returns:a dictionary containing user information
update_organism_permissions(user, organism, administrate=False, write=False, export=False, read=False)

Update the permissions of a user on a specified organism

Parameters:
  • user (str) – User’s email
  • organism (str) – organism common name
  • administrate (bool) – Grants administrative privileges
  • write (bool) – Grants write privileges
  • read (bool) – Grants read privileges
  • export (bool) – Grants export privileges
Return type:

dict
Returns:

a dictionary containing user’s organism permissions
update_user(email, first_name, last_name, password=None, metadata={}, new_email=None)

Update an existing user

Parameters:
  • email (str) – User’s email
  • first_name (str) – User’s first name
  • last_name (str) – User’s last name
  • password (str) – User’s password (omit to keep untouched)
  • metadata (dict) – User metadata
  • new_email (str) – User’s new email (if you want to change it)
Return type:

dict
Returns:

a dictionary containing user information