メタデータ API 開発者ガイド
jAuthProvider
ファイルのサフィックスおよびディレクトリの場所
認証プロバイダーは authproviders ディレクトリに保存されます。ファイル名は URL サフィックスに一致し、拡張子は .authprovider です。たとえば、URL サフィックスが FacebookProvider という認証プロバイダーは、authproviders/FacebookProvider.authprovider に保存されます。
バージョン
認証プロバイダーは、API バージョン 27.0 以降で使用できます。
特別なアクセスルール
このオブジェクトにアクセスできるのは、「アプリケーションのカスタマイズ」権限および「認証プロバイダーの管理」権限のあるユーザーのみです。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| appleTeam | string | Apple をサードパーティ認証プロバイダーとして使用するときに必要です。Apple 開発者アカウントから取得した 10 文字のチーム ID です。API バージョン 48.0 以降で利用できます。 |
| authorizeUrl | string | OpenID Connect 認証プロバイダーを作成するときに必要です。OAuth 認証エンドポイント URL。API バージョン 29.0 以降で利用できます。 API バージョンが 33.0 以降で、Salesforce 管理認証プロバイダーの場合、項目を空白のままにし、Salesforce によって値を提供および管理できるようにします。詳細は、「使用状況」を参照してください。 |
| consumerKey | string | サードパーティ (外部) の認証プロバイダーに登録されているアプリケーションの鍵。 API バージョンが 33.0 以降で、Salesforce 管理認証プロバイダーの場合、項目を空白のままにし、Salesforce によって値を提供および管理できるようにします。詳細は、「使用状況」を参照してください。 |
| consumerSecret | string | サードパーティのプロバイダーに登録されているアプリケーションのコンシューマーの秘密。一度設定した値は、変更できません。create() を使用する場合、この項目は暗号化する必要があります。プレーンテキストから暗号化形式のコンシューマーの秘密を作成する手順は、次のとおりです。
API バージョンが 33.0 以降で、Salesforce 管理認証プロバイダーの場合、項目を空白のままにし、Salesforce によって値を提供および管理できるようにします。詳細は、「使用状況」を参照してください。 コンシューマーの秘密が認証プロバイダーで定義されている場合、コンシューマーの秘密が暗号化された秘密ではなくプレースホルダー値として常にエクスポートされます。 |
| controlPlane | MuleSoftControlPlane (string 型の列挙) | MuleSoft をサードパーティ認証プロバイダーとして使用するときに必要です。コントロールプレーンがホストされる環境。コントロールプレーンは、Anypoint Exchange を含む Anypoint Platform アーキテクチャの一部であり、ログイン URL を決定します。[ユーザー指定] を選択した場合は、コンシューマー鍵とコンシューマーの秘密を入力する必要があります。Salesforce 組織の認証の詳細を保存するために作成した MuleSoft 接続アプリケーションから値を取得します。API バージョン 57.0 以降で利用できます。使用できる値は次のとおりです。
|
| customMetadataTypeRecord | string | カスタム認証プロバイダープラグインを作成するときに必要です。カスタム認証プロバイダーの API 名。API バージョン 36.0 以降で利用できます。 |
| defaultScopes | string | OpenID Connect 認証プロバイダーの場合、フローの開始時に指定されていない場合に、認証要求で送信される範囲。API バージョン 29.0 以降で利用できます。 API バージョンが 33.0 以降で、Salesforce 管理認証プロバイダーの場合、項目を空白のままにし、Salesforce によって値を提供および管理できるようにします。「使用状況」を参照してください。 |
| ecKey | string | Apple をサードパーティ認証プロバイダーとして使用するときに必要です。Apple によって生成される非公開鍵です。API バージョン 48.0 以降で利用できます。 |
| errorUrl | string | エラーのレポートに使用する認証プロバイダーのカスタムエラー URL。 |
| executionUser | string |
登録ハンドラークラスを指定する場合に、必要になります。Apex ハンドラーを実行する Salesforce システム管理者またはシステムユーザーのユーザー名。これは、Apex ハンドラーが実行されるコンテキストを提供します。たとえば、Apex ハンドラーが取引先責任者を作成する場合、作成から登録プロセスまで容易にたどることができます。本番環境では、システムユーザーを使用します。このユーザーは「ユーザーの管理」権限を持っている必要があります。API バージョン 27.0 以降で利用できます。 |
| friendlyName | string | 必須。わかりやすい認証プロバイダー名。 |
| iconUrl | string | ログインページのボタンとして使用するアイコンへのパス。ユーザーは、このボタンをクリックし、Twitter や Facebook など、関連付けられた認証プロバイダを使用してログインします。API バージョン 32.0 以降で利用できます。 |
| idTokenIssuer | string | https: URI 形式の認証トークンの提供元。この項目は、OpenID Connect または Microsoft 認証プロバイダーを設定するときに使用できます。指定されている場合、Salesforce は返された id_token 値を検証します。OpenID Connect では id_token 値と一緒に access_token 値を返す必要があります。API バージョン 30.0 以降で利用できます。 |
| includeOrgIdInIdentifier | boolean | 2 つの供給元 (2 つの Sandbox など) からの同じユーザー ID を持つユーザーを区別するために使用されます。有効にすると (true)、ユーザー ID の他に、サードパーティ ID の組織 ID が保存されます。この設定を有効化すると、無効化できません。Salesforce 管理認証プロバイダーにのみ適用されます。API バージョン 32.0 以降で利用できます。 |
| isPkceEnabled | boolean | OAuth 2.0 Proof Key for Code Exchange (PKCE) セキュリティ拡張が有効化されているか (true)、否か (false) を示します。PKCE は、次の providerType 値の場合に有効化できます。
この項目は、API バージョン 59.0 以降で利用できます。 |
| linkKickoffUrl | string | 既存の Salesforce ユーザーをサードパーティアカウントにリンクするための URL。この項目は参照のみです。API バージョン 43.0 以降で利用できます。 |
| logoutUrl | string | ユーザーがシングルサインオンを使用して認証された場合のログアウト後の特定の移動先。URL は、http または https プレフィックスを付けて完全修飾する必要があります (https://acme.my.salesforce.com など)。API バージョン 33.0 以降で利用できます。 |
| oauthKickoffUrl | string | サードパーティの OAuth アクセストークンを取得するための URL。この項目は参照のみです。API バージョン 43.0 以降で利用できます。 |
| plugin | string | Auth.AuthProviderPluginClass 抽象クラスを拡張する既存の Apex クラス。API バージョン 36.0 以降で利用できます。 |
| portal | string | この項目は、廃止されたポータルでのみ使用されます。Salesforce ではポータルの作成をサポートしていませんが、既存のポータルはサポートされます。 |
| providerType | AuthProviderType (string 型の列挙) | 必須。使用するサードパーティの認証プロバイダー。使用できる値は次のとおりです。
|
| registrationHandler | string | Auth.RegistrationHandler インターフェースを実装する既存の Apex クラス。 |
| requireMfa | boolean | この認証プロバイダーで各ユーザーの多要素認証 (MFA) 状況に基づくシングルサインオンを行うために MFA が必要です。この設定で MFA をトリガーするには、次のいずれかの方法を使用して、MFA を直接ユーザーに適用する必要があります。1) 「ユーザーインターフェースログインの多要素認証」ユーザー権限を割り当てる。2) 組織設定の [Salesforce 組織へのすべての直接 UI ログインに多要素認証 (MFA) が必要] を有効にする。詳細は、Salesforce ヘルプの「SSO での Salesforce MFA の使用」を参照してください。 |
| sendAccessTokenInHeader | boolean | 有効 (true) の場合、アクセストークンはクエリ文字列ではなくヘッダーで UserInfoUrl に送信されます。API バージョン 30.0 以降で利用できます。 |
| sendClientCredentialsInHeader | boolean | OpenID Connect 認証プロバイダーを作成するときに必要です。有効 (true) の場合、クライアントのログイン情報はクエリ文字列ではなくヘッダーで tokenUrl に送信されます。ログイン情報には、標準の OpenID Connect 基本ログイン情報ヘッダー形式 Basic <token> が使用されます。ここで <token> は、base64 符号化文字列 "clientkey:clientsecret" です。API バージョン 30.0 以降で利用できます。 |
| sendSecretInApis | boolean |
暗号化されたコンシューマーの秘密を API 応答に表示するかどうかを決定します。有効の場合 (デフォルト)、応答で秘密が表示されます。無効の場合 (false)、応答にコンシューマーの秘密は含まれません。セキュリティを向上するために、この設定を無効にすることができます。ただし、次の点に注意してください。
sendSecretInApis に指定された値にかかわらず、コンシューマーの秘密がプレースホルダー値として常に応答に含まれます。 |
| ssoKickoffUrl | string | サードパーティのログイン情報を使用して、サードパーティから Salesforce へのシングルサインオンを実行するための URL。この項目は参照のみです。API バージョン 43 以降で利用できます。 |
| tokenUrl | string | OpenID Connect 認証プロバイダーの OAuth トークンエンドポイント URL。API バージョン 29.0 以降で利用できます。 API バージョンが 33.0 以降で、Salesforce 管理認証プロバイダーの場合、項目を空白のままにし、Salesforce によって値を提供および管理できるようにします。詳細は、「使用状況」を参照してください。 |
| userInfoUrl | string | OpenID Connect 認証プロバイダーの OpenID Connect エンドポイント URL。API バージョン 29.0 以降で利用できます。 API バージョンが 33.0 以降で、Salesforce 管理認証プロバイダーの場合、項目を空白のままにし、Salesforce によって値を提供および管理できるようにします。詳細は、「使用状況」を参照してください。 |
宣言的なメタデータの定義のサンプル
1<?xml version="1.0" encoding="UTF-8"?>
2<AuthProvider xmlns="http://soap.sforce.com/2006/04/metadata">
3 <consumerKey>yourappkey</consumerKey>
4 <consumerSecret>PwdVxXjzu3NCZ3MD4He+wA==</consumerSecret>
5 <executionUser>admin@your.org</executionUser>
6 <friendlyName>FacebookAuthProvider</friendlyName>
7 <providerType>Facebook</providerType>
8 <registrationHandler>RegistrationHandler</registrationHandler>
9 <sendSecretInApis>true</sendSecretInApis>
10</AuthProvider>1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>FacebookAuthProvider</members>
5 <name>AuthProvider</name>
6 </types>
7 <version>28.0</version>
8</Package>使用方法
Salesforce は、Salesforce 管理認証プロバイダーと呼ばれるデフォルトの認証プロバイダーを提供し、認証用のこれらのサービスプロバイダーのセットアップを簡略化しています。
- Apple
- GitHub
- Janrain
- Microsoft
- Microsoft アクセスコントロールサービス
- MuleSoft
- Salesforce
- Slack
Salesforce が管理する認証プロバイダーを使用するには、認証プロバイダーの設定ページで認証プロバイダーを作成するときに次の項目を空のままにします。
- authorizeUrl
- consumerKey
- consumerSecret
- defaultScopes
- tokenURL
- userInfoUrl
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。