users

Manage users within your CrashPlan environment.

Usage

users [OPTIONS] COMMAND [ARGS]...

add-role

Add the specified role to the user with the specified username.

Usage

users add-role [OPTIONS]

Options

--username <username>: Username of the target user.

--role-name <role_name>: Name of role to add.

-d, --debug: Turn on debug logging.

--totp <totp>: TOTP token for multi-factor authentication.

--profile <profile>: The name of the CrashPlan CLI profile to use when executing this command.

bulk

Tools for managing users in bulk.

Usage

users bulk [OPTIONS] COMMAND [ARGS]...

add-roles

Add roles to a list of users from the provided CSV in format: username,role_name

Usage

users bulk add-roles [OPTIONS] CSV_FILE

Options

-f, --format <format>

The output format of the result. Defaults to table format.

Options:: TABLE | CSV | JSON | RAW-JSON

-d, --debug: Turn on debug logging.

--totp <totp>: TOTP token for multi-factor authentication.

--profile <profile>: The name of the CrashPlan CLI profile to use when executing this command.

Arguments

CSV_FILE: Required argument

deactivate

Deactivate a list of users from the provided CSV in format: username

Usage

users bulk deactivate [OPTIONS] CSV_FILE

Options

-f, --format <format>

The output format of the result. Defaults to table format.

Options:: TABLE | CSV | JSON | RAW-JSON

-d, --debug: Turn on debug logging.

--totp <totp>: TOTP token for multi-factor authentication.

--profile <profile>: The name of the CrashPlan CLI profile to use when executing this command.

--purge-date <purge_date>: The date on which all a users archives should be purged from cold storage in yyyy-MM-dd format. If not provided, the date will be set according to the appropriate organization settings.

Arguments

CSV_FILE: Required argument

generate-template

Generate the CSV template needed for bulk user commands.

Usage

users bulk generate-template [OPTIONS] {update|move}

Options

-p, --path <path>: Write template file to specific file path/name.

Arguments

CMD: Required argument

move

Change the organization of the list of users from the provided CSV in format: username,org_id

Usage

users bulk move [OPTIONS] CSV_FILE

Options

-f, --format <format>

The output format of the result. Defaults to table format.

Options:: TABLE | CSV | JSON | RAW-JSON

-d, --debug: Turn on debug logging.

--totp <totp>: TOTP token for multi-factor authentication.

--profile <profile>: The name of the CrashPlan CLI profile to use when executing this command.

Arguments

CSV_FILE: Required argument

reactivate

Reactivate a list of users from the provided CSV in format: username

Usage

users bulk reactivate [OPTIONS] CSV_FILE

Options

-f, --format <format>

The output format of the result. Defaults to table format.

Options:: TABLE | CSV | JSON | RAW-JSON

-d, --debug: Turn on debug logging.

--totp <totp>: TOTP token for multi-factor authentication.

--profile <profile>: The name of the CrashPlan CLI profile to use when executing this command.

Arguments

CSV_FILE: Required argument

remove-roles

Remove roles from a list of users from the provided CSV in format: username,role_name

Usage

users bulk remove-roles [OPTIONS] CSV_FILE

Options

-f, --format <format>

The output format of the result. Defaults to table format.

Options:: TABLE | CSV | JSON | RAW-JSON

-d, --debug: Turn on debug logging.

--totp <totp>: TOTP token for multi-factor authentication.

--profile <profile>: The name of the CrashPlan CLI profile to use when executing this command.

Arguments

CSV_FILE: Required argument

update

Update a list of users from the provided CSV in format: user_uid,username,email,password,first_name,last_name,notes,archive_size_quota

Usage

users bulk update [OPTIONS] CSV_FILE

Options

-f, --format <format>

The output format of the result. Defaults to table format.

Options:: TABLE | CSV | JSON | RAW-JSON

-d, --debug: Turn on debug logging.

--totp <totp>: TOTP token for multi-factor authentication.

--profile <profile>: The name of the CrashPlan CLI profile to use when executing this command.

Arguments

CSV_FILE: Required argument

deactivate

Deactivate a user.

Usage

users deactivate [OPTIONS] USERNAME

Options

--purge-date <purge_date>: The date on which all a users archives should be purged from cold storage in yyyy-MM-dd format. If not provided, the date will be set according to the appropriate organization settings.

-d, --debug: Turn on debug logging.

--totp <totp>: TOTP token for multi-factor authentication.

--profile <profile>: The name of the CrashPlan CLI profile to use when executing this command.

Arguments

USERNAME: Required argument

list

List users in your CrashPlan environment.

Usage

users list [OPTIONS]

Options

--org-uid <org_uid>: Limit users to only those in the organization you specify. Note that child orgs are included.

--role-name <role_name>: Limit results to only users having the specified role.

--active: Limits results to only active users.

--inactive: Limits results to only deactivated users.

--include-legal-hold-membership: Include legal hold membership in output.

--include-roles: Include user roles.

-f, --format <format>

The output format of the result. Defaults to table format.

Options:: TABLE | CSV | JSON | RAW-JSON

-d, --debug: Turn on debug logging.

--totp <totp>: TOTP token for multi-factor authentication.

--profile <profile>: The name of the CrashPlan CLI profile to use when executing this command.

move

Change the organization of the user with the given username to the org with the given org_id, or org_uid.

Usage

users move [OPTIONS]

Options

--username <username>: Required The username of the user to move.

--org-id <org_id>: Required The unique identifier (UID) for the organization to which the user will be moved.

-d, --debug: Turn on debug logging.

--totp <totp>: TOTP token for multi-factor authentication.

--profile <profile>: The name of the CrashPlan CLI profile to use when executing this command.

orgs

Tools for viewing user orgs.

Usage

users orgs [OPTIONS] COMMAND [ARGS]...

list

List all orgs.

Usage

users orgs list [OPTIONS]

Options

-f, --format <format>

The output format of the result. Defaults to table format.

Options:: TABLE | CSV | JSON | RAW-JSON

-d, --debug: Turn on debug logging.

--totp <totp>: TOTP token for multi-factor authentication.

--profile <profile>: The name of the CrashPlan CLI profile to use when executing this command.

show

Show org details.

Usage

users orgs show [OPTIONS] ORG_UID

Options

-f, --format <format>

The output format of the result. Defaults to table format.

Options:: TABLE | CSV | JSON | RAW-JSON

-d, --debug: Turn on debug logging.

--totp <totp>: TOTP token for multi-factor authentication.

--profile <profile>: The name of the CrashPlan CLI profile to use when executing this command.

Arguments

ORG_UID: Required argument

reactivate

Reactivate a user.

Usage

users reactivate [OPTIONS] USERNAME

Options

-d, --debug: Turn on debug logging.

--totp <totp>: TOTP token for multi-factor authentication.

--profile <profile>: The name of the CrashPlan CLI profile to use when executing this command.

Arguments

USERNAME: Required argument

remove-role

Remove the specified role to the user with the specified username.

Usage

users remove-role [OPTIONS]

Options

--role-name <role_name>: Name of role to remove.

--username <username>: Username of the target user.

-d, --debug: Turn on debug logging.

--totp <totp>: TOTP token for multi-factor authentication.

--profile <profile>: The name of the CrashPlan CLI profile to use when executing this command.

show

Show user details.

Usage

users show [OPTIONS] USERNAME

Options

--include-legal-hold-membership: Include legal hold membership in output.

-f, --format <format>

The output format of the result. Defaults to table format.

Options:: TABLE | CSV | JSON | RAW-JSON

-d, --debug: Turn on debug logging.

--totp <totp>: TOTP token for multi-factor authentication.

--profile <profile>: The name of the CrashPlan CLI profile to use when executing this command.

Arguments

USERNAME: Required argument

update

Update a user with the specified unique identifier.

Usage

users update [OPTIONS]

Options

--user-uid <user_uid>: Required The unique identifier of the user to be modified.

--username <username>: The new username for the user.

--password <password>: The new password for the user.

--email <email>: The new email for the user.

--first-name <first_name>: The new first name for the user.

--last-name <last_name>: The new last name for the user.

--notes <notes>: Notes about this user.

--archive-size-quota <archive_size_quota>: The total size (in bytes) allowed for this user.

-d, --debug: Turn on debug logging.

--totp <totp>: TOTP token for multi-factor authentication.

--profile <profile>: The name of the CrashPlan CLI profile to use when executing this command.