@heroku-cli/plugin-applink

Heroku AppLink plugin


- @heroku-cli/plugin-applink
- Usage
- Commands

Usage

``sh-session
$ heroku plugins:install @heroku-cli/plugin-applink
$ heroku applink:COMMAND
running command...
$ heroku applink --help [COMMAND]
USAGE
$ heroku applink:COMMAND
...
`

Commands

- heroku applink:authorizations
- heroku applink:authorizations:info DEVELOPER_NAME
- heroku applink:connections
- heroku applink:connections:info CONNECTION_NAME
- heroku datacloud:authorizations:add DEVELOPER_NAME
- heroku datacloud:authorizations:jwt:add DEVELOPER_NAME
- heroku datacloud:authorizations:remove DEVELOPER_NAME
- heroku datacloud:connect CONNECTION_NAME
- heroku datacloud:data-action-target:create LABEL
- heroku datacloud:disconnect CONNECTION_NAME
- heroku salesforce:authorizations:add DEVELOPER_NAME
- heroku salesforce:authorizations:jwt:add DEVELOPER_NAME
- heroku salesforce:authorizations:remove DEVELOPER_NAME
- heroku salesforce:connect CONNECTION_NAME
- heroku salesforce:connect:jwt CONNECTION_NAME
- heroku salesforce:disconnect CONNECTION_NAME
- heroku salesforce:publications
- heroku salesforce:publish API_SPEC_FILE_DIR

heroku applink:authorizations

list Heroku AppLink authorized users

`
USAGE
$ heroku applink:authorizations -a [--addon ] [-r ]

FLAGS
-a, --app= (required) app to run command against
-r, --remote= git remote of app to use
--addon= unique name or ID of an AppLink add-on

DESCRIPTION
list Heroku AppLink authorized users
`

_See code:
src/commands/applink/authorizations/index.ts_

heroku applink:authorizations:info DEVELOPER_NAME

show info for a Heroku AppLink authorized user

`
USAGE
$ heroku applink:authorizations:info DEVELOPER_NAME -a [--addon ] [-r ]

ARGUMENTS
DEVELOPER_NAME developer name of the authorization

FLAGS
-a, --app= (required) app to run command against
-r, --remote= git remote of app to use
--addon= unique name or ID of an AppLink add-on

DESCRIPTION
show info for a Heroku AppLink authorized user
`

_See code:
src/commands/applink/authorizations/info.ts_

heroku applink:connections

list Heroku AppLink connections

`
USAGE
$ heroku applink:connections -a [--addon ] [-r ]

FLAGS
-a, --app= (required) app to run command against
-r, --remote= git remote of app to use
--addon= unique name or ID of an AppLink add-on

DESCRIPTION
list Heroku AppLink connections
`

_See code:
src/commands/applink/connections/index.ts_

heroku applink:connections:info CONNECTION_NAME

show info for a Heroku AppLink connection

`
USAGE
$ heroku applink:connections:info CONNECTION_NAME -a [--addon ] [-r ]

ARGUMENTS
CONNECTION_NAME name of the connected org

FLAGS
-a, --app= (required) app to run command against
-r, --remote= git remote of app to use
--addon= unique name or ID of an AppLink add-on

DESCRIPTION
show info for a Heroku AppLink connection
`

_See code:
src/commands/applink/connections/info.ts_

heroku datacloud:authorizations:add DEVELOPER_NAME

store a user's credentials for connecting a Data Cloud org to a Heroku app

`
USAGE
$ heroku datacloud:authorizations:add DEVELOPER_NAME -a [--addon ] [--browser ] [-l ] [-r
]

ARGUMENTS
DEVELOPER_NAME unique developer name for the authorization. Must begin with a letter, end with a letter or a number,
and between 3-30 characters. Only alphanumeric characters and non-consecutive underscores ('_') are
allowed.

FLAGS
-a, --app= (required) app to run command against
-l, --login-url= Salesforce login URL
-r, --remote= git remote of app to use
--addon= unique name or ID of an AppLink add-on
--browser= browser to open OAuth flow with (example: "firefox", "safari")

DESCRIPTION
store a user's credentials for connecting a Data Cloud org to a Heroku app
`

_See code:
src/commands/datacloud/authorizations/add.ts_

heroku datacloud:authorizations:jwt:add DEVELOPER_NAME

store a user’s credentials for connecting a Data Cloud org to a Heroku app using
a JWT auth token

`
USAGE
$ heroku datacloud:authorizations:jwt:add DEVELOPER_NAME -a --client-id --jwt-key-file --username
[--addon ] [-l ] [-r ] [--alias ]

ARGUMENTS
DEVELOPER_NAME unique developer name for the authorization. Must begin with a letter, end with a letter or a number,
and between 3-30 characters. Only alphanumeric characters and non-consecutive underscores ('_') are
allowed.

FLAGS
-a, --app= (required) app to run command against
-l, --login-url= Salesforce login URL
-r, --remote= git remote of app to use
--addon= unique name or ID of an AppLink add-on
--alias= [default: applink:{developer_name}] alias for authorization to retrieve credentials via
SDK
--client-id= (required) ID of consumer key from your connected app
--jwt-key-file= (required) path to file containing RSA private key in PEM format to authorize with
--username= (required) Salesforce username authorized for the connected app

DESCRIPTION
store a user’s credentials for connecting a Data Cloud org to a Heroku app using a JWT auth token

EXAMPLES
$ heroku datacloud:authorizations:jwt:add my-auth \
--app my-app \
--client-id 3MVG9...NM0ZqZc9aT \
--jwt-key-file server.key \
--username api.user@mycompany.com

$ heroku datacloud:authorizations:jwt:add my-sandbox-auth \
--app my-app \
--client-id 3MVG9...NM0ZqZc9aT \
--jwt-key-file server.key \
--username api.user@mycompany.com \
--login-url https://test.salesforce.com

$ heroku datacloud:authorizations:jwt:add my-auth \
--app my-app \
--client-id 3MVG9...NM0ZqZc9aT \
--jwt-key-file server.key \
--username api.user@mycompany.com \
--alias custom-alias
`

_See code:
src/commands/datacloud/authorizations/jwt/add.ts_

heroku datacloud:authorizations:remove DEVELOPER_NAME

remove a Data Cloud authorization from a Heroku app

`
USAGE
$ heroku datacloud:authorizations:remove DEVELOPER_NAME -a [--addon ] [-c ] [-r ]

ARGUMENTS
DEVELOPER_NAME developer name of the Data Cloud authorization

FLAGS
-a, --app= (required) app to run command against
-c, --confirm= set to developer name to bypass confirm prompt
-r, --remote= git remote of app to use
--addon= unique name or ID of an AppLink add-on

DESCRIPTION
remove a Data Cloud authorization from a Heroku app
`

_See code:
src/commands/datacloud/authorizations/remove.ts_

heroku datacloud:connect CONNECTION_NAME

connect a Data Cloud org to a Heroku app

`
USAGE
$ heroku datacloud:connect CONNECTION_NAME -a [--addon ] [--browser ] [-l ] [-r ]

ARGUMENTS
CONNECTION_NAME name for the Data Cloud connection. Must begin with a letter, end with a letter or a number, and
between 3-30 characters. Only alphanumeric characters and non-consecutive underscores ('_') are
allowed.

FLAGS
-a, --app= (required) app to run command against
-l, --login-url= Salesforce login URL
-r, --remote= git remote of app to use
--addon= unique name or ID of an AppLink add-on
--browser= browser to open OAuth flow with (example: "firefox", "safari")

DESCRIPTION
connect a Data Cloud org to a Heroku app
`

_See code:
src/commands/datacloud/connect.ts_

heroku datacloud:data-action-target:create LABEL

create a Data Cloud data action target for a Heroku app

`
USAGE
$ heroku datacloud:data-action-target:create LABEL -a -o -p [--addon ] [-n ] [-t webhook] [-r
]

ARGUMENTS
LABEL label for the data action target. Must begin with a letter, end with a letter or a number, and between 3-30
characters. Only alphanumeric characters and non-consecutive underscores ('_') are allowed.

FLAGS
-a, --app= (required) app to run command against
-n, --api-name= [default: ] API name for the data action target
-o, --connection-name= (required) Data Cloud connection name to create the data action target
-p, --target-api-path= (required) API path for the data action target excluding app URL, eg "/" or
"/handleDataCloudDataChangeEvent"
-r, --remote= git remote of app to use
-t, --type= [default: webhook] Data action target type

--addon= unique name or ID of an AppLink add-on

DESCRIPTION
create a Data Cloud data action target for a Heroku app
`

_See code:
src/commands/datacloud/data-action-target/create.ts_

heroku datacloud:disconnect CONNECTION_NAME

disconnect a Data Cloud org from a Heroku app

`
USAGE
$ heroku datacloud:disconnect CONNECTION_NAME -a [--addon ] [-c ] [-r ]

ARGUMENTS
CONNECTION_NAME name of the Data Cloud connection

FLAGS
-a, --app= (required) app to run command against
-c, --confirm= set to Data Cloud org connection name to bypass confirm prompt
-r, --remote= git remote of app to use
--addon= unique name or ID of an AppLink add-on

DESCRIPTION
disconnect a Data Cloud org from a Heroku app
`

_See code:
src/commands/datacloud/disconnect.ts_

heroku salesforce:authorizations:add DEVELOPER_NAME

store a user's credentials for connecting a Salesforce org to a Heroku app

`
USAGE
$ heroku salesforce:authorizations:add DEVELOPER_NAME -a [--addon ] [--browser ] [-l ]
[-r ]

ARGUMENTS
DEVELOPER_NAME unique developer name for the authorization. Must begin with a letter, end with a letter or a number,
and between 3-30 characters. Only alphanumeric characters and non-consecutive underscores ('_') are
allowed.

FLAGS
-a, --app= (required) app to run command against
-l, --login-url= Salesforce login URL
-r, --remote= git remote of app to use
--addon= unique name or ID of an AppLink add-on
--browser= browser to open OAuth flow with (example: "firefox", "safari")

DESCRIPTION
store a user's credentials for connecting a Salesforce org to a Heroku app
`

_See code:
src/commands/salesforce/authorizations/add.ts_

heroku salesforce:authorizations:jwt:add DEVELOPER_NAME

store a user’s credentials for connecting a Salesforce org to a Heroku app using
a JWT auth token

`
USAGE
$ heroku salesforce:authorizations:jwt:add DEVELOPER_NAME -a --client-id --jwt-key-file --username
[--addon ] [-l ] [-r ] [--alias ]

ARGUMENTS
DEVELOPER_NAME unique developer name for the authorization. Must begin with a letter, end with a letter or a number,
and between 3-30 characters. Only alphanumeric characters and non-consecutive underscores ('_') are
allowed.

FLAGS
-a, --app= (required) app to run command against
-l, --login-url= Salesforce login URL
-r, --remote= git remote of app to use
--addon= unique name or ID of an AppLink add-on
--alias= [default: applink:{developer_name}] alias for authorization to retrieve credentials via
SDK
--client-id= (required) ID of consumer key from your connected app
--jwt-key-file= (required) path to file containing RSA private key in PEM format to authorize with
--username= (required) Salesforce username authorized for the connected app

DESCRIPTION
store a user’s credentials for connecting a Salesforce org to a Heroku app using a JWT auth token

EXAMPLES
$ heroku salesforce:authorizations:jwt:add my-auth \
--app my-app \
--client-id 3MVG9...NM0ZqZc9aT \
--jwt-key-file server.key \
--username api.user@mycompany.com

$ heroku salesforce:authorizations:jwt:add my-sandbox-auth \
--app my-app \
--client-id 3MVG9...NM0ZqZc9aT \
--jwt-key-file server.key \
--username api.user@mycompany.com \
--login-url https://test.salesforce.com

$ heroku salesforce:authorizations:jwt:add my-auth \
--app my-app \
--client-id 3MVG9...NM0ZqZc9aT \
--jwt-key-file server.key \
--username api.user@mycompany.com \
--alias custom-alias
`

_See code:
src/commands/salesforce/authorizations/jwt/add.ts_

heroku salesforce:authorizations:remove DEVELOPER_NAME

remove a Salesforce authorization from a Heroku app

`
USAGE
$ heroku salesforce:authorizations:remove DEVELOPER_NAME -a [--addon ] [-c ] [-r ]

ARGUMENTS
DEVELOPER_NAME developer name of the Salesforce authorization

FLAGS
-a, --app= (required) app to run command against
-c, --confirm= set to developer name to bypass confirm prompt
-r, --remote= git remote of app to use
--addon= unique name or ID of an AppLink add-on

DESCRIPTION
remove a Salesforce authorization from a Heroku app
`

_See code:
src/commands/salesforce/authorizations/remove.ts_

heroku salesforce:connect CONNECTION_NAME

connect a Salesforce org to a Heroku app

`
USAGE
$ heroku salesforce:connect CONNECTION_NAME -a [--addon ] [--browser ] [-l ] [-r ]

ARGUMENTS
CONNECTION_NAME name for the Salesforce connection. Must begin with a letter, end with a letter or a number, and be
between 3-30 characters. Only alphanumeric characters and non-consecutive underscores ('_') are
allowed.

FLAGS
-a, --app= (required) app to run command against
-l, --login-url= login URL
-r, --remote= git remote of app to use
--addon= unique name or ID of an AppLink add-on
--browser= browser to open OAuth flow with (example: "firefox", "safari")

DESCRIPTION
connect a Salesforce org to a Heroku app
`

_See code:
src/commands/salesforce/connect/index.ts_

heroku salesforce:connect:jwt CONNECTION_NAME

connect a Salesforce org to Heroku app using a JWT auth token

`
USAGE
$ heroku salesforce:connect:jwt CONNECTION_NAME -a --client-id --jwt-key-file --username
[--addon ] [-l ] [-r ]

ARGUMENTS
CONNECTION_NAME name for the Salesforce connection. Must begin with a letter, end with a letter or a number, and be
between 3-30 characters. Only alphanumeric characters and non-consecutive underscores ('_') are
allowed.

FLAGS
-a, --app= (required) app to run command against
-l, --login-url= Salesforce login URL
-r, --remote= git remote of app to use
--addon= unique name or ID of an AppLink add-on
--client-id= (required) ID of consumer key
--jwt-key-file= (required) path to file containing private key to authorize with
--username= (required) Salesforce username

DESCRIPTION
connect a Salesforce org to Heroku app using a JWT auth token
`

_See code:
src/commands/salesforce/connect/jwt.ts_

heroku salesforce:disconnect CONNECTION_NAME

disconnect a Salesforce org from a Heroku app

`
USAGE
$ heroku salesforce:disconnect CONNECTION_NAME -a [--addon ] [-c ] [-r ]

ARGUMENTS
CONNECTION_NAME name of the Salesforce connection you would like to disconnect

FLAGS
-a, --app= (required) app to run command against
-c, --confirm= set to Salesforce connection name to bypass confirm prompt
-r, --remote= git remote of app to use
--addon= unique name or ID of an AppLink add-on

DESCRIPTION
disconnect a Salesforce org from a Heroku app
`

_See code:
src/commands/salesforce/disconnect.ts_

heroku salesforce:publications

list Salesforce orgs the app is published to

`
USAGE
$ heroku salesforce:publications -a [--addon ] [--connection_name ] [-r ]

FLAGS
-a, --app= (required) app to run command against
-r, --remote= git remote of app to use
--addon= unique name or ID of an AppLink add-on
--connection_name= name of the Salesforce connection

DESCRIPTION
list Salesforce orgs the app is published to
`

_See code:
src/commands/salesforce/publications.ts_

heroku salesforce:publish API_SPEC_FILE_DIR

publish an app's API specification to an authenticated Salesforce org

`
USAGE
$ heroku salesforce:publish API_SPEC_FILE_DIR -a -c --connection-name [--addon ]
[--authorization-connected-app-name ] [--authorization-permission-set-name ] [--metadata-dir ]
[-r ]

ARGUMENTS
API_SPEC_FILE_DIR path to OpenAPI 3.x spec file (JSON or YAML format)

FLAGS
-a, --app= (required) app to run command against
-c, --client-name= (required) name given to the client stub
-r, --remote= git remote of app to use
--addon= unique name or ID of an AppLink add-on
--authorization-connected-app-name= name of connected app to create from our template
--authorization-permission-set-name= name of permission set to create from our template
--connection-name= (required) authenticated Salesforce connection name
--metadata-dir= directory containing connected app, permission set, or API spec

DESCRIPTION
publish an app's API specification to an authenticated Salesforce org
``

_See code:
src/commands/salesforce/publish.ts_