This repository has been archived by the owner. It is now read-only.
auth core plugin for Heroku CLI
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

@heroku-cli/plugin-auth

auth core plugin for Heroku CLI

Version CircleCI Appveyor CI Codecov Downloads/week License

Commands

heroku auth:2fa

check 2fa status

USAGE
  $ heroku auth:2fa

ALIASES
  $ heroku 2fa
  $ heroku twofactor

See code: src/commands/auth/2fa/index.ts

heroku auth:2fa:disable

disables 2fa on account

USAGE
  $ heroku auth:2fa:disable

ALIASES
  $ heroku twofactor:disable
  $ heroku 2fa:disable

EXAMPLES
  $ heroku auth:2fa:disable
  Disabling 2fa on me@example.com... done

See code: src/commands/auth/2fa/disable.ts

heroku auth:2fa:generate-recovery-codes

generates 2fa recovery codes

USAGE
  $ heroku auth:2fa:generate-recovery-codes

DESCRIPTION
  If you lose access to your two-factor device, e.g. you lose your phone or it is wiped, you can still log in to your 
  account. When prompted for the second factor after entering your account password, choose "Enter a Recovery Code.” You 
  can then enter one of your recovery codes instead of a token from your two-factor device. Note that each recovery code 
  can only be used once.

  Running this command will replace existing codes.

ALIASES
  $ heroku twofactor:generate-recovery-codes
  $ heroku 2fa:generate-recovery-codes
  $ heroku auth:2fa:generate

EXAMPLES
  $ heroku auth:2fa:generate
  Password: ********************
  Recovery codes:
  02799c92ab3ba7c7
  09aea052a72b6a22
  361e00bb82c7cbd4
  588ac05dec23952c
  6020ef9ec364066b
  6cfd923315875e78
  7c576b935eafc452
  8c00eeb258ee565e
  a37c5c6985f56e66
  f82e7c2a50737494

See code: src/commands/auth/2fa/generate-recovery-codes.ts

heroku auth:login

login with your Heroku credentials

USAGE
  $ heroku auth:login

OPTIONS
  -e, --expires-in=expires-in  duration of token in seconds (default 1 year)
  -i, --interactive            login with username/password
  -s, --sso                    login for enterprise users under SSO
  --browser=browser            browser to open SSO with

ALIASES
  $ heroku login

See code: src/commands/auth/login.ts

heroku auth:logout

clears local login credentials and invalidates API session

USAGE
  $ heroku auth:logout

ALIASES
  $ heroku logout

See code: src/commands/auth/logout.ts

heroku auth:token

outputs current CLI authentication token.

USAGE
  $ heroku auth:token

OPTIONS
  -h, --help  show CLI help

DESCRIPTION
  By default, the CLI auth token is only valid for 1 year. To generate a long-lived token, use heroku 
  authorizations:create

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

heroku auth:whoami

display the current logged in user

USAGE
  $ heroku auth:whoami

ALIASES
  $ heroku whoami

See code: src/commands/auth/whoami.ts

heroku labs:disable [FEATURE]

disables an experimental feature

USAGE
  $ heroku labs:disable [FEATURE]

OPTIONS
  -a, --app=app        app to run command against
  -r, --remote=remote  git remote of app to use
  --confirm=confirm

See code: src/commands/labs/disable.ts