メタデータ API 開発者ガイド
jSamlSsoConfig
SAML シングルサインオン設定を表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。シングルサインオン (SSO) は、ユーザが 1 回のログインと 1 セットのログイン情報で複数のアプリケーションにアクセスできるようにする認証方法です。たとえば、ユーザが組織にログインすると、自動的にアプリケーションランチャーからすべてのアプリケーションにアクセスできます。ユーザを認証するためにサードパーティ ID プロバイダを信頼するように Salesforce 組織を設定できます。または、組織を使用して認証するようにサードパーティアプリケーションを設定することもできます。
ファイルのサフィックスおよびディレクトリの場��
SamlSsoConfig コンポーネントのサフィックスは .samlssoconfig で、samlssoconfigs フォルダに保存されます。
バージョン
SamlSsoConfig コンポーネントは、API バージョン 28.0 以降で使用できます。
特別なアクセスルール
Summer ’20 以降、この型にアクセスできるのは、「設定・定義を参照する」権限を持つユーザか、「アプリケーションのカスタマイズ」と「すべてのデータの編集」の両方の権限を持つユーザのみとなります。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| attributeNameIdFormat | string | SAML 2.0 で identityLocation が Attribute に設定されている場合にのみ使用されます。可能な値には、unspecified、emailAddress、persistent があります。すべての規定値は、SAML 2.0 のアサーションとプロトコルの仕様書にある「Name Identifier Format Identifiers」の項に記載されています。 |
| attributeName | string | ID プロバイダのアプリケーションの名前。ID プロバイダからこの名前を取得します。 |
| decryptionCertificate | string | 受信 SAML アサーションの復号化に使用する証明書の名前。この証明書は、組織の [証明書と鍵の管理] リストに保存されます。API バージョン 30.0 以降で利用できます。 |
| errorUrl | string | ログイン中にエラーが発生した場合にユーザが移動する先のページの URL を指定します。この URL は、公開サイトの Visualforce ページなど、公開されている必要があります。URL は相対または絶対のどちらでも使用できます。 |
| executionUserId | string | Apex ハンドラクラスを実行するユーザ。このユーザは「ユーザの管理」権限を持っている必要があります。SAML JIT ヘッダークラスを指定する場合は、ユーザは必須です。 |
| identityLocation | SamlIdentityLocationType (string 型の列挙) | ユーザを識別するアサーション内の場所。有効な値は、次のとおりです。
|
| identityMapping | SamlIdentityType (string 型の列挙) |
ジャストインタイムのユーザプロビジョニング中にサービスプロバイダがユーザに対して使用する識別子。有効な値は、次のとおりです。
|
| issuer | string | ID プロバイダの ID 文字列。 |
| loginUrl | string | SAML 2.0 でのみ有効: Salesforce がログインシーケンスを開始する SAML 要求を送信する URL です。 |
| logoutUrl | string | SAML 2.0 専用: ユーザが [ログアウト] リンクをクリックしたときに移動先となる URL。デフォルトは https://salesforce.com です。 |
| name | string | この一意の名前は API および管理パッケージで使用されます。名前は文字で始まり、英数字とアンダースコアのみを使用する必要があります。名前には、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。 |
| oauthTokenEndpoint | string | SAML 2.0 でのみ有効: ACS URL は、Web シングルサインオン OAuth アサーションフローで ID プロバイダとして Salesforce を有効化して使用します。 |
| redirectBinding | boolean | ID プロバイダが SAML メッセージで要求するバインドメカニズムを選択します。値は次のとおりです。
|
| requestSignatureMethod | string | SAML 要求の署名に使用されるメソッド。有効な値は、RSA-SHA1 および RSA-SHA256 です。 |
| requestSigningCertId | string | ID プロバイダへの SAML 要求の署名を生成するために使用する証明書の 18 桁の ID。この証明書は、[設定] の [証明書と鍵の管理] ページに保存されます。 |
| salesforceLoginUrl | string | Web シングルサインオンフローのログインに関連付けられている URL。 |
| samlEntityId | string | Salesforce によって生成された SAML 要求の発行者、または受信 SAML レスポンスの予測される利用者です。Salesforce では [私のドメイン] ログイン URL の使用をお勧めします。 |
| samlJitHandlerId | string | Auth.SamlJitHandler インターフェースを実装する既存の Apex クラスの名前。 |
| samlVersion | SamlType (string 型の列挙) | 使用中の SAML バージョン。有効な値は、次のとおりです。
|
| singleLogoutBinding | SamlSpSLOBinding (string 型の列挙) | HTTP バインド種別。この値は、シングルログアウト (SLO) 時に SAML 要求の LogoutRequest または LogoutResponse をどこに配置するかを決定します。値は base64 でエンコードされます。有効な値は、次のとおりです。
|
| singleLogoutUrl | string | SAML シングルログアウトエンドポイント。この URL は、Salesforce が LogoutRequests (Salesforce がログアウトを開始する場合) または LogoutResponses (ID プロバイダがログアウトを開始する場合) を送信するエンドポイントです。 |
| useConfigRequestMethod | boolean | true の場合は、シングルログアウト中に選択した署名要求メソッド (RSM) が適用されます。false の場合は、デフォルトの RSM (RSA-SHA1) が適用されます。 |
| useSameDigestAlgoForSigning | boolean |
true の場合は、選択した署名要求メソッド (RSM) に基づいてダイジェストアルゴリズムが使用されます。たとえば、選択した RSM が RSA-SHA256 の場合、ダイジェストアルゴリズムは SHA-256 に設定されます。 false の場合は、選択した RSM にかかわらず、デフォルトのダイジェストアルゴリズム (SHA-1) が使用されます。 この項目は、API バージョン 55.0 以降で使用できます。この項目は、Spring '22 より前に作成された従来の SAML 設定でのみ編集できます。Spring '22 以降に作成された設定では、この項目はデフォルトで true になります。 |
| userProvisioning | boolean | true の場合、ジャストインタイムのユーザプロビジョニングが有効になり、ユーザがはじめてログインしたときにユーザが作成されます。この機能を使用するには、identityMapping 値に Federation ID を指定します。 |
| validationCert | string | 要求の検証に使用される証明書。ID プロバイダからこの証明書を取得します。 |
宣言的なメタデータの定義のサンプル
SamlSsoConfig コンポーネントの例を次に示します。読みやすくするために検証の証明書文字列を切り捨てています。
1<?xml version="1.0" encoding="UTF-8"?>
2<SamlSsoConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3 <identityLocation>SubjectNameId</identityLocation>
4 <identityMapping>FederationId</identityMapping>
5 <issuer>https://my-idp.my.salesforce.com</issuer>
6 <loginUrl>
7 https://my-idp.my.salesforce.com/idp/endpoint/HttpRedirect
8 </loginUrl>
9 <logoutUrl>https://www.salesforce.com</logoutUrl>
10 <name>SomeCompany</name>
11 <oauthTokenEndpoint>
12 https://login.salesforce.com/services/oauth2/token?so=00DD0000000
13 </oauthTokenEndpoint>
14 <redirectBinding>true</redirectBinding>
15 <requestSignatureMethod>RSA-SHA1</requestSignatureMethod>
16 <salesforceLoginUrl>
17 https://login.salesforce.com?so=00DD0000000JxeI
18 </salesforceLoginUrl>
19 <samlEntityId>
20 https://saml.salesforce.com/customPath
21 </samlEntityId>
22 <samlVersion>SAML2_0</samlVersion>
23 <useConfigRequestMethod>true</useConfigRequestMethod>
24 <userProvisioning>false</userProvisioning>
25 <validationCert>
26 MIIEojCCA4qgAwIBAgIOATtxsoBFAAAAAD4...
27 </validationCert>
28</SamlSsoConfig>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。