Skip to content

authorizations.md

Latest commit

 

History

History
180 lines (122 loc) · 4.28 KB

authorizations.md

File metadata and controls

180 lines (122 loc) · 4.28 KB

heroku authorizations

OAuth authorizations

heroku authorizations

list OAuth authorizations

USAGE
  $ heroku authorizations [--prompt] [-j]

FLAGS
  -j, --json  output in json format

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

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 [--prompt] [-d <value>] [-e <value>] [-j] [-s <value>] [-S]

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

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  create a new OAuth authorization

EXAMPLES
   $ heroku authorizations:create --description "For use with Anvil"

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

heroku authorizations:destroy ID

revoke OAuth authorization

USAGE
  $ heroku authorizations:destroy ID [--prompt]

ARGUMENTS
  ID  ID of the authorization

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  revoke OAuth authorization

ALIASES
  $ heroku authorizations:destroy

EXAMPLES
   $ heroku authorizations:revoke 105a7bfa-34c3-476e-873a-b1ac3fdc12fb

heroku authorizations:info ID

show an existing OAuth authorization

USAGE
  $ heroku authorizations:info ID [--prompt] [-j]

ARGUMENTS
  ID  ID of the authorization

FLAGS
  -j, --json  output in json format

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

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 [--prompt]

ARGUMENTS
  ID  ID of the authorization

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  revoke OAuth authorization

ALIASES
  $ heroku authorizations:destroy

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 [--prompt]

ARGUMENTS
  ID  ID of the authorization

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

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 [--prompt] [-d <value>] [--client-id <value> --client-secret <value>]

ARGUMENTS
  ID  ID of the authorization

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

GLOBAL FLAGS
  --prompt  interactively prompt for command arguments and flags

DESCRIPTION
  updates an OAuth authorization

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