oauth
Command line plugin for managing OAuth clients, authorizations and tokens.
Usage
$ npm install -g @heroku-cli/plugin-oauth
$ heroku COMMAND
running command...
$ heroku (--version|-v)
@heroku-cli/plugin-oauth/8.1.8 darwin-x64 node-v16.19.0
$ heroku --help [COMMAND]
USAGE
$ heroku COMMAND
...
Commands
heroku authorizations
heroku authorizations:create
heroku authorizations:info ID
heroku authorizations:revoke ID
heroku authorizations:rotate ID
heroku authorizations:update ID
heroku clients
heroku clients:create NAME REDIRECT_URI
heroku clients:destroy ID
heroku clients:info ID
heroku clients:rotate ID
heroku clients:update ID
heroku sessions
heroku sessions:destroy ID
heroku authorizations
list OAuth authorizations
USAGE
$ heroku authorizations [-j]
FLAGS
-j, --json output in json format
DESCRIPTION
list OAuth authorizations
EXAMPLES
$ heroku authorizations
See code: src/commands/authorizations/index.ts
heroku authorizations:create
create a new OAuth authorization
USAGE
$ heroku authorizations:create [-d <value>] [-S] [-j] [-s <value>] [-e <value>]
FLAGS
-S, --short only output token
-d, --description=<value> set a custom authorization
-e, --expires-in=<value> set expiration in seconds (default no expiration)
-j, --json output in json format
-s, --scope=<value> set custom OAuth scopes
DESCRIPTION
create a new OAuth authorization
EXAMPLES
$ heroku authorizations:create --description "For use with Anvil"
See code: src/commands/authorizations/create.ts
heroku authorizations:info ID
show an existing OAuth authorization
USAGE
$ heroku authorizations:info ID [-j]
FLAGS
-j, --json output in json format
DESCRIPTION
show an existing OAuth authorization
See code: src/commands/authorizations/info.ts
heroku authorizations:revoke ID
revoke OAuth authorization
USAGE
$ heroku authorizations:revoke ID
DESCRIPTION
revoke OAuth authorization
EXAMPLES
$ heroku authorizations:revoke 105a7bfa-34c3-476e-873a-b1ac3fdc12fb
See code: src/commands/authorizations/revoke.ts
heroku authorizations:rotate ID
updates an OAuth authorization token
USAGE
$ heroku authorizations:rotate ID
DESCRIPTION
updates an OAuth authorization token
See code: src/commands/authorizations/rotate.ts
heroku authorizations:update ID
updates an OAuth authorization
USAGE
$ heroku authorizations:update ID [-d <value>] [--client-id <value> --client-secret <value>]
FLAGS
-d, --description=<value> set a custom authorization description
--client-id=<value> identifier of OAuth client to set
--client-secret=<value> secret of OAuth client to set
DESCRIPTION
updates an OAuth authorization
See code: src/commands/authorizations/update.ts
heroku clients
list your OAuth clients
USAGE
$ heroku clients [-j]
FLAGS
-j, --json output in json format
DESCRIPTION
list your OAuth clients
See code: src/commands/clients/index.ts
heroku clients:create NAME REDIRECT_URI
create a new OAuth client
USAGE
$ heroku clients:create NAME REDIRECT_URI [-j] [-s]
FLAGS
-j, --json output in json format
-s, --shell output in shell format
DESCRIPTION
create a new OAuth client
EXAMPLES
$ heroku clients:create "Amazing" https://amazing-client.herokuapp.com/auth/heroku/callback
See code: src/commands/clients/create.ts
heroku clients:destroy ID
delete client by ID
USAGE
$ heroku clients:destroy ID
DESCRIPTION
delete client by ID
See code: src/commands/clients/destroy.ts
heroku clients:info ID
show details of an oauth client
USAGE
$ heroku clients:info ID [-j] [-s]
FLAGS
-j, --json output in json format
-s, --shell output in shell format
DESCRIPTION
show details of an oauth client
EXAMPLES
$ heroku clients:info 36120128-fee7-455e-8b7f-807aee130946
See code: src/commands/clients/info.ts
heroku clients:rotate ID
rotate OAuth client secret
USAGE
$ heroku clients:rotate ID [-j] [-s]
FLAGS
-j, --json output in json format
-s, --shell output in shell format
DESCRIPTION
rotate OAuth client secret
See code: src/commands/clients/rotate.ts
heroku clients:update ID
update OAuth client
USAGE
$ heroku clients:update ID [-n <value>] [--url <value>]
FLAGS
-n, --name=<value> change the client name
--url=<value> change the client redirect URL
DESCRIPTION
update OAuth client
EXAMPLES
$ heroku clients:update 3e304bda-d376-4278-bdea-6d6c08aa1359 --url https://amazing-client.herokuapp.com/auth/heroku/callback
See code: src/commands/clients/update.ts
heroku sessions
list your OAuth sessions
USAGE
$ heroku sessions [-j]
FLAGS
-j, --json output in json format
DESCRIPTION
list your OAuth sessions
See code: src/commands/sessions/index.ts
heroku sessions:destroy ID
delete (logout) OAuth session by ID
USAGE
$ heroku sessions:destroy ID
DESCRIPTION
delete (logout) OAuth session by ID
See code: src/commands/sessions/destroy.ts