Skip to content

commercelayer/commercelayer-cli-plugin-token

Repository files navigation

commercelayer-cli-plugin-token

oclif Version Downloads/week License

Usage

commercelayer COMMAND

commercelayer [COMMAND] (--help | -h) for detailed information about plugin commands.

Commands

commercelayer token:assertion

Generate an assertion to be used with the jwt bearer flow.

USAGE
  $ commercelayer token:assertion -o <value> [-t Customer|User] [-c | -u] [-C <value>...] [-j]

FLAGS
  -C, --custom=<value>...  custom claim attribute [key=value]
  -c, --customer           owner of type 'Customer'
  -j, --json               print assertion in json format
  -o, --ownerId=<value>    (required) the owner id
  -t, --type=<option>      the type of the owner
                           <options: Customer|User>
  -u, --user               owner of type 'User'

DESCRIPTION
  generate an assertion to be used with the jwt bearer flow

EXAMPLES
  cl token:assertion -t <Customer|User> -o <ownerId>

  cl token:assertion -co <ownerId> -j

  cl token:assertion -to <ownerId> -C key1=value1 -C key2=value2 key3=value3

See code: src/commands/token/assertion.ts

commercelayer token:decode TOKEN

Decode a Commerce Layer access token.

USAGE
  $ commercelayer token:decode TOKEN [-f]

ARGUMENTS
  TOKEN  the access token to be decoded

FLAGS
  -f, --full  show the full token info

DESCRIPTION
  decode a Commerce Layer access token

ALIASES
  $ commercelayer token:info

EXAMPLES
  $ commercelayer token:decode <accessToken>

  $ cl token:info <accessToken> -f

See code: src/commands/token/decode.ts

commercelayer token:get

Get a new access token.

USAGE
  $ commercelayer token:get [-o <value>] (-s <value> -i <value>) [-S <value>... ] [--info] [-a <value> | [-e
    <value> -p <value>] | ]

FLAGS
  -S, --scope=<value>...      access token scope (market, stock location)
  -a, --assertion=<value>     use jwt assertion
  -e, --email=<value>         customer email
  -i, --clientId=<value>      (required) application client_id
  -o, --organization=<value>  the slug of your organization
  -p, --password=<value>      customer secret password
  -s, --clientSecret=<value>  application client_secret
      --info                  show access token info

DESCRIPTION
  get a new access token

EXAMPLES
  $ commercelayer token:get -o <organizationSlug> -i <clientId> -s <clientSecret>

  $ cl token:get -o <organizationSlug> -i <clientId> -S <scope> --info

  $ cl token:get -i <clientId> -s <clientSecret> -a <jwtAssertion>

See code: src/commands/token/get.ts

commercelayer token:revoke TOKEN

Revoke a Commerce Layer access token.

USAGE
  $ commercelayer token:revoke TOKEN [-o <value>] (-s <value> -i <value>) [-S <value>... ]

ARGUMENTS
  TOKEN  access token to revoke

FLAGS
  -S, --scope=<value>...      access token scope
  -i, --clientId=<value>      (required) application client_id
  -o, --organization=<value>  the slug of your organization
  -s, --clientSecret=<value>  application client_secret

DESCRIPTION
  revoke a Commerce Layer access token

EXAMPLES
  $ commercelayer token:revoke -o <organizationSlug> <accessToken> -i <clientId>

  $ cl token:revoke -o <organizationSlug> <accessToken> -i <clientId> -s <clientSecret>

See code: src/commands/token/revoke.ts