https://github.com/twilio-labs/plugin-token
Twilio CLI plugin for generating access tokens for Twilio Chat, Video, etc.
https://github.com/twilio-labs/plugin-token
twilio twilio-chat twilio-cli
Last synced: 8 months ago
JSON representation
Twilio CLI plugin for generating access tokens for Twilio Chat, Video, etc.
- Host: GitHub
- URL: https://github.com/twilio-labs/plugin-token
- Owner: twilio-labs
- License: mit
- Created: 2019-07-24T21:24:37.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2025-04-09T15:35:04.000Z (about 1 year ago)
- Last Synced: 2025-05-07T14:57:52.595Z (about 1 year ago)
- Topics: twilio, twilio-chat, twilio-cli
- Language: JavaScript
- Size: 902 KB
- Stars: 6
- Watchers: 1
- Forks: 15
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
@twilio/plugin-token
========================
Generate a temporary token for use in a Twilio client-side SDK application
* [Requirements](#requirements)
* [Usage](#usage)
* [Commands](#commands)
* [ Contributing](#-contributing)
* [License](#license)
# Requirements
## Setup
Head over to the [twilio-cli documentation](https://www.twilio.com/docs/twilio-cli/quickstart).
# Usage
```sh-session
$ twilio plugins:install @twilio-labs/plugin-token
$ twilio --help token
USAGE
$ twilio token
...
```
# Commands
* [`twilio token:capability:client`](#twilio-tokencapabilityclient)
* [`twilio token:capability:worker`](#twilio-tokencapabilityworker)
* [`twilio token:chat`](#twilio-tokenchat)
* [`twilio token:flex`](#twilio-tokenflex)
* [`twilio token:sync`](#twilio-tokensync)
* [`twilio token:video`](#twilio-tokenvideo)
* [`twilio token:voice`](#twilio-tokenvoice)
## `twilio token:capability:client`
```
USAGE
$ twilio token:capability:client --voice-app-sid --identity [-l (debug|info|warn|error|none)] [-o
(columns|json|tsv|none)] [--silent] [-p ] [--allow-incoming true|false] [--push-credential-sid ]
[--ttl ]
FLAGS
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-p, --profile= Shorthand identifier for your profile.
--allow-incoming= [default: true] Allow incoming calls (true/false) (defaults to true)
--identity= (required) The user identity
--push-credential-sid= The Push Credential SID for receiving incoming call push notifications, starts with
CRXXX
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--ttl= Optional TTL for token (up to 24 hours) (value in seconds)
--voice-app-sid= (required) The TwiML Application SID for outbound calls, starts with APXXX
```
_See code: [src/commands/token/capability/client.js](https://github.com/twilio-labs/plugin-token/blob/v6.0.0/src/commands/token/capability/client.js)_
## `twilio token:capability:worker`
```
USAGE
$ twilio token:capability:worker --worker-sid --workspace-sid [-l (debug|info|warn|error|none)] [-o
(columns|json|tsv|none)] [--silent] [-p ] [--ttl ]
FLAGS
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-p, --profile= Shorthand identifier for your profile.
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--ttl= Optional TTL for token (up to 24 hours) (value in seconds)
--worker-sid= (required) The Worker SID for this token
--workspace-sid= (required) The Workspace SID for this token
```
_See code: [src/commands/token/capability/worker.js](https://github.com/twilio-labs/plugin-token/blob/v6.0.0/src/commands/token/capability/worker.js)_
## `twilio token:chat`
```
USAGE
$ twilio token:chat --identity --chat-service-sid [-l (debug|info|warn|error|none)] [-o
(columns|json|tsv|none)] [--silent] [-p ] [--ttl ]
FLAGS
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-p, --profile= Shorthand identifier for your profile.
--chat-service-sid= (required) The service SID for the Chat, starts with ISXXX
--identity= (required) The user identity
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--ttl= Optional TTL for token (up to 24 hours) (value in seconds)
```
_See code: [src/commands/token/chat.js](https://github.com/twilio-labs/plugin-token/blob/v6.0.0/src/commands/token/chat.js)_
## `twilio token:flex`
```
USAGE
$ twilio token:flex --worker-sid --workspace-sid [-l (debug|info|warn|error|none)] [-o
(columns|json|tsv|none)] [--silent] [-p ] [--ttl ]
FLAGS
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-p, --profile= Shorthand identifier for your profile.
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--ttl= Optional TTL for token (up to 24 hours) (value in seconds)
--worker-sid= (required) The Worker SID for this token
--workspace-sid= (required) The Workspace SID for this token
```
_See code: [src/commands/token/flex.js](https://github.com/twilio-labs/plugin-token/blob/v6.0.0/src/commands/token/flex.js)_
## `twilio token:sync`
```
USAGE
$ twilio token:sync --identity --sync-service-sid [-l (debug|info|warn|error|none)] [-o
(columns|json|tsv|none)] [--silent] [-p ] [--ttl ]
FLAGS
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-p, --profile= Shorthand identifier for your profile.
--identity= (required) The user identity
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--sync-service-sid= (required) The service SID for the Sync, starts with ISXXX
--ttl= Optional TTL for token (up to 24 hours) (value in seconds)
```
_See code: [src/commands/token/sync.js](https://github.com/twilio-labs/plugin-token/blob/v6.0.0/src/commands/token/sync.js)_
## `twilio token:video`
```
USAGE
$ twilio token:video --identity [-l (debug|info|warn|error|none)] [-o (columns|json|tsv|none)]
[--silent] [-p ] [--room-name ] [--ttl ]
FLAGS
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-p, --profile= Shorthand identifier for your profile.
--identity= (required) The user identity
--room-name= The name of the room this token grants access to
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--ttl= Optional TTL for token (up to 24 hours) (value in seconds)
```
_See code: [src/commands/token/video.js](https://github.com/twilio-labs/plugin-token/blob/v6.0.0/src/commands/token/video.js)_
## `twilio token:voice`
```
USAGE
$ twilio token:voice --voice-app-sid --identity [-l (debug|info|warn|error|none)] [-o
(columns|json|tsv|none)] [--silent] [-p ] [--allow-incoming true|false] [--push-credential-sid ]
[--ttl ]
FLAGS
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-p, --profile= Shorthand identifier for your profile.
--allow-incoming= [default: true] Allow incoming calls (true/false) (defaults to true)
--identity= (required) The user identity
--push-credential-sid= The Push Credential SID for receiving incoming call push notifications, starts with
CRXXX
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--ttl= Optional TTL for token (up to 24 hours) (value in seconds)
--voice-app-sid= (required) The TwiML Application SID for outbound calls, starts with APXXX
```
_See code: [src/commands/token/voice.js](https://github.com/twilio-labs/plugin-token/blob/v6.0.0/src/commands/token/voice.js)_
# Contributing
This project welcomes contributions from the community. Please see the [`CONTRIBUTING.md`](CONTRIBUTING.md) file for more details.
## Code of Conduct
Please be aware that this project has a [Code of Conduct](https://github.com/twilio-labs/.github/blob/master/CODE_OF_CONDUCT.md). The tldr; is to just be excellent to each other ❤️
# License
MIT