メタデータ API 開発者ガイド
jAuthProvider
ファイルのサフィックスおよびディレクトリの場所
認証プロバイダは authproviders ディレクトリに保存されます。ファイル名は URL サフィックスに一致し、拡張子は .authprovider です。たとえば、URL サフィックスが FacebookProvider という認証プロバイダは、authproviders/FacebookProvider.authprovider に保存されます。
バージョン
認証プロバイダは、API バージョン 27.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 によって値を提供および管理できるようにします。詳細は、「使用状況」を参照してください。 |
| customMetadataTypeRecord | string | カスタム認証プロバイダプラグインを作成するときに必要です。カスタム認証プロバイダの API 名。API バージョン 36.0 以降で利用できます。 |
| defaultScopes | string | OpenID Connect 認証プロバイダの場合、フローの開始時に指定されていない場合に、認証要求で送信される範囲。API バージョン 29.0 以降で利用できます。 API バージョンが 33.0 以降で、Salesforce 管理認証プロバイダの場合、項目を空白のままにし、Salesforce によって値を提供および管理できるようにします。「使用状況」を参照してください。 |
| errorUrl | string | エラーのレポートに使用する認証プロバイダのカスタムエラー URL。 |
| executionUser | string |
登録ハンドラクラスを指定する場合に、必要になります。Apex ハンドラを実行する Salesforce システム管理者またはシステムユーザのユーザ名。これは、Apex ハンドラが実行されるコンテキストを提供します。たとえば、Apex ハンドラが取引先責任者を作成する場合、作成から登録プロセスまで容易にたどることができます。本番環境では、システムユーザを使用します。このユーザは「ユーザの管理」権限を持っている必要があります。API バージョン 27.0 以降で利用できます。 |
| friendlyName | string | 必須。わかりやすい認証プロバイダ名。 |
| iconUrl | string | ログインページのボタンとして使用するアイコンへのパス。ユーザは、このボタンをクリックし、Twitter や Facebook など、関連付けられた認証プロバイダを使用してログインします。API バージョン 32.0 以降で利用できます。 |
| idTokenIssuer | string | OpenID Connect 認証プロバイダを使用する場合、https: URI 形式の認証トークンの供給元を使用できます。指定されている場合、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 以降で利用できます。 |
| 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 クラス。 |
| 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)、応答にコンシューマの秘密は含まれません。セキュリティを向上するために、この設定を無効にすることができます。ただし、次の点に注意してください。
|
| 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
- Salesforce
Salesforce が管理する認証プロバイダを使用するには、認証プロバイダの設定ページで認証プロバイダを作成するときに次の項目を空のままにします。
- authorizeUrl
- consumerKey
- consumerSecret
- defaultScopes
- tokenURL
- userInfoUrl
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。