ConnectedApp

接続アプリケーショ���に複数の権限セットを割り当てることができますが、各権限セット名は別の行に入力する必要があります。同じ権限セット名を各接続アプリケーションについて複数回入力することはできません。

現在の権限セットを新しい権限セットに置き換えることで、権限セットを変更することもできます。接続アプリケーションに割り当てられた各権限セット名が一意であることを確認してください。

個々の権限セットを削除したり、接続アプリケーションのリリース: (<permissionSetName></permissionSetName>) で空の permissionSetName 文字列を入力することですべての権限セットを接続アプリケーションから削除したりできます。

組織に含まれるユーザを入力します。ユーザが組織に含まれない場合、接続アプリケーションをリリースしたときにユーザがこの項目から削除されます。ユーザを指定しない場合は、この項目を空白のままにできます。

接続アプリケーションに複数のプロファイルを割り当てることができますが、各プロファイル名は別の行に入力する必要があります。同じプロファイル名を各接続アプリケーションについて複数回入力することはできません。

現在のプロファイルを新しいプロファイルに置き換えることで、プロファイルを変更することもできます。接続アプリケーションに割り当てられた各プロファイル名が一意であることを確認してください。

個々のプロファイルを削除することも接続アプリケーションのリリース: (<profileName></profileName>) で空の profileName 文字列を入力することですべてのプロファイルを接続アプリケーションから削除することもできます。

• Get — OAuth 認証が使用され、サードパーティアプリケーションがユーザ情報にアクセスすることを許可するように求められます。このアクセスメソッドを使用する場合、キャンバスアプリケーションで OAuth 認証フローが開始されるようにする必要があります。
• Post — OAuth 認証を使用しますが、システム管理者がキャンバスアプリケーションをインストールする場合、キャンバスアプリケーションはユーザのアクセスを暗黙的に許可します。したがって、サードパーティがユーザ情報にアクセスすることを許可するようにユーザが求められることはありません。このアクセスメソッドを使用する場合、認証は直接キャンバスアプリケーションの URL に post 送信されます。

API バージョン 31.0 以降で利用できます。

• Aura — 今後の使用のために予約されています。
• AppLauncher — 今後の使用のために予約されています。
• Chatter — キャンバスアプリケーションを Chatter タブのアプリケーションナビゲーションリストに表示できます。
• ChatterFeed — キャンバスアプリケーションを Chatter フィード項目として表示できます。
• MobileNav — キャンバスアプリケーションを Salesforce モバイルアプリケーションのモバイルカードに表示できます。API バージョン 31.0 以降で利用できます。
• None — キャンバスアプリケーションをキャンバスアプリケーションのプレビューアでのみ表示できます。
• OpenCTI — キャンバスアプリケーションをコール制御ツールに表示できます。
• PageLayout — キャンバスアプリケーションをページレイアウトに表示できます。Salesforce モバイルアプリケーションで参照する場合、キャンバスアプリケーションはレコード詳細ページに表示されます。API バージョン 31.0 以降で利用できます。
• Publisher — キャンバスアプリケーションをグローバルアクションとして表示できます。
• ServiceDesk — キャンバスアプリケーションを Salesforce コンソールのフッターまたはサイドバーに表示できます。
• UserProfile — 今後の使用のために予約されています。
• Visualforce — キャンバスアプリケーションを Visualforce ページに表示できます。

• HideShare — 関連するキャンバスアプリケーションのパブリッシャーで [共有] ボタンが非表示になります。API バージョン 30.0 以降で利用できます。
• HideHeader — 関連するキャンバスアプリケーションのパブリッシャーでヘッダーが非表示になります。API バージョン 30.0 以降で利用できます。
• PersonalEnabled — エンドユーザは、アプリケーションをキャンバス個人用アプリケーションとしてインストールできます。API バージョン 32.0 以降で利用できます。

• IdpInitiated — ID プロバイダが開始します。Salesforce は、SSO フローを開始するための初期要求を行います。
• SpInitiated — サービスプロバイダが開始します。キャンバスアプリケーションは、呼び出された後に SSO フローを開始します。
• None — キャンバスアプリケーションは SAML SSO を使用していません。API バージョン 31.0 以降で利用できます。

API バージョン 32.0 以降では、この項目の値を設定できるのは作成中のみです。値を定義して保存した後は、編集できません。値は 8 文字以上 256 文字以下の英数字にする必要があり、特殊文字とスペースは使用できません。コンシューマ鍵はグローバルに一意である必要があります。

値は、8 文字以上 (256 文字以下) の英数字 (特殊文字とスペースは不可) にする必要があります。組織で別の接続アプリケーションにすでに使用されている秘密を指定した場合、エラーが発生します。

API バージョン 32.0 以降で利用できます。

true に設定すると、適切なプロファイルまたは権限セットを持つユーザのみがアプリケーションにアクセスできます。このユーザは、アプリケーションにアクセスする前に承認する必要はありません。各プロファイルの [接続アプリケーションへのアクセス] リストを編集して、アプリケーションのプロファイルを管理します。各権限セットの [割り当てられた接続アプリケーション] リストを編集して、アプリケーションの権限セットを管理します。この設定は、Group Edition では使用できません。API バージョン 46.0 以降で利用できます。

false (デフォルト) に設定した場合、接続アプリケーションは、クライアントのログイン情報フローを使用できません。

API バージョン 56.0 以降で利用できます。

クライアントアプリケーションでクライアントの秘密の機密性を維持できず、かつ Web サーバフローを使用する必要があるときは、true に設定します。接続アプリケーション用にクライアントの秘密は依然として生成されますが、この設定で、アクセストークン要求内の client_secret パラメータが不要であることを Web サーバフローに指示します。秘密を使用しない Web サーバフローよりもセキュアなオプションとしてユーザエージェントフローをお勧めします。API バージョン 49.0 以降で利用できます。

false に設定した場合、接続アプリケーションで調査できるのは自身のトークンのみです。また、動的クライアント登録エンドポイントを介して OAuth 2.0 接続アプリケーションを直接登録している OAuth クライアントは、自身とその登録済みアプリケーションのトークンを確認できます。API バージョン 49.0 以降で利用できます。

クライアントの秘密を保護できる Web サーバベースのアプリケーションでは、このオプションを選択します。モバイルアプリケーションやユーザのコンピュータにインストールするアプリケーションなど、クライアントの秘密を保護できないアプリケーションでは、このオプションを選択しないことをお勧めします。API バージョン 51.0 以降で利用できます。

この項目を使用するには、isClientCredentialEnabled を true に設定する必要があります。

API バージョン 56.0 以降で利用できます。

• Basic — ID URL サービスへのアクセスを許可します (Address、Email、Phone、Profile をリリースする場合と同じ動作)。
• Api — API を介したログインユーザのアカウントへのアクセスを許可します。
• Web — Web で access_token を使用することを許可します。この使用には visualforce も含まれ、Visualforce ページへのアクセスが許可されます。
• Full — ログインユーザがアクセスできるすべてのデータへのアクセスを許可します。
• Chatter — Connect REST API リソースへのアクセスのみを許可します。
• CustomApplications — Visualforce を使用したカスタムアプリケーションなどのカスタムアプリケーションへのアクセスを提供します。
• RefreshToken — 更新トークンを受信できる場合に、それを返すことを指定します (OfflineAccess をリリースする場合と同じ動作)。
• OpenID — ログインユーザの OpenID Connect アプリケーションの一意の識別子へのアクセスを許可します。
• Profile — ログインユーザのプロファイルへのアクセスを許可します (Basic をリリースする場合と同じ動作)。
• Email — ログインユーザのメールアドレスへのアクセスを許可します (Basic をリリースする場合と同じ動作)。
• Address — ログインユーザの住所へのアクセスを許可します (Basic をリリースする場合と同じ動作)。
• Phone — ログインユーザの電話番号値へのアクセスを許可します (Basic をリリースする場合と同じ動作)。
• OfflineAccess — ユーザがオフラインのときにアプリケーションがユーザのデータを操作し更新トークンを取得することを許可します (RefreshToken をリリースする場合と同じ動作)。
• CustomPermissions — 接続アプリケーションに関連付けられている組織のカスタム権限へのアクセスを許可し現在のユーザで各権限が有効かどうかを示します。
• Wave — Analytics REST API リソースへのアクセスを許可します。API バージョン 35.0 以降で利用できます。
• Eclair — Analytics REST API Charts Geodata リソースへのアクセスを許可します。API バージョン 35.0 以降で利用できます。
• Pardot — ユーザの代わりに Pardot API サービスへアクセスすることを許可します。アクセス可能なすべてのサービスは、Pardot アカウントで管理します。API バージョン 49.0 以降で利用できます。
• Lightning — ハイブリッドアプリケーションが OAuth 2.0 ハイブリッドアプリケーショントークンフローおよびハイブリッドアプリケーション更新トークンフローを介して Lightning の子セッションを直接取得できるようにします。API バージョン 51.0 以降で利用できます。
• Content — ハイブリッドアプリケーションが OAuth 2.0 ハイブリッドアプリケーショントークンフローおよびハイブリッドアプリケーション更新トークンフローを介してコンテンツの子セッションを直接取得できるようにします。API バージョン 51.0 以降で利用できます。
• CDPIngest — Data Cloud の取り込み API サービスにアクセスできるようにします。顧客はこれらの API サービスを使用して、Data Cloud の外部データセットのアップロードと管理を行います。API バージョン 52.0 以降で利用できます。
• Chatbot — Einstein ボット API サービスへのアクセスを許可します。API バージョン 54.0 以降で利用できます。

メタデータを取得する場合の有効値は次のとおりです。

• Api — API を介したログインユーザのアカウントへのアクセスを許可します。
• Basic — ID URL サービスへのアクセスを許可し、Address、Email、Phone、Profile を含めます。
• Chatter — Connect REST API リソースへのアクセスのみを許可します。
• CustomApplications — Visualforce を使用したカスタムアプリケーションなどのカスタムアプリケーションへのアクセスを許可します。
• Full — ログインユーザがアクセスできるすべてのデータへのアクセスを許可します。
• OpenID — ログインユーザの OpenID Connect アプリケーションの一意の識別子へのアクセスを許可します。
• CDPIngest — Data Cloud の取り込み API サービスにアクセスできるようにします。顧客はこれらの API サービスを使用して、Data Cloud の外部データセットのアップロードと管理を行います。API バージョン 52.0 以降で利用できます。
• Pardot — ユーザの代わりに Pardot API サービスへアクセスすることを許可します。アクセス可能なすべてのサービスは、Pardot アカウントで管理します。API バージョン 49.0 以降で利用できます。
• Lightning — ハイブリッドアプリケーションが OAuth 2.0 ハイブリッドアプリケーショントークンフローおよびハイブリッドアプリケーション更新トークンフローを介して Lightning の子セッションを直接取得できるようにします。API バージョン 51.0 以降で利用できます。
• Content — ハイブリッドアプリケーションが OAuth 2.0 ハイブリッドアプリケーショントークンフローおよびハイブリッドアプリケーション更新トークンフローを介してコンテンツの子セッションを直接取得できるようにします。API バージョン 51.0 以降で利用できます。
• RefreshToken — 更新トークンを受信できる場合にそれを返すように指定します。OfflineAccess を許可する場合と同じです。
• Wave — Analytics REST API リソースへのアクセスを許可します。API バージョン 35.0 以降で利用できます。
• Eclair — Analytics REST API Charts Geodata リソースへのアクセスを許可します。API バージョン 35.0 以降で利用できます。
• Web — Web で access_token を使用することを許可します。この使用には visualforce も含まれ、Visualforce ページへのアクセスが許可されます。
• Chatbot — Einstein ボット API サービスへのアクセスを許可します。API バージョン 54.0 以降で利用できます。

• ENFORCE (デフォルト) — ユーザプロファイルに割り当てられた IP 範囲など、組織に対して設定された IP 制限を適用します。
• BYPASS_2FACTOR — アプリケーションを実行しているユーザは、次のいずれかの条件を満たす場合に、組織の IP 制限をスキップできます。
  • アプリケーションに許可された IP 範囲のリストが存在し、アプリケーションが Web サーバの OAuth 認証フローを使用している。これらの IP から送信された要求のみが許可されます。
  • アプリケーションに許可された IP 範囲のリストが存在しないが、アプリケーションが Web サーバの認証フローを使用している。新しいブラウザまたはデバイスから Salesforce にアクセスした場合、ユーザは ID 検証を正常に完了する。
• BYPASS — ユーザは組織の IP 制限なしでこのアプリケーションを実行できます。
• ENFORCE_RELAXREFRESH — ユーザプロファイルに割り当てられた IP 範囲など、組織に対して設定された IP 制限を適用します。ただし、このオプションでは、接続アプリケーションが更新トークンを使用してアクセストークンを取得する場合、この制限はスキップされます。

更新トークンを提供する場合、ユーザはアクセストークンの期限 (セッションタイムアウト値で定義) が切れても再承認することなく OAuth 対応の接続アプリケーションに引き続きアクセスできます。接続アプリケーションは、更新トークンをアクセストークンと交換して新しいセッションを開始します。更新トークンポリシーは、発行された更新トークンの使用時にのみ評価され、ユーザの現在のセッションに影響を与えることはありません。更新トークンは、ユーザのセッションが期限切れになったか、使用できないときにのみ必要になります。たとえば、1 時間後にトークンが期限切れになるように更新トークンポリシーを設定します。ユーザがアプリケーションを 2 時間使用する場合、1 時間後にユーザが再認証を強制されることはありません。ただし、セッションの期限が切れ、クライアントが新しいセッションのための更新トークンの交換を試みた場合、ユーザは再度認証を要求されます。

SamlEncryptionType

• AES_128 — 128 ビットの鍵
• AES_256 — 256 ビットの鍵
• Triple_Des — トリプル DES アルゴリズム

• PostBinding
• RedirectBinding

• Unspecified (デフォルト) — 形式は指定されません。
• EmailAddress — 件名種別がユーザの名前または統合 ID (SP の内部の ID) である場合に使用します。
• Persistent — ユーザ ID および永続 ID の件名種別と併用します。
• Transient — 件名種別がカスタム属性である場合に使用し、ユーザがログインするたびに変更される可能性があります。

• SHA1
• SHA256

• Username — Salesforce ユーザ名。
• FederationId — サービスプロバイダでのユーザの識別子。この値はサービスプロバイダから取得します。
• UserId — 15 文字の Salesforce ユーザ識別子。
• PersistentID — ID プロバイダおよびサービスプロバイダに固有の永続的で不透明な識別子。
• CustomAttr — samlSubjectCustomAttr のカスタム項目値から取得する識別子。

• Block — 組織のユーザが接続アプリケーションにアクセスできなくなります。アプリケーションをブロックすると、接続アプリケーションを使用する現在のすべてのユーザセッションが終了し、すべての新しいセッションが防止されます。
• RaiseSessionLevel — ユーザが接続アプリケーションにログインするときに多要素認証を使用して ID を検証することを要求します。この設定は、API ログインのユーザ承認ステップを含む承認フローに適用されます。これらのフローは、OAuth 2.0 更新トークンフロー、Web サーバーフロー、ユーザエージェントフローです。JSON Web トークン (JWT) ベアラーフローなど、その他のフローにはユーザ承認ステップは含まれていません。ユーザ承認ステップのないフローでは、高保証セッションセキュリティレベルでの API ログインはブロックされます。