Skip to content

Latest commit

 

History

History
614 lines (443 loc) · 27.7 KB

users.md

File metadata and controls

614 lines (443 loc) · 27.7 KB

box users

List all Box users

box users

List all Box users

USAGE
  $ box users

OPTIONS
  -a, --all-users                        Results from all users
  -e, --external-users                   Limit results to external users only
  -h, --help                             Show CLI help
  -m, --managed-users                    Limit results to managed users only
  -q, --quiet                            Suppress any non-error output to stderr
  -s, --save                             Save report to default reports folder on disk
  -t, --token=token                      Provide a token to perform this call
  -v, --verbose                          Show verbose output, which can be helpful for debugging
  -y, --yes                              Automatically respond yes to all confirmation prompts
  --app-users                            Limit results to app users only
  --as-user=as-user                      Provide an ID for a user
  --bulk-file-path=bulk-file-path        File path to bulk .csv or .json objects
  --csv                                  Output formatted CSV
  --fields=fields                        Comma separated list of fields to show
  --filter=filter                        Search term to filter users on; matches prefixes of user name and login fields
  --json                                 Output formatted JSON

  --max-items=max-items                  A value that indicates the maximum number of results to return. This only
                                         specifies a maximum boundary and will not guarantee the minimum number of
                                         results returned. When the max-items (x) is greater than 1000, then the maximum
                                         ceil(x/1000) requests will be made.

  --no-color                             Turn off colors for logging

  --save-to-file-path=save-to-file-path  Override default file path to save report

ALIASES
  $ box users:list

EXAMPLE
  box users

See code: src/commands/users/index.js

box users:create NAME [LOGIN]

Create a new Box User

USAGE
  $ box users:create NAME [LOGIN]

ARGUMENTS
  NAME   The user's name
  LOGIN  The user's email address, not required when creating app users

OPTIONS
  -S, --status=active|inactive|cannot_delete_edit|cannot_delete_edit_upload  User status
  -a, --address=address                                                      Address of the user

  -d, --disk-space=disk-space                                                User's available storage in bytes. Value of
                                                                             -1 grants unlimited storage

  -h, --help                                                                 Show CLI help

  -j, --job-title=job-title                                                  Job title of the user

  -l, --language=language                                                    Language of the user (ISO 639-1 Language
                                                                             Code).
                                                                             https://developer.box.com/v2.0/docs/api-lan
                                                                             guage-codes

  -p, --phone-number=phone-number                                            Phone number of the user

  -q, --quiet                                                                Suppress any non-error output to stderr

  -r, --role=user|coadmin                                                    Role of user. Enter user or coadmin

  -s, --save                                                                 Save report to default reports folder on
                                                                             disk

  -t, --token=token                                                          Provide a token to perform this call

  -v, --verbose                                                              Show verbose output, which can be helpful
                                                                             for debugging

  -y, --yes                                                                  Automatically respond yes to all
                                                                             confirmation prompts

  --app-user                                                                 Set this user as an app user

  --as-user=as-user                                                          Provide an ID for a user

  --bulk-file-path=bulk-file-path                                            File path to bulk .csv or .json objects

  --[no-]can-see-managed-users                                               User can see managed users

  --csv                                                                      Output formatted CSV

  --[no-]exempt-from-2fa                                                     Exempt user from two-factor auth

  --[no-]exempt-from-device-limits                                           Exempt user from device limits

  --external-id=external-id                                                  External ID for app users

  --fields=fields                                                            Comma separated list of fields to show

  --id-only                                                                  Return only an ID to output from this
                                                                             command

  --json                                                                     Output formatted JSON

  --no-color                                                                 Turn off colors for logging

  --password-reset                                                           Force the user to reset password

  --[no-]restrict-external-collab                                            Restrict user from external collaboration

  --save-to-file-path=save-to-file-path                                      Override default file path to save report

  --[no-]sync-enable                                                         Enable Box Sync for this user

  --timezone=timezone                                                        The user's timezone. Input format follows
                                                                             tz database timezones

  --tracking-codes=tracking-codes                                            Comma-separated list of key-value pairs to
                                                                             associate with the user. Format is
                                                                             name=value,name=value

EXAMPLE
  box users:create "John Doe" jdoe@example.com

See code: src/commands/users/create.js

box users:delete ID

Delete a Box User

USAGE
  $ box users:delete ID

ARGUMENTS
  ID  User ID to delete

OPTIONS
  -f, --force                            Delete user even if they own files
  -h, --help                             Show CLI help
  -q, --quiet                            Suppress any non-error output to stderr
  -s, --save                             Save report to default reports folder on disk
  -t, --token=token                      Provide a token to perform this call
  -v, --verbose                          Show verbose output, which can be helpful for debugging
  -y, --yes                              Automatically respond yes to all confirmation prompts
  --as-user=as-user                      Provide an ID for a user
  --bulk-file-path=bulk-file-path        File path to bulk .csv or .json objects
  --csv                                  Output formatted CSV
  --fields=fields                        Comma separated list of fields to show
  --json                                 Output formatted JSON
  --no-color                             Turn off colors for logging
  --[no-]notify                          The user should be notified
  --save-to-file-path=save-to-file-path  Override default file path to save report

EXAMPLE
  box users:delete 33333

See code: src/commands/users/delete.js

box users:email-aliases USERID

Get all Email Aliases for a User

USAGE
  $ box users:email-aliases USERID

ARGUMENTS
  USERID  User ID to get email aliases for

OPTIONS
  -h, --help                             Show CLI help
  -q, --quiet                            Suppress any non-error output to stderr
  -s, --save                             Save report to default reports folder on disk
  -t, --token=token                      Provide a token to perform this call
  -v, --verbose                          Show verbose output, which can be helpful for debugging
  -y, --yes                              Automatically respond yes to all confirmation prompts
  --as-user=as-user                      Provide an ID for a user
  --bulk-file-path=bulk-file-path        File path to bulk .csv or .json objects
  --csv                                  Output formatted CSV
  --fields=fields                        Comma separated list of fields to show
  --json                                 Output formatted JSON
  --no-color                             Turn off colors for logging
  --save-to-file-path=save-to-file-path  Override default file path to save report

ALIASES
  $ box users:get-email-aliases

EXAMPLE
  box users:email-aliases 33333

See code: src/commands/users/email-aliases/index.js

box users:email-aliases:add USERID EMAIL

Add a new email alias to a user

USAGE
  $ box users:email-aliases:add USERID EMAIL

ARGUMENTS
  USERID  User ID to add email alias
  EMAIL   Email to add as alias

OPTIONS
  -h, --help                             Show CLI help
  -q, --quiet                            Suppress any non-error output to stderr
  -s, --save                             Save report to default reports folder on disk
  -t, --token=token                      Provide a token to perform this call
  -v, --verbose                          Show verbose output, which can be helpful for debugging
  -y, --yes                              Automatically respond yes to all confirmation prompts
  --as-user=as-user                      Provide an ID for a user
  --bulk-file-path=bulk-file-path        File path to bulk .csv or .json objects

  --[no-]confirm                         Whether or not to confirm the email alias.  Only Admins may automatically
                                         confirm an alias.

  --csv                                  Output formatted CSV

  --fields=fields                        Comma separated list of fields to show

  --json                                 Output formatted JSON

  --no-color                             Turn off colors for logging

  --save-to-file-path=save-to-file-path  Override default file path to save report

ALIASES
  $ box users:add-email-alias

EXAMPLE
  box users:email-aliases:add 33333 user+alias@example.com

See code: src/commands/users/email-aliases/add.js

box users:email-aliases:remove USERID ALIASID

Delete an email alias from a user

USAGE
  $ box users:email-aliases:remove USERID ALIASID

ARGUMENTS
  USERID   User ID to get email aliases
  ALIASID  The ID of the email alias to delete

OPTIONS
  -h, --help                             Show CLI help
  -q, --quiet                            Suppress any non-error output to stderr
  -s, --save                             Save report to default reports folder on disk
  -t, --token=token                      Provide a token to perform this call
  -v, --verbose                          Show verbose output, which can be helpful for debugging
  -y, --yes                              Automatically respond yes to all confirmation prompts
  --as-user=as-user                      Provide an ID for a user
  --bulk-file-path=bulk-file-path        File path to bulk .csv or .json objects
  --csv                                  Output formatted CSV
  --fields=fields                        Comma separated list of fields to show
  --json                                 Output formatted JSON
  --no-color                             Turn off colors for logging
  --save-to-file-path=save-to-file-path  Override default file path to save report

ALIASES
  $ box users:delete-email-alias

EXAMPLE
  box users:email-aliases:remove 33333 12345

See code: src/commands/users/email-aliases/remove.js

box users:get [ID]

Get information about a Box user

USAGE
  $ box users:get [ID]

ARGUMENTS
  ID  [default: me] ID of the user to get; defaults to the current user

OPTIONS
  -h, --help                             Show CLI help
  -q, --quiet                            Suppress any non-error output to stderr
  -s, --save                             Save report to default reports folder on disk
  -t, --token=token                      Provide a token to perform this call
  -v, --verbose                          Show verbose output, which can be helpful for debugging
  -y, --yes                              Automatically respond yes to all confirmation prompts
  --as-user=as-user                      Provide an ID for a user
  --bulk-file-path=bulk-file-path        File path to bulk .csv or .json objects
  --csv                                  Output formatted CSV
  --fields=fields                        Comma separated list of fields to show
  --json                                 Output formatted JSON
  --no-color                             Turn off colors for logging
  --save-to-file-path=save-to-file-path  Override default file path to save report

EXAMPLE
  box users:get 33333

See code: src/commands/users/get.js

box users:groups ID

List groups a user belongs to

USAGE
  $ box users:groups ID

ARGUMENTS
  ID  ID of the user to get groups for

OPTIONS
  -h, --help                             Show CLI help
  -q, --quiet                            Suppress any non-error output to stderr
  -s, --save                             Save report to default reports folder on disk
  -t, --token=token                      Provide a token to perform this call
  -v, --verbose                          Show verbose output, which can be helpful for debugging
  -y, --yes                              Automatically respond yes to all confirmation prompts
  --as-user=as-user                      Provide an ID for a user
  --bulk-file-path=bulk-file-path        File path to bulk .csv or .json objects
  --csv                                  Output formatted CSV
  --fields=fields                        Comma separated list of fields to show
  --json                                 Output formatted JSON

  --max-items=max-items                  A value that indicates the maximum number of results to return. This only
                                         specifies a maximum boundary and will not guarantee the minimum number of
                                         results returned. When the max-items (x) is greater than 1000, then the maximum
                                         ceil(x/1000) requests will be made.

  --no-color                             Turn off colors for logging

  --save-to-file-path=save-to-file-path  Override default file path to save report

ALIASES
  $ box users:list-groups

EXAMPLE
  box users:groups 33333

See code: src/commands/users/groups.js

box users:invite EMAIL ENTERPRISEID

Invite an Existing Box User to Your Enterprise

USAGE
  $ box users:invite EMAIL ENTERPRISEID

ARGUMENTS
  EMAIL         Email address of the user to invite
  ENTERPRISEID  ID of the Enterprise to invite the user to

OPTIONS
  -h, --help                             Show CLI help
  -q, --quiet                            Suppress any non-error output to stderr
  -s, --save                             Save report to default reports folder on disk
  -t, --token=token                      Provide a token to perform this call
  -v, --verbose                          Show verbose output, which can be helpful for debugging
  -y, --yes                              Automatically respond yes to all confirmation prompts
  --as-user=as-user                      Provide an ID for a user
  --bulk-file-path=bulk-file-path        File path to bulk .csv or .json objects
  --csv                                  Output formatted CSV
  --fields=fields                        Comma separated list of fields to show
  --json                                 Output formatted JSON
  --no-color                             Turn off colors for logging
  --save-to-file-path=save-to-file-path  Override default file path to save report

ALIASES
  $ box users:invite-user

EXAMPLE
  box users:invite user@example.com 12345

See code: src/commands/users/invite.js

box users:search NAME

Search for Box users

USAGE
  $ box users:search NAME

ARGUMENTS
  NAME  Name of user to search for

OPTIONS
  -a, --all-users                        Results from all users
  -e, --external-users                   Limit results to external users only
  -h, --help                             Show CLI help
  -m, --managed-users                    Limit results to managed users only
  -q, --quiet                            Suppress any non-error output to stderr
  -s, --save                             Save report to default reports folder on disk
  -t, --token=token                      Provide a token to perform this call
  -v, --verbose                          Show verbose output, which can be helpful for debugging
  -y, --yes                              Automatically respond yes to all confirmation prompts
  --as-user=as-user                      Provide an ID for a user
  --bulk-file-path=bulk-file-path        File path to bulk .csv or .json objects
  --csv                                  Output formatted CSV
  --fields=fields                        Comma separated list of fields to show
  --json                                 Output formatted JSON
  --no-color                             Turn off colors for logging
  --save-to-file-path=save-to-file-path  Override default file path to save report

EXAMPLE
  box users:search "John Doe"

See code: src/commands/users/search.js

box users:terminate-session

Validates the roles and permissions of the user, and creates asynchronous jobs to terminate the user's sessions.

USAGE
  $ box users:terminate-session

OPTIONS
  -h, --help                             Show CLI help
  -q, --quiet                            Suppress any non-error output to stderr
  -s, --save                             Save report to default reports folder on disk
  -t, --token=token                      Provide a token to perform this call
  -v, --verbose                          Show verbose output, which can be helpful for debugging
  -y, --yes                              Automatically respond yes to all confirmation prompts
  --as-user=as-user                      Provide an ID for a user
  --bulk-file-path=bulk-file-path        File path to bulk .csv or .json objects
  --csv                                  Output formatted CSV
  --fields=fields                        Comma separated list of fields to show
  --json                                 Output formatted JSON
  --no-color                             Turn off colors for logging
  --save-to-file-path=save-to-file-path  Override default file path to save report
  --user-ids=user-ids                    A list of user IDs
  --user-logins=user-logins              A list of user logins

ALIASES
  $ box users:terminate-session

EXAMPLE
  box users:terminate-session --user-ids 123 345 --user-logins abc@example.com def@example.com

See code: src/commands/users/terminate-session.js

box users:transfer-content USERID NEWUSERID

Move a user's root content to another user

USAGE
  $ box users:transfer-content USERID NEWUSERID

ARGUMENTS
  USERID     User whose content should be moved
  NEWUSERID  User to whom the content should be moved

OPTIONS
  -h, --help                             Show CLI help
  -q, --quiet                            Suppress any non-error output to stderr
  -s, --save                             Save report to default reports folder on disk
  -t, --token=token                      Provide a token to perform this call
  -v, --verbose                          Show verbose output, which can be helpful for debugging
  -y, --yes                              Automatically respond yes to all confirmation prompts
  --as-user=as-user                      Provide an ID for a user
  --bulk-file-path=bulk-file-path        File path to bulk .csv or .json objects
  --csv                                  Output formatted CSV
  --fields=fields                        Comma separated list of fields to show
  --json                                 Output formatted JSON
  --no-color                             Turn off colors for logging
  --[no-]notify                          Notify the user that their content has been moved
  --save-to-file-path=save-to-file-path  Override default file path to save report

ALIASES
  $ box users:move-root-content

EXAMPLE
  box users:transfer-content 33333 44444

See code: src/commands/users/transfer-content.js

box users:update ID

Update a Box User

USAGE
  $ box users:update ID

ARGUMENTS
  ID  User ID to update

OPTIONS
  -S, --status=active|inactive|cannot_delete_edit|cannot_delete_edit_upload  User status. Enter active, inactive,
                                                                             cannot_delete_edit, or
                                                                             cannot_delete_edit_upload

  -a, --address=address                                                      Address of the user

  -d, --disk-space=disk-space                                                User's available storage in bytes. Value of
                                                                             -1 grants unlimited storage

  -h, --help                                                                 Show CLI help

  -j, --job-title=job-title                                                  Job title of the user

  -l, --language=language                                                    Language of the user (ISO 639-1 Language
                                                                             Code).
                                                                             https://developer.box.com/v2.0/docs/api-lan
                                                                             guage-codes

  -n, --name=name                                                            Set the user's name

  -p, --phone-number=phone-number                                            Phone number of the user

  -q, --quiet                                                                Suppress any non-error output to stderr

  -r, --role=user|coadmin                                                    Role of user. Enter user or coadmin

  -s, --save                                                                 Save report to default reports folder on
                                                                             disk

  -t, --token=token                                                          Provide a token to perform this call

  -v, --verbose                                                              Show verbose output, which can be helpful
                                                                             for debugging

  -y, --yes                                                                  Automatically respond yes to all
                                                                             confirmation prompts

  --as-user=as-user                                                          Provide an ID for a user

  --bulk-file-path=bulk-file-path                                            File path to bulk .csv or .json objects

  --[no-]can-see-managed-users                                               User can see managed users

  --csv                                                                      Output formatted CSV

  --[no-]exempt-from-2fa                                                     Exempt user from two-factor auth

  --[no-]exempt-from-device-limits                                           Exempt user from device limits

  --external-id=external-id                                                  External ID for app users

  --fields=fields                                                            Comma separated list of fields to show

  --json                                                                     Output formatted JSON

  --login=login                                                              Change the user's primary email address
                                                                             used for logging into Box

  --no-color                                                                 Turn off colors for logging

  --password-reset                                                           Force the user to reset password

  --remove                                                                   Remove the user from the enterprise,
                                                                             convert to free account

  --[no-]restrict-external-collab                                            Restrict user from external collaboration

  --save-to-file-path=save-to-file-path                                      Override default file path to save report

  --[no-]sync-enable                                                         Enable Box Sync for this user

  --timezone=timezone                                                        The user's timezone. Input format follows
                                                                             tz database timezones

  --tracking-codes=tracking-codes                                            Comma-separated list of key-value pairs to
                                                                             associate with the user. Format is
                                                                             name=value,name=value

EXAMPLE
  box users:update 33333 --status inactive

See code: src/commands/users/update.js