users

This section is auto-generated from the help text for the arrow command users.

activate_user command

Usage:

arrow users activate_user [OPTIONS] USER

Help

Activate a user

Output

an empty dictionary

Options:

-h, --help  Show this message and exit.

add_to_group command

Usage:

arrow users add_to_group [OPTIONS] GROUP USER

Help

Add a user to a group

Output

an empty dictionary

Options:

-h, --help  Show this message and exit.

create_user command

Usage:

arrow users create_user [OPTIONS] EMAIL FIRST_NAME LAST_NAME PASSWORD

Help

Create a new user

Output

an empty dictionary

Options:

--role TEXT      User's default role, one of "admin" or "user"  [default:
                 user]

--metadata TEXT  User metadata
-h, --help       Show this message and exit.

delete_user command

Usage:

arrow users delete_user [OPTIONS] USER

Help

Delete a user

Output

an empty dictionary

Options:

-h, --help  Show this message and exit.

get_organism_permissions command

Usage:

arrow users get_organism_permissions [OPTIONS] USER

Help

Display a user’s organism permissions

Output

a dictionary containing user’s organism permissions

Options:

-h, --help  Show this message and exit.

get_user_creator command

Usage:

arrow users get_user_creator [OPTIONS] USER

Help

Get the creator of a user

Output

a dictionary containing user information

Options:

-h, --help  Show this message and exit.

get_users command

Usage:

arrow users get_users [OPTIONS]

Help

Get all users known to this Apollo instance

Output

list of user info dictionaries

Options:

--omit_empty_organisms  Will omit users having no access to any organism
-h, --help              Show this message and exit.

inactivate_user command

Usage:

arrow users inactivate_user [OPTIONS] USER

Help

Activate a user

Output

an empty dictionary

Options:

-h, --help  Show this message and exit.

remove_from_group command

Usage:

arrow users remove_from_group [OPTIONS] GROUP USER

Help

Remove a user from a group

Output

an empty dictionary

Options:

-h, --help  Show this message and exit.

show_user command

Usage:

arrow users show_user [OPTIONS] USER

Help

Get a specific user

Output

a dictionary containing user information

Options:

-h, --help  Show this message and exit.

update_organism_permissions command

Usage:

arrow users update_organism_permissions [OPTIONS] USER ORGANISM

Help

Update the permissions of a user on a specified organism

Output

a dictionary containing user’s organism permissions

Options:

--administrate  Grants administrative privileges
--write         Grants write privileges
--export        Grants export privileges
--read          Grants read privileges
-h, --help      Show this message and exit.

update_user command

Usage:

arrow users update_user [OPTIONS] EMAIL FIRST_NAME LAST_NAME

Help

Update an existing user

Output

a dictionary containing user information

Options:

--password TEXT   User's password (omit to keep untouched)
--metadata TEXT   User metadata
--new_email TEXT  User's new email (if you want to change it)
-h, --help        Show this message and exit.