Heroku AppLink API

Table of Contents [expand]

バージョンのサポート
認証
リクエストメソッド
共有オブジェクト
接続エンドポイント
承認エンドポイント
公開エンドポイント

この記事の英語版に更新があります。ご覧の翻訳には含まれていない変更点があるかもしれません。

最終更新日 2025年08月28日(木)

Heroku AppLink は、Salesforce 組織と Heroku アプリ間の接続、承認、パブリケーションの作成、管理、監視を自動化する API を提供します。

Heroku AppLink API を操作するには、Heroku AppLink CLI プラグインを使用するのが良い方法です。このプラグインは、Heroku AppLink アドオンとの接続の設定や管理に役立ちます。

バージョンのサポート

Heroku では、Heroku AppLink API のバージョン 1 がサポートされています。Heroku では、互換性ポリシーに従い、API に加えた特定の変更と新しい API バージョンを通知します。

認証

Heroku AppLink API には、Heroku Platform API 直接承認トークンが必要です。このトークンは、アプリの Heroku ユーザー専用です。Heroku AppLink では、他の Heroku ユーザーの代理として API にアクセスすることはサポートされていません。Heroku AppLink CLI プラグインは、デフォルトの Bearer トークン認証スキームを使用して Heroku AppLink API にリクエストを送信します。AppLink API は、各リクエストに関連付けられたアプリとアドオンに対し、ユーザーにアクセス権があるかどうかを判断します。

add‑ons‑sso API スキーマバリアントを指定して Platform API にリクエストを送信し、Add-on SSO Params エンドポイントを取得します。

GET /apps/:app_id/addons/:addon_id/ssoAuthorization: Bearer HRKU-01234567-89ab-cdef-0123-456789abcdefAccept: application/vnd.heroku+json; version=3.add-ons-sso

リクエストメソッド

Heroku AppLink API の大部分は、GET、POST、PATCH、DELETE のいずれかのリクエストに応答します。

共有オブジェクト

組織

このオブジェクトは、Salesforce 組織または Data Cloud 組織を表します。

名前	種類	説明	例
id	文字列	接続された組織の一意の識別子	`00DSG00000DGEIr2AP`
instance_url	文字列	接続された組織のインスタンスの URL	`https://mydomain.my.salesforce.com`
connection_name / developer_name	文字列	接続名 (`connection_name`) または承認名 (`developer_name`)	`productionOrg`
type	文字列	組織の種類次のいずれか:`SalesforceOrg`、`DataCloudOrg`	`SalesforceOrg`
api_version	文字列	組織の API バージョン	`64.0`
user_auth		「ユーザー認証」を参照

ユーザー認証

このオブジェクトは、Salesforce ユーザーの情報を表します。

名前	種類	説明	例
access_token	文字列	承認のアクセストークン	`00DSG00000DGEIr2AP!<token>`
username	文字列	承認のユーザー名	`admin@example.org`
user_id	文字列	承認のユーザー ID	`005...`

接続エンドポイント

これらのエンドポイントを使用して、AppLink 接続の作成、情報取得、管理を行います。

組織に接続する

AppLink アドオンを Salesforce 組織または Data Cloud 組織に接続します。

POST /addons/${addon_uuid}/connections/[salesforce|datacloud]

必須パラメータ

名前	種類	説明	例
addon_uuid	文字列	アドオンの一意識別子または名前	`fe3b4938-3383-4c40-868c-1a5cdc38a358`
connection_name	文字列	接続名	`productionOrg`

任意のパラメータ

名前	種類	説明	例
login_url	文字列	使用する Salesforce ログイン URL デフォルト: `https://login.salesforce.com`	`https://login.salesforce.com`

リクエストの例:

“` POST /addons/fe3b4938-3383-4c40-868c-1a5cdc38a358/connections/salesforce { "connection_name”: “productionOrg”, “login_url”: “https://login.salesforce.com” } “`

応答の属性

名前	種類	説明	例
id	文字列	接続の一意識別子	`a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b`
redirect_uri	文字列	OAuth 完了後にリダイレクトするエンドポイント	`https://login.salesforce.com/services/oauth2/authorize?client_id=3MVG...&redirect_uri=https...`
status	文字列	「接続状況」を参照	`connected`
org	json	「組織」を参照
app_id	文字列	アプリの一意識別子	`a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b`
addon_id	文字列	アドオンの一意識別子	`fe3b4938-3383-4c40-868c-1a5cdc38a358`
created_at	日付	接続が作成された日時	`2025-04-06T18:20:42.226577Z`
connection_method	文字列	接続に使用される方法次のいずれか:`JWT`、`OAuth`	`JWT`

応答の例:

{
  "id": "a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b",
  "redirect_uri": "https://login.salesforce.com/services/oauth2/authorize?client_id=3MVG...&redirect_uri=https%3A%2F%2Fcreds-virginia.events.staging.herokudev.com%2Fsalesforce%2Foauth%2Fcallback&response_type=code&state=ey...",
  "status": "connecting",
  "org": {
     "id": "00DSG00000DGEIr2AP",
     "connection_name": "productionOrg",
     "instance_url": "https://mydomain.my.salesforce.com",
     "type": "SalesforceOrg",
     "api_verion": "57.0",
     "user_auth": {
        "username": "admin@example.org",
        "user_id": "005...",
        "access_token": "00DSG00000DGEIr2AP!<token>"
      }
  "app_id": "ef01ec58-63f6-478b-ab87-34f82b3c5bdd",
  "addon_id": "fe3b4938-3383-4c40-868c-1a5cdc38a358",
  "created_at": "2025-04-06T18:20:42.226577Z",
  "connection_method": "OAuth"
  }
}

JWT を使用して組織に接続する

JWT を使用して AppLink アドオンを Salesforce 組織に接続します。

POST /addons/${addon_uuid}/connections/salesforce/jwt

必須パラメータ

名前	種類	説明	例
addon_uuid	文字列	アドオンの一意識別子または名前	`fe3b4938-3383-4c40-868c-1a5cdc38a358`
connection_name	文字列	接続名	`productionOrg`
alias	文字列	hemp-creds の資格情報のエイリアス	`example-alias`
jwt_private_key	文字列	認証に使用する秘密鍵	`-----BEGIN PRIVATE KEY-----\nMII...C+Q=\n-----END PRIVATE KEY-----"`
client_id	文字列	コンシューマーキーの一意識別子	`3MVG8...NM0ZqZc9aT`
username	文字列	Salesforce ユーザー名	`test-2mhpnyuxne8k@example.com`

任意のパラメータ

名前	種類	説明	例
login_url	文字列	使用する Salesforce ログイン URL デフォルト: `https://login.salesforce.com`	`https://login.salesforce.com`

リクエストの例:

”` POST /addons/51fc983e-d106-4dac-8f75-9dd103d4381a/connections/salesforce/jwt { “connection_name”: “sandboxOrg”, “login_url”: “https://test.salesforce.com”, “alias”: “example-alias”, “client_id”: “3MVG8…NM0ZqZc9aT”, “jwt_private_key”: “—–BEGIN PRIVATE KEY—–\nMII…C+Q=\n—–END PRIVATE KEY—–”, “username”: “test-2mhpnyuxne8k@example.com” } “`

応答の属性

名前	種類	説明	例
id	文字列	接続の一意識別子	`a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b`
status	文字列	「接続状況」を参照	`connected`
org	json	「組織」を参照
app_id	文字列	アプリの一意識別子	`a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b`
addon_id	文字列	アドオンの一意識別子	`fe3b4938-3383-4c40-868c-1a5cdc38a358`
created_at	日付	接続が作成された日時	`2025-04-06T18:20:42.226577Z`
connection_method	文字列	接続に使用される方法次のいずれか:`JWT`、`OAuth`	`JWT`

応答の例:

{
  "id": "a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b",
  "status": "connecting",
  "org": {
    "id": "00DSG00000DGEIr2AP",
    "connection_name": "sandboxOrg",
    "instance_url": "https://mydomain.my.salesforce.com",
    "type": "SalesforceOrg",
    "api_verion": "57.0",
    "user_auth": {
        "username": "test-2mhpnyuxne8k@example.com"
        "user_id": "005...",
      "access_token": "00DSG00000DGEIr2AP!<token>"
    }
  },
  "app_id": "ba80caca-e1c6-41ee-9a60-39b7740e6865",
  "addon_id": "51fc983e-d106-4dac-8f75-9dd103d4381a",
  "created_at": "2025-04-06T18:20:42.226577Z",
  "connection_method": "JWT"
}

組織から切断する

AppLink アドオンを Salesforce 組織または Data Cloud 組織から切断します。

DELETE /addons/${addon_uuid}/connections/{conn_id_or_conn_name}

必須パラメータ

名前	種類	説明	例
addon_uuid	文字列	アドオンの一意識別子または名前	`fe3b4938-3383-4c40-868c-1a5cdc38a358`
conn_id_or_conn_name	文字列	接続の一意識別子または名前	`productionOrg`
app_id	文字列	アプリの一意識別子	`a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b`

リクエストの例:

”` DELETE /addons/fe3b4938-3383-4c40-868c-1a5cdc38a358/connections/productionOrg “`

応答の属性

名前	種類	説明	例
id	文字列	接続の一意識別子	`a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b`
status	文字列	「接続状況」を参照	`disconnected`

応答の例:

204 OK
{
  "id": "a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b",
  "status": "disconnected"
}

アドオンを指定して接続を取得する

特定のアドオンに紐づいている AppLink 接続のリストを取得します。

GET /addons/${addon_uuid}/connections

必須パラメータ

名前	種類	説明	例
addon_uuid	文字列	アドオンの一意識別子または名前	`fe3b4938-3383-4c40-868c-1a5cdc38a358`

リクエストの例:

”` GET /addons/fe3b4938-3383-4c40-868c-1a5cdc38a358/connections “`

応答の属性

名前	種類	説明	例
id	文字列	接続の一意識別子	`a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b`
status	文字列	「接続状況」を参照	`connected`
org	json	「組織」を参照
addon_id	文字列	アドオンの一意識別子	`fe3b4938-3383-4c40-868c-1a5cdc38a358`
connection_method	文字列	接続に使用される方法次のいずれか:`JWT`、`OAuth`	`JWT`

応答の例:

[
  {
     "id": "4f96e929-5e21-4f9e-8f3c-375186af31fc",
     "status": "connecting",
     "org": {
        "id": "00D000000000001AAA",
        "connection_name": "Original SF Org",
        "instance_url": "https://mydomain.my.salesforce.com",
        "type": "SalesforceOrg",
        "api_verion": "57.0",
        "user_auth": {
           "username": "user1@sf-org-1.com",
           "user_id": "005...",
           "access_token": "00DSG00000DGEIr2AP!<token>"
         }
       }
    "addon_id": "fe3b4938-3383-4c40-868c-1a5cdc38a358",
    "connection_method": "OAuth"
  },
  {
     "id": "aa216852-2294-4524-aea0-d633f36a6c36",
     "status": "disconnected",
     "org": {
        "id": "DCO000000000001CCC",
        "connection_name": "Test DC Org 1",
        "instance_url": "https://mydomain.my.salesforce.com",
        "type": "DatacloudOrg",
        "api_verion": "57.0",
        "user_auth": {
           "username": "user3@dc-org-1.com",
           "user_id": "005...",
           "access_token": "00DSG00000DGEIr2AP!<token>"
        }
     }
    "addon_id": "fe3b4938-3383-4c40-868c-1a5cdc38a358",
    "connection_method": "OAuth"
  },
  {
     "id": "bb155b7d-1eee-4fb1-900e-35421c07755e",
     "status": "connected",
     "org": {
        "id": "00D000000000002BBB",
        "connection_name": "Test SF Org 2"
        "instance_url": "https://mydomain2.my.salesforce.com",
        "type": "SalesforceOrg",
        "api_verion": "57.0",
        "user_auth": {
           "username": "user2@sf-org-2.com",
           "user_id": "005...",
           "access_token": "00DSG00000DGEIr2AP!<token>"
         }
     }
    "addon_id": "51fc983e-d106-4dac-8f75-9dd103d4381a",
    "connection_method": "JWT"
  }
]

アプリを指定して接続を取得する

特定のアプリに紐づいている AppLink 接続のリストを取得します。

GET /addons/${addon_uuid}/connections/${app_uuid}

必須パラメータ

名前	種類	説明	例
addon_uuid	文字列	アドオンの一意識別子または名前	`fe3b4938-3383-4c40-868c-1a5cdc38a358`
app_uuid	文字列	アプリの一意識別子または名前	`ef01ec58-63f6-478b-ab87-34f82b3c5bdd`

リクエストの例:

”` GET /addons/fe3b4938-3383-4c40-868c-1a5cdc38a358/connections/ef01ec58-63f6-478b-ab87-34f82b3c5bdd “`

応答の属性

名前	種類	説明	例
id	文字列	接続の一意識別子	`a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b`
status	文字列	「接続状況」を参照	`connected`
org	json	「組織」を参照
app_id	文字列	アプリの一意識別子	`a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b`
addon_id	文字列	アドオンの一意識別子	`fe3b4938-3383-4c40-868c-1a5cdc38a358`
created_at	日付	接続が作成された日時	`2025-04-06T18:20:42.226577Z`
last_modified_at	日付	接続が最後に変更された日時	`2025-04-09T18:20:42.226577Z`
connection_method	文字列	接続に使用される方法次のいずれか:`JWT`、`OAuth`	`JWT`

応答の例:

[
  {
    "id": "4f9dff98-11e9-4b0f-9f2e-bbb710bf56fa",
    "status": "connected",
    "org": {
      "id": "00DSG00000KWTOr2AP",
      "connection_name": "myOtherOrg",
      "instance_url": "https://mydomain.my.salesforce.com",
      "type": "SalesforceOrg",
      "api_verion": "57.0",
      "user_auth": {
        "username": "use@however.org"
        "user_id": "005...",
    "access_token": "00DSG00000DGEIr2AP!<token>"
    }
   },
    "app_id": "ef01ec58-63f6-478b-ab87-34f82b3c5bdd",
    "addon_id": "fe3b4938-3383-4c40-868c-1a5cdc38a358",
    "created_at": "2025-04-06T18:20:42.226577Z",
    "last_modified_at": "2025-04-09T18:20:42.226577Z",
    "connection_method": "OAuth",
  },
  {
    "id": "ce2ffad8-5692-40e5-b1f6-7f7206d3d5ef",
    "status": "connected",
    "org": {
      "id": "00DSG00000DGEIr2AP",
      "connection_name": "productionOrg",
      "instance_url": "https://mydomain.my.salesforce.com",
      "type": "SalesforceOrg",
      "api_verion": "57.0",
      "user_auth": {
        "username": "admin@example.org"
        "user_id": "005...",
    "access_token": "00DSG00000DGEIr2AP!<token>"
    }
   },
    "app_id": "ef01ec58-63f6-478b-ab87-34f82b3c5bdd",
    "addon_id": "fe3b4938-3383-4c40-868c-1a5cdc38a358",
    "created_at": "2025-04-06T18:20:42.226577Z",
    "last_modified_at": "2025-04-09T18:20:42.226577Z",
    "connection_method": "OAuth",
  }
]

接続の詳細を取得する

個別の Heroku AppLink 接続の情報を取得します。

GET /addons/${addon_uuid}/connections/{conn_id_or_conn_name_or_org_id}

必須パラメータ

名前	種類	説明	例
addon_uuid	文字列	アドオンの一意識別子または名前	`fe3b4938-3383-4c40-868c-1a5cdc38a358`
conn_id_or_conn_name_or_org_id	文字列	接続の一意識別子または接続名、あるいは 18 文字の Salesforce 組織 ID	`productionOrg`

リクエストの例:

# Request using connection name
GET /addons/fe3b4938-3383-4c40-868c-1a5cdc38a358/connections/productionOrg

# Request using connection UUID
GET /addons/fe3b4938-3383-4c40-868c-1a5cdc38a358/connections/a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b

# Request using Org ID
GET /addons/fe3b4938-3383-4c40-868c-1a5cdc38a358/connections/00DSG00000DGEIr2AP

応答の属性

名前	種類	説明	例
id	文字列	接続の一意識別子	`a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b`
status	文字列	「接続状況」を参照	`connected`
org	json	「組織」を参照
addon_id	文字列	アドオンの一意識別子	`fe3b4938-3383-4c40-868c-1a5cdc38a358`
created_at	日付	接続が作成された日時	`2025-04-06T18:20:42.226577Z`
created_by	文字列	接続を作成したユーザーの一意のメールアドレス	`foo@heroku.com`
last_modified_at	日付	接続が最後に変更された日時	`2025-04-09T18:20:42.226577Z`
last_modified_by	文字列	最後に接続を変更したユーザーの一意のメールアドレス	`bar@heroku.com`
created_via_app	文字列	接続が作成されたときの Heroku アプリの名前	`Foo`
connection_method	文字列	接続に使用される方法次のいずれか:`JWT`、`OAuth`	`JWT`

応答の例:

{
  "id": "a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b",
  "status": "connected",
  "org": {
    "id": "00DSG00000DGEIr2AP",
    "connection_name": "productionOrg",
    "instance_url": "https://mydomain.my.salesforce.com",
    "type": "DataCloudOrg",
    "api_verion": "57.0",
      "user_auth": {
        "username": "admin@example.org"
        "user_id": "005...",
    "access_token": "00DSG00000DGEIr2AP!<token>"
    }
  },
  "app_id": "ef01ec58-63f6-478b-ab87-34f82b3c5bdd",
  "addon_id": "fe3b4938-3383-4c40-868c-1a5cdc38a358",
  "created_at": "2025-04-06T18:20:42.226577Z",
  "created_by": "creator@somewhere.com",
  "last_modified_at": "2025-04-09T18:20:42.226577Z",
  "last_modified_by": "modifier@somewhere.com",
  "created_via_app": "Foo"
  "connection_method": "OAuth"
}

承認エンドポイント

これらのエンドポイントを使用して、AppLink 承認の作成、情報取得、管理を行います。

ユーザーを承認する

Salesforce または Data Cloud ユーザーを承認し、ユーザーの資格情報を AppLink アドオンに保存します。

POST /addons/${addon_uuid}/authorizations/[salesforce|datacloud]

必須パラメータ

名前	種類	説明	例
addon_uuid	文字列	アドオンの一意識別子または名前	`fe3b4938-3383-4c40-868c-1a5cdc38a358`
developer_name	文字列	承認名	`authUser`

任意のパラメータ

名前	種類	説明	例
login_url	文字列	使用する Salesforce ログイン URL デフォルト: `https://login.salesforce.com`	`https://login.salesforce.com`

リクエストの例:

”` POST /addons/fe3b4938-3383-4c40-868c-1a5cdc38a358/authorizations { “developer_name”: “authUser”, “login_url”: “https://login.salesforce.com” } “`

応答の属性

名前	種類	説明	例
id	文字列	承認の一意識別子	`a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b`
status	文字列	「承認状況」を参照	`authorized`
org	json	「組織」を参照
redirect_uri	文字列	OAuth 完了後にリダイレクトするエンドポイント	`https://login.salesforce.com/services/oauth2/authorize?client_id=3MVG...&redirect_uri=https...`
created_at	日付	承認が作成された日時	`2025-04-06T18:20:42.226577Z`

応答の例:

{
  "id": "a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b",
  "redirect_uri":   "https://login.salesforce.com/services/oauth2/authorize?client_id=3MVG...&redirect_uri=https%3A%2F%2Fcreds-virginia.events.staging.herokudev.com%2Fsalesforce%2Foauth%2Fcallback&response_type=code&state=ey...",
  "status": "authorizing",
  "org": {
    "id": "00DSG00000DGEIr2AP",
    "developer_name": "productionOrg",
    "instance_url": "https://mydomain.my.salesforce.com",
    "type": "SalesforceOrg",
    "api_verion": "57.0",
      "user_auth": {
        "username": "admin@example.org"
        "user_id": "005...",
      "access_token": "00DSG00000DGEIr2AP!<token>"
    }
  },
  "created_at": "2025-04-06T18:20:42.226577Z",
}

ユーザー承認を削除する

AppLink アドオンで既存の Salesforce または Data Cloud ユーザー承認を削除します。

DELETE  /addons/${addon_uuid}/authorizations/${developer_name_or_id}

必須パラメータ

名前	種類	説明	例
addon_uuid	文字列	アドオンの一意識別子または名前	`fe3b4938-3383-4c40-868c-1a5cdc38a358`
developer_name_or_id	文字列	承認の一意識別子または名前	`authUser`

リクエストの例:

”` GET /addons/fe3b4938-3383-4c40-868c-1a5cdc38a358/authorizations/authUser “`

応答の属性

名前	種類	説明	例
id	文字列	承認の一意識別子	`a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b`
status	文字列	「承認状況」を参照	`disconnected`

応答の例:

204 OK
{
  "id": "a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b",
  "status": "disconnected"
}

承認済みのユーザーを取得する

アドオンの AppLink 承認済みユーザーのリストを取得します。

GET /addons/${addon_uuid}/authorizations

必須パラメータ

名前	種類	説明	例
addon_uuid	文字列	アドオンの一意識別子または名前	`fe3b4938-3383-4c40-868c-1a5cdc38a358`

リクエストの例:

”` GET /addons/fe3b4938-3383-4c40-868c-1a5cdc38a358/authorizations “`

応答の属性

名前	種類	説明	例
id	文字列	承認の一意識別子	`a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b`
status	文字列	「承認状況」を参照	`authorized`
org	json	「組織」を参照
app_name	文字列	アプリの名前	`app-name`
created_at	日付	承認が作成された日時	`2025-04-06T18:20:42.226577Z`
created_by	文字列	承認を作成したユーザーの一意のメールアドレス	`foo@heroku.com`
last_modified_at	日付	承認が最後に変更された日時	`2025-04-09T18:20:42.226577Z`
last_modified_by	文字列	承認を最後に変更したユーザーの一意のメールアドレス	`bar@heroku.com`

応答の例:

[
 {
  "id": "a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b",
  "status": "authorizing",
  "org": {
       "id": "00DSG00000DGEIr2AP",
    "developer_name": "productionOrg",
    "instance_url": "https://mydomain.my.salesforce.com",
    "type": "SalesforceOrg",
       "api_verion": "57.0",
       "user_auth": {
        "username": "admin@example.org"
        "user_id": "005...",
    "access_token": "00DSG00000DGEIr2AP!<token>"
    }
  },
  "created_at": "2025-04-06T18:20:42.226577Z",
  "created_by": "foo@heroku.com",
  "last_modified_at": "2025-04-09T18:20:42.226577Z",
  "last_modified_by": "bar@heroku.com"
},
{
  "id": "b8bc7bcb-89c3-45c0-b7b7-4fb4427e598a",
  "status": "authorized",
  "org": {
       "id": "00DSG00000DGEIr2AP",
       "developer_name": "productionOrg2",
       "instance_url": "https://mydomain.my.salesforce.com",
       "type": "SalesforceOrg",
       "api_verion": "57.0",
       "user_auth": {
         "username": "admin@example.org"
         "user_id": "005...",
     "access_token": "00DSG00000DGEIr2AP!<token>"
    }
  },
  "created_at": "2025-03-06T18:20:42.226577Z",
  "created_by": "foo@heroku.com",
  "last_modified_at": "2025-03-09T18:20:42.226577Z",
  "last_modified_by": "bar@heroku.com"
}
]

承認の詳細を取得する

個別の承認済みユーザーの情報を取得します。

GET /addons/${addon_uuid}/authorizations/${developer_name_or_id}

必須パラメータ

名前	種類	説明	例
addon_uuid	文字列	アドオンの一意識別子または名前	`fe3b4938-3383-4c40-868c-1a5cdc38a358`
developer_name_or_id	文字列	承認の一意識別子または名前	`authUser`

リクエストの例:

GET /addons/fe3b4938-3383-4c40-868c-1a5cdc38a358/authorizations/productionOrg

応答の属性

名前	種類	説明	例
id	文字列	承認の一意識別子	`a8bc7bcb-89c3-45c0-b7b7-4fb4427e598b`
status	文字列	「承認状況」を参照	`authorized`
org	json	「組織」を参照
app_name	文字列	アプリの名前	`app-name`
created_at	日付	承認が作成された日時	`2025-04-06T18:20:42.226577Z`
created_by	文字列	承認を作成したユーザーの一意のメールアドレス	`foo@heroku.com`
last_modified_at	日付	承認が最後に変更された日時	`2025-04-09T18:20:42.226577Z`
last_modified_by	文字列	承認を最後に変更したユーザーの一意のメールアドレス	`bar@heroku.com`
created_via_app	文字列	最後に承認を変更した Heroku アプリの名前	`Foo`

応答の例:

{
  "id": "b8bc7bcb-89c3-45c0-b7b7-4fb4427e598a",
  "status": "authorized",
  "org": {
       "id": "00DSG00000DGEIr2AP",
       "developer_name": "productionOrg2",
       "instance_url": "https://dmomain.my.salesforce.com",
       "type": "SalesforceOrg",
       "api_verion": "57.0",
       "user_auth": {
          "username": "admin@example.org",
          "user_id": "005...",
      "access_token": "00DSG00000DGEIr2AP!<token>"
   }
  },
  "created_at": "2025-03-06T18:20:42.226577Z",
  "last_modified_at": "2025-03-09T18:20:42.226577Z",
  "created_by": "foo@heroku.com",
  "last_modified_by": "foo@heroku.com",
  "created_via_app": "Foo"
}

公開エンドポイント

これらのエンドポイントを使用して、アプリの公開、情報取得、AppLink パブリケーションの管理を行います。

アプリを Salesforce に公開する

アプリを Salesforce に公開し、アプリの API をアクションに変換します。

POST /addons/${addon_uuid}/connections/salesforce/${conn_id_or_conn_name}/apps

必須パラメータ

名前	種類	説明	例
addon_uuid	文字列	アドオンの一意識別子または名前	`fe3b4938-3383-4c40-868c-1a5cdc38a358`
conn_id_or_conn_name	文字列	接続の一意識別子または名前	`productionOrg`
app_request	json	「app_request」を参照
metadata	ファイル	OpenAPI 仕様の zip ファイル

app_request

名前	種類	説明	例
client_name	文字列	クライアントアプリの名前	`foo`
authorization_connected_app_name	文字列	(任意) 作成する接続アプリの名前	`connected-app`
authorization_permission_set_name	文字列	(任意) 作成する権限セットの名前	`permission-set`

リクエストの例:

”` POST /addons/fe3b4938-3383-4c40-868c-1a5cdc38a358/connections/salesforce/my-prod-org/apps content-type: application/json “app_request” { “client_name”: “foo” “authorization_connected_app_name”: “connected-app” “authorization_permission_set_name” “permission-set” } content-type: application/zip “metadata”:

Categories

Table of Contents [expand]

バージョンのサポート

認証

リクエストメソッド

共有オブジェクト

組織

ユーザー認証

接続エンドポイント

組織に接続する

必須パラメータ

任意のパラメータ

リクエストの例:

応答の属性

応答の例:

JWT を使用して組織に接続する

必須パラメータ

任意のパラメータ

リクエストの例:

応答の属性

応答の例:

組織から切断する

必須パラメータ

リクエストの例:

応答の属性

応答の例:

アドオンを指定して接続を取得する

必須パラメータ

リクエストの例:

応答の属性

応答の例:

アプリを指定して接続を取得する

必須パラメータ

リクエストの例:

応答の属性

応答の例:

接続の詳細を取得する

必須パラメータ

リクエストの例:

応答の属性

応答の例:

承認エンドポイント

ユーザーを承認する

必須パラメータ

任意のパラメータ

リクエストの例:

応答の属性

応答の例:

ユーザー承認を削除する

必須パラメータ

リクエストの例:

応答の属性

応答の例:

承認済みのユーザーを取得する

必須パラメータ

リクエストの例:

応答の属性

応答の例:

承認の詳細を取得する

必須パラメータ

リクエストの例:

応答の属性

応答の例:

公開エンドポイント

アプリを Salesforce に公開する

必須パラメータ

app_request

リクエストの例: