Skip to content

Latest commit

 

History

History
237 lines (189 loc) · 10.7 KB

terms-of-service.md

File metadata and controls

237 lines (189 loc) · 10.7 KB

box terms-of-service

List terms of services for your enterprise

box terms-of-service

List terms of services for your enterprise

USAGE
  $ box terms-of-service [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
    <value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--type managed|external]

FLAGS
  -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=<value>              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=<value>            Provide an ID for a user
      --bulk-file-path=<value>     File path to bulk .csv or .json objects
      --csv                        Output formatted CSV
      --fields=<value>             Comma separated list of fields to show
      --json                       Output formatted JSON
      --no-color                   Turn off colors for logging
      --save-to-file-path=<value>  Override default file path to save report
      --type=<option>              Filter by terms of service type
                                   <options: managed|external>

DESCRIPTION
  List terms of services for your enterprise

EXAMPLES
  $ box terms-of-service

See code: src/commands/terms-of-service/index.js

box terms-of-service:create

Create a terms of service

USAGE
  $ box terms-of-service:create --type managed|external --status enabled|disabled --text <value> [-t <value>] [--as-user
    <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path <value>] [--fields <value>] [--bulk-file-path
    <value>] [-h] [-v] [-y] [-q]

FLAGS
  -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=<value>              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=<value>            Provide an ID for a user
      --bulk-file-path=<value>     File path to bulk .csv or .json objects
      --csv                        Output formatted CSV
      --fields=<value>             Comma separated list of fields to show
      --json                       Output formatted JSON
      --no-color                   Turn off colors for logging
      --save-to-file-path=<value>  Override default file path to save report
      --status=<option>            (required) Status of the terms of service
                                   <options: enabled|disabled>
      --text=<value>               (required) Text for the terms of service
      --type=<option>              (required) Type of terms of service
                                   <options: managed|external>

DESCRIPTION
  Create a terms of service

EXAMPLES
  $ box terms-of-service:create --type external --status enabled --text "By using this service, you agree to...."

See code: src/commands/terms-of-service/create.js

box terms-of-service:get ID

Get information on a terms of service

USAGE
  $ box terms-of-service:get ID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
    <value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q]

ARGUMENTS
  ID  ID for the terms of service to get

FLAGS
  -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=<value>              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=<value>            Provide an ID for a user
      --bulk-file-path=<value>     File path to bulk .csv or .json objects
      --csv                        Output formatted CSV
      --fields=<value>             Comma separated list of fields to show
      --json                       Output formatted JSON
      --no-color                   Turn off colors for logging
      --save-to-file-path=<value>  Override default file path to save report

DESCRIPTION
  Get information on a terms of service

EXAMPLES
  $ box terms-of-service:get 55555

See code: src/commands/terms-of-service/get.js

box terms-of-service:get-user-status TOSID

Get a user's status on a terms of service

USAGE
  $ box terms-of-service:get-user-status TOSID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s |
    --save-to-file-path <value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--user-id <value>]

ARGUMENTS
  TOSID  ID of the terms of service to get user status for

FLAGS
  -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=<value>              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=<value>            Provide an ID for a user
      --bulk-file-path=<value>     File path to bulk .csv or .json objects
      --csv                        Output formatted CSV
      --fields=<value>             Comma separated list of fields to show
      --json                       Output formatted JSON
      --no-color                   Turn off colors for logging
      --save-to-file-path=<value>  Override default file path to save report
      --user-id=<value>            ID for a user to get status for; defaults to the current user ID

DESCRIPTION
  Get a user's status on a terms of service

EXAMPLES
  $ box terms-of-service:get-user-status 55555

See code: src/commands/terms-of-service/get-user-status.js

box terms-of-service:set-user-status ID

Set a user's status on a terms of service with a terms of service Id

USAGE
  $ box terms-of-service:set-user-status ID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
    <value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--accept | --reject] [--user-id <value>]

ARGUMENTS
  ID  ID of the terms of service to set the user status on

FLAGS
  -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=<value>              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
      --accept                     Set the user's status as accepted
      --as-user=<value>            Provide an ID for a user
      --bulk-file-path=<value>     File path to bulk .csv or .json objects
      --csv                        Output formatted CSV
      --fields=<value>             Comma separated list of fields to show
      --json                       Output formatted JSON
      --no-color                   Turn off colors for logging
      --reject                     Set the user's status as rejected
      --save-to-file-path=<value>  Override default file path to save report
      --user-id=<value>            ID of the user to set status for; defaults to the current user

DESCRIPTION
  Set a user's status on a terms of service with a terms of service Id

EXAMPLES
  $ box terms-of-service:set-user-status 55555 --accept

See code: src/commands/terms-of-service/set-user-status.js

box terms-of-service:update ID

Update a terms of service

USAGE
  $ box terms-of-service:update ID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
    <value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--status enabled|disabled] [--text
    <value>]

ARGUMENTS
  ID  ID of the terms of service to update

FLAGS
  -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=<value>              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=<value>            Provide an ID for a user
      --bulk-file-path=<value>     File path to bulk .csv or .json objects
      --csv                        Output formatted CSV
      --fields=<value>             Comma separated list of fields to show
      --json                       Output formatted JSON
      --no-color                   Turn off colors for logging
      --save-to-file-path=<value>  Override default file path to save report
      --status=<option>            Status of the terms of service
                                   <options: enabled|disabled>
      --text=<value>               Text for the terms of service

DESCRIPTION
  Update a terms of service

EXAMPLES
  $ box terms-of-service:update 55555 --status disabled

See code: src/commands/terms-of-service/update.js