Skip to content

Latest commit

 

History

History
157 lines (106 loc) · 3.52 KB

clients.md

File metadata and controls

157 lines (106 loc) · 3.52 KB

heroku clients

OAuth clients on the platform

heroku clients

list your OAuth clients

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

FLAGS
  -j, --json  output in json format

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

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

ARGUMENTS
  NAME          name of the OAuth client
  REDIRECT_URI  redirect URL of the OAuth client

FLAGS
  -j, --json   output in json format
  -s, --shell  output in shell format

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

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

ARGUMENTS
  ID  ID of the OAuth client

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

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

ARGUMENTS
  ID  ID of the OAuth client

FLAGS
  -j, --json   output in json format
  -s, --shell  output in shell format

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

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

ARGUMENTS
  ID  ID of the OAuth client

FLAGS
  -j, --json   output in json format
  -s, --shell  output in shell format

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

DESCRIPTION
  rotate OAuth client secret

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

heroku clients:update ID

update OAuth client

USAGE
  $ heroku clients:update ID [--prompt] [-n <value>] [--url <value>]

ARGUMENTS
  ID  ID of the OAuth client

FLAGS
  -n, --name=<value>  change the client name
      --url=<value>   change the client redirect URL

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

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