An open API service indexing awesome lists of open source software.

https://github.com/commercelayer/commercelayer-cli-plugin-token


https://github.com/commercelayer/commercelayer-cli-plugin-token

commercelayer

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          

# commercelayer-cli-plugin-token

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/@commercelayer/cli-plugin-token.svg)](https://npmjs.org/package/commercelayer-cli-plugin-token)
[![Downloads/week](https://img.shields.io/npm/dw/@commercelayer/cli-plugin-token.svg)](https://npmjs.org/package/@commercelayer-/li-plugin-token)
[![License](https://img.shields.io/npm/l/@commercelayer/cli-plugin-token.svg)](https://github.com/pviti/@commercelayer/cli-plugin-token/blob/master/package.json)

* [Usage](#usage)
* [Commands](#commands)

## Usage

```sh-session
commercelayer COMMAND

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

## Commands

* [`commercelayer token:assertion`](#commercelayer-tokenassertion)
* [`commercelayer token:decode TOKEN`](#commercelayer-tokendecode-token)
* [`commercelayer token:get`](#commercelayer-tokenget)
* [`commercelayer token:revoke TOKEN`](#commercelayer-tokenrevoke-token)

### `commercelayer token:assertion`

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

```sh-session
USAGE
$ commercelayer token:assertion -o [-t Customer|User] [-c | -u] [-C ...] [-j]

FLAGS
-C, --custom=... custom claim attribute [key=value]
-c, --customer owner of type 'Customer'
-j, --json print assertion in json format
-o, --ownerId= (required) the owner id
-t, --type= the type of the owner

-u, --user owner of type 'User'

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

EXAMPLES
cl token:assertion -t -o

cl token:assertion -co -j

cl token:assertion -to -C key1=value1 -C key2=value2 key3=value3
```

_See code: [src/commands/token/assertion.ts](https://github.com/commercelayer/commercelayer-cli-plugin-token/blob/main/src/commands/token/assertion.ts)_

### `commercelayer token:decode TOKEN`

Decode a Commerce Layer access token.

```sh-session
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

$ cl token:info -f
```

_See code: [src/commands/token/decode.ts](https://github.com/commercelayer/commercelayer-cli-plugin-token/blob/main/src/commands/token/decode.ts)_

### `commercelayer token:get`

Get a new access token.

```sh-session
USAGE
$ commercelayer token:get [-o ] (-s -i ) [-S ... ] [--info] [-a | [-e
-p ] | ]

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

DESCRIPTION
get a new access token

EXAMPLES
$ commercelayer token:get -o -i -s

$ cl token:get -o -i -S --info

$ cl token:get -i -s -a
```

_See code: [src/commands/token/get.ts](https://github.com/commercelayer/commercelayer-cli-plugin-token/blob/main/src/commands/token/get.ts)_

### `commercelayer token:revoke TOKEN`

Revoke a Commerce Layer access token.

```sh-session
USAGE
$ commercelayer token:revoke TOKEN [-o ] (-s -i ) [-S ... ]

ARGUMENTS
TOKEN access token to revoke

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

DESCRIPTION
revoke a Commerce Layer access token

EXAMPLES
$ commercelayer token:revoke -o -i

$ cl token:revoke -o -i -s
```

_See code: [src/commands/token/revoke.ts](https://github.com/commercelayer/commercelayer-cli-plugin-token/blob/main/src/commands/token/revoke.ts)_