メタデータ API 開発者ガイド
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
AuthProvider
組織の認証プロバイダを表します。認証プロバイダは Facebook© や Janrain© などの外部サービスプロバイダのログイン情報を使用して、Salesforce 組織にユーザがログインできるようにします。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
認証プロバイダは authproviders ディレクトリに保存されます。ファイル名は URL サフィックスに一致し、拡張子は .authprovider です。たとえば、URL サフィックスが FacebookProvider という認証プロバイダは、authproviders/FacebookProvider.authprovider に保存されます。
バージョン
認証プロバイダは、API バージョン 27.0 以降で使用できます。
特別なアクセスルール
このオブジェクトにアクセスできるのは、「アプリケーションのカスタマイズ」権限および「認証プロバイダの管理」権限のあるユーザのみです。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| authorizeUrl | string | providerType が OpenIdConnect である場合にのみ必須です。OAuth 認証エンドポイント URL。OpenID Connect 認証プロバイダでのみ使用されます。API バージョン 29.0 以降で利用できます。 |
| consumerKey | string | 必須。サードパーティのシングルサインオンプロバイダに登録されているアプリケーションの鍵。 |
| consumerSecret | string | 必須。サードパーティのシングルサインオンプロバイダに登録されているアプリケーションのコンシューマの秘密。この項目は更新できません。create() を使用する場合、この項目は暗号化する必要があります。テキスト形式から暗号化形式のコンシューマの秘密を作成する手順は、次のとおりです。
|
| defaultScopes | string | providerType が OpenIdConnect である場合にのみ必須です。フローの開始時に指定されていない場合に、認証要求で送信される範囲。OpenID Connect 認証プロバイダでのみ使用されます。API バージョン 29.0 以降で利用できます。 |
| DeveloperName | string | 必須。プログラムから認証プロバイダを参照するときに使用します。 |
| errorUrl | string | エラーのレポートに使用するプロバイダのカスタムエラー URL。 |
| executionUserId | string | Apex ハンドラクラスを実行するユーザ。このユーザは「ユーザの管理」権限を持っている必要があります。登録ハンドラクラスを指定した場合は、ユーザが必要です。 |
| friendlyName | string | 必須。わかりやすいプロバイダ名。 |
| iconUrl | string | コミュニティのログインページのボタンとして使用するアイコンへのパス。ユーザは、このボタンをクリックし、Twitter© や LinkedIn© など、関連付けられた認証プロバイダを使用して コミュニティにログインします。API バージョン 32.0 以降で使用できます。 |
| idTokenIssuer | string | providerType が OpenIdConnect の場合にのみ使用できます。この値には、認証トークンのソースを https: URI 形式で指定します。OpenID Connect 認証プロバイダでのみ使用されます。指定されている場合、Salesforce は返された id_token 値を検証します。OpenID Connect 仕様では、id_token 値と一緒に access_token 値を返す必要があります。API バージョン 30.0 以降で利用できます。 |
| providerType | AuthProviderType (string 型の列挙) | 必須。使用するサードパーティのシングルサインオンプロバイダ。有効な値は、次のとおりです。
|
| registrationHandler | string | Auth.RegistrationHandler インターフェースを実装する既存の Apex クラス。 |
| sendAccessTokenInHeader | boolean | providerType が OpenIdConnect の場合にのみ必須です。true の場合、アクセストークンはクエリ文字列ではなくヘッダーで userInfoUrl に送信されます。OpenID Connect 認証プロバイダでのみ使用されます。API バージョン 30.0 以降で利用できます。 |
| sendClientCredentialsInHeader | boolean | providerType が OpenIdConnect の場合にのみ必須です。true の場合、クライアントログイン情報はクエリ文字列ではなくヘッダーで tokenUrl に送信されます。ログイン情報には、標準の OpenID Connect 基本ログイン情報ヘッダー形式 Basic <token> が使用されます。ここで <token> は、base64 符号化文字列 "clientkey:clientsecret" です。OpenID Connect 認証プロバイダでのみ使用されます。API バージョン 30.0 以降で利用できます。 |
| tokenUrl | string | providerType が OpenIdConnect である場合にのみ必須です。OAuth トークンエンドポイント URL。OpenID Connect 認証プロバイダでのみ使用されます。API バージョン 29.0 以降で利用できます。 |
| userInfoUrl | string | providerType が OpenIdConnect である場合にのみ必須です。OpenID Connect エンドポイント URL。OpenID Connect 認証プロバイダでのみ使用されます。API バージョン 29.0 以降で利用できます。 |
宣言的なメタデータの定義のサンプル
1swfobject.registerObject("clippy.codeblock-0", "9");<?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</AuthProvider>1swfobject.registerObject("clippy.codeblock-1", "9");<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>AuthProvider</members>
5 <name>FacebookProvider</name>
6 </types>
7 <version>28.0</version>
8</Package>
9