Skip to content

tokens.md

Latest commit

 

History

History
86 lines (62 loc) · 2.68 KB

tokens.md

File metadata and controls

86 lines (62 loc) · 2.68 KB

box tokens

Get a token. Returns the service account token by default

box tokens:exchange SCOPE

Get a token. Returns the service account token by default

USAGE
  $ box tokens:exchange SCOPE [--no-color] [-h] [-v] [-q] [-u <value> | -t <value>] [--file-id <value> | --folder-id
    <value>]

ARGUMENTS
  SCOPE  The scope(s) for the new token, separated by a comma if multiple are present

FLAGS
  -h, --help               Show CLI help
  -q, --quiet              Suppress any non-error output to stderr
  -t, --token=<value>      Specify the token to exchange
  -u, --user-id=<value>    Get a user token from a user ID
  -v, --verbose            Show verbose output, which can be helpful for debugging
      --file-id=<value>    Scope the token to a specific file
      --folder-id=<value>  Scope the token to a specific folder
      --no-color           Turn off colors for logging

DESCRIPTION
  Get a token. Returns the service account token by default

See code: src/commands/tokens/exchange.js

box tokens:get

Generate a new access token. Returns a service account token for the default environment unless --user-id is specified.

USAGE
  $ box tokens:get [--no-color] [-h] [-v] [-q] [-u <value>]

FLAGS
  -h, --help             Show CLI help
  -q, --quiet            Suppress any non-error output to stderr
  -u, --user-id=<value>  Generate a user token for the specified user ID
  -v, --verbose          Show verbose output, which can be helpful for debugging
      --no-color         Turn off colors for logging

DESCRIPTION
  Generate a new access token. Returns a service account token for the default environment unless --user-id is
  specified.

EXAMPLES
  $ box tokens:get

  $ box tokens:get --user-id 12345

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

box tokens:revoke TOKEN

Revoke a token. The token will no longer be valid for making API calls.

USAGE
  $ box tokens:revoke TOKEN [--no-color] [-h] [-v] [-q]

ARGUMENTS
  TOKEN  The token to revoke

FLAGS
  -h, --help      Show CLI help
  -q, --quiet     Suppress any non-error output to stderr
  -v, --verbose   Show verbose output, which can be helpful for debugging
      --no-color  Turn off colors for logging

DESCRIPTION
  Revoke a token.  The token will no longer be valid for making API calls.

See code: src/commands/tokens/revoke.js