Nibbling Perfect Macaroni

    @heroku-cli/plugin-oauth
    TypeScript icon, indicating that this package has built-in type declarations

    7.60.0 • Public • Published

    oauth

    Command line plugin for managing OAuth clients, authorizations and tokens.

    oclif Version Downloads/week License

    Usage

    $ npm install -g @heroku-cli/plugin-oauth
    $ heroku COMMAND
    running command...
    $ heroku (-v|--version|version)
    @heroku-cli/plugin-oauth/7.60.0 darwin-x64 node-v14.18.2
    $ heroku --help [COMMAND]
    USAGE
      $ heroku COMMAND
    ...

    Commands

    heroku authorizations

    list OAuth authorizations

    USAGE
      $ heroku authorizations
    
    OPTIONS
      -j, --json  output in json format
    
    EXAMPLE
      $ heroku authorizations
    

    See code: src/commands/authorizations/index.ts

    heroku authorizations:create

    create a new OAuth authorization

    USAGE
      $ heroku authorizations:create
    
    OPTIONS
      -S, --short                    only output token
      -d, --description=description  set a custom authorization
      -e, --expires-in=expires-in    set expiration in seconds (default no expiration)
      -j, --json                     output in json format
      -s, --scope=scope              set custom OAuth scopes
    
    EXAMPLE
      $ 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
    
    OPTIONS
      -j, --json  output in json format
    

    See code: src/commands/authorizations/info.ts

    heroku authorizations:revoke ID

    revoke OAuth authorization

    USAGE
      $ heroku authorizations:revoke ID
    
    EXAMPLE
      $ 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
    

    See code: src/commands/authorizations/rotate.ts

    heroku authorizations:update ID

    updates an OAuth authorization

    USAGE
      $ heroku authorizations:update ID
    
    OPTIONS
      -d, --description=description  set a custom authorization description
      --client-id=client-id          identifier of OAuth client to set
      --client-secret=client-secret  secret of OAuth client to set
    

    See code: src/commands/authorizations/update.ts

    heroku clients

    list your OAuth clients

    USAGE
      $ heroku clients
    
    OPTIONS
      -j, --json  output in json format
    

    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
    
    OPTIONS
      -j, --json   output in json format
      -s, --shell  output in shell format
    
    EXAMPLE
      $ 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
    

    See code: src/commands/clients/destroy.ts

    heroku clients:info ID

    show details of an oauth client

    USAGE
      $ heroku clients:info ID
    
    OPTIONS
      -j, --json   output in json format
      -s, --shell  output in shell format
    
    EXAMPLE
      $ 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
    
    OPTIONS
      -j, --json   output in json format
      -s, --shell  output in shell format
    

    See code: src/commands/clients/rotate.ts

    heroku clients:update ID

    update OAuth client

    USAGE
      $ heroku clients:update ID
    
    OPTIONS
      -n, --name=name  change the client name
      --url=url        change the client redirect URL
    
    EXAMPLE
      $ 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 help [COMMAND]

    display help for heroku

    USAGE
      $ heroku help [COMMAND]
    
    ARGUMENTS
      COMMAND  command to show help for
    
    OPTIONS
      --all  see all commands in CLI
    

    See code: @oclif/plugin-help

    heroku sessions

    list your OAuth sessions

    USAGE
      $ heroku sessions
    
    OPTIONS
      -j, --json  output in json format
    

    See code: src/commands/sessions/index.ts

    heroku sessions:destroy ID

    delete (logout) OAuth session by ID

    USAGE
      $ heroku sessions:destroy ID
    

    See code: src/commands/sessions/destroy.ts

    Keywords

    Install

    npm i @heroku-cli/plugin-oauth

    DownloadsWeekly Downloads

    557

    Version

    7.60.0

    License

    MIT

    Unpacked Size

    41 kB

    Total Files

    43

    Last publish

    Collaborators

    • hone
    • codefinger
    • joshwlewis
    • elbandito
    • smuppavarapu
    • rasphilco
    • mimen
    • tevanoff
    • chadian
    • pnance
    • snaragoni
    • code0100fun
    • udeb
    • stelang
    • macapplechic
    • mrmicahcooper
    • pallavi.rao
    • bmukund
    • harish.457
    • kristinfoss
    • rhys-sdfc
    • ntonollier
    • aoriada
    • kirkchung
    • animje
    • svelivela
    • vrustagi
    • kmendu