この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

AuthProvider

認証プロバイダーを表します。認証プロバイダーによって、ユーザーは、Facebook、Google、GitHub などの外部サービスプロバイダーから Salesforce 組織にログインできるようになります。このオブジェクトは、API バージョン 27.0 以降で使用できます。

サポートされているコール

create()、delete()、describeSObjects()、query()、retrieve()、update()、upsert()

特別なアクセスルール

このオブジェクトにアクセスできるのは、「アプリケーションのカスタマイズ」権限および「認証プロバイダーの管理」権限のあるユーザーのみです。

項目

項目名	詳細
AppleTeam	型 string プロパティ Create、Filter、Group、Nillable、Sort、Update 説明 Apple をサードパーティ認証プロバイダーとして使用するときに必要です。Apple 開発者アカウントから取得した 10 文字のチーム ID です。API バージョン 48.0 以降で利用できます。
AuthorizeUrl	型 url プロパティ Create、Filter、Nillable、Sort、Update 説明 OpenID Connect 認証プロバイダーを作成するときに必要です。OAuth 認証エンドポイント URL。API バージョン 29.0 以降で利用できます。API バージョンが 33.0 以降で、Salesforce 管理認証プロバイダーの場合、項目を空白のままにし、Salesforce によって値を提供および管理できるようにします。
ConsumerKey	型 string プロパティ Create、Filter、Nillable、Sort、Update 説明サードパーティ (外部) の認証プロバイダーに登録されているアプリケーションの鍵。API バージョンが 33.0 以降で、Salesforce 管理認証プロバイダーの場合、項目を空白のままにし、Salesforce によって値を提供および管理できるようにします。
ConsumerSecret	型 string プロパティ Create、Nillable 説明サードパーティの SSO に登録されている認証プロバイダーのコンシューマーの秘密。これは、コンシューマーによって Salesforce での識別に使用されます。API バージョンが 33.0 以降で、Salesforce 管理認証プロバイダーの場合、項目を空白のままにし、Salesforce によって値を提供および管理できるようにします。`create()` に独自のコンシューマーの秘密を作成することも可能です。ただし、設定後は値を変更できません。
CustomMetadataTypeRecord	型 string プロパティ Create、Filter、Group、Nillable、Sort、Update 説明カスタム認証プロバイダープラグインを作成するときに必要です。カスタム認証プロバイダーの API 名。API バージョン 36.0 以降で利用できます。
DefaultScopes	型 string プロパティ Create、Filter、Nillable、Sort、Update 説明 OpenID Connect 認証プロバイダーの場合、フローの開始時に指定されていない場合に、認証要求で送信される範囲。API バージョン 29.0 以降で利用できます。API バージョンが 33.0 以降で、Salesforce 管理認証プロバイダーの場合、項目を空白のままにし、Salesforce によって値を提供および管理できるようにします。
DeveloperName	型 string プロパティ Create、Filter、Group、Sort、Update 説明必須。プログラムから認証プロバイダーを参照するときに使用します。
EcKey	型 string プロパティ Create、Filter、Group、Nillable、Sort、Update 説明 Apple をサードパーティ認証プロバイダーとして使用するときに必要です。API バージョン 48.0 以降で利用できます。
ErrorUrl	型 string プロパティ Create、Filter、Nillable、Sort、Update 説明エラーのレポートに使用する認証プロバイダーのカスタムエラー URL。
ExecutionUserId	型 reference プロパティ Create、Filter、Group、Nillable、Sort、Update 説明登録ハンドラークラスを指定する場合に、必要になります。Apex ハンドラーを実行する Salesforce システム管理者またはシステムユーザーのユーザー名。これは、Apex ハンドラーが実行されるコンテキストを提供します。たとえば、Apex ハンドラーが取引先責任者を作成する場合、作成から登録プロセスまで容易にたどることができます。本番環境では、システムユーザーを使用します。このユーザーは「ユーザーの管理」権限を持っている必要があります。API バージョン 27.0 以降で利用できます。
FriendlyName	型 string プロパティ Create、Filter、Group、idLookup、Sort、Update 説明必須。わかりやすい認証プロバイダー名。
IconUrl	型 url プロパティ Create、Filter、Nillable、Sort、Update 説明ログインページのボタンとして使用するアイコンへのパス。ユーザーは、このボタンをクリックし、Twitter や Facebook など、関連付けられた認証プロバイダーを使用してログインします。API バージョン 32.0 以降で利用できます。
IdTokenIssuer	型 string プロパティ Create、Filter、Nillable、Sort、Update 説明 `https:` URI 形式の認証トークンの提供元。この項目は、OpenID Connect または Microsoft 認証プロバイダーを設定するときに使用できます。指定されている場合、Salesforce は返された `id_token` 値を検証します。OpenID Connect では `id_token` 値と一緒に `access_token` 値を返す必要があります。API バージョン 30.0 以降で利用できます。
LinkKickoffUrl	型 url プロパティ Nillable 説明既存の Salesforce ユーザーをサードパーティアカウントにリンクするための URL。この項目は参照のみです。API バージョン 43.0 以降で使用できます。
LogoutUrl	型 url プロパティ Create、Filter、Nillable、Sort、Update 説明ユーザーがシングルサインオンを使用して認証された場合のログアウト後の特定の移動先。URL は、http または https プレフィックスを付けて完全修飾する必要があります (https://acme.my.salesforce.com など)。API バージョン 33.0 以降で利用できます。
OauthKickoffUrl	型 url プロパティ Nillable 説明サードパーティの OAuth アクセストークンを取得するための URL。この項目は参照のみです。API バージョン 43.0 以降で使用できます。
OptionsIncludeOrgIdInId	型 boolean プロパティ Create、Filter、Update 説明 2 つの供給元 (2 つの Sandbox など) からの同じユーザー ID を持つユーザーを区別するために使用されます。有効にすると (`true`)、ユーザー ID の他に、サードパーティ ID の組織 ID が保存されます。この設定を有効化すると、無効化できません。Salesforce 管理認証プロバイダーにのみ適用されます。API バージョン 32.0 以降で利用できます。
OptionsIsPkceEnabled	型 boolean プロパティ Create、Filter、Update 説明 `true` に設定されている場合、認証プロバイダーは、プロバイダーの認証フローのセキュリティを強化する OAuth 2.0 Proof Key for Code Exchange (PKCE) 拡張を使用します。この項目は、次の providerType 値にのみ適用されます。 `Custom` `Facebook` `Google` `Microsoft` `OpenIdConnect` `Salesforce`。この項目は、API バージョン 59.0 以降で使用できます。
OptionsRequireMfa	型 boolean プロパティ Filter 説明この認証プロバイダーで各ユーザーの多要素認証 (MFA) 状況に基づくシングルサインオンを行うために MFA が必要です。この設定で MFA をトリガーするには、次のいずれかの方法を使用して、MFA を直接ユーザーに適用する必要があります。1) 「ユーザーインターフェースログインの多要素認証」ユーザー権限を割り当てる。2) 組織設定の [Salesforce 組織へのすべての直接 UI ログインに多要素認証 (MFA) が必要] を有効にする。詳細は、Salesforce ヘルプの「SSO での Salesforce MFA の使用」を参照してください。
OptionsSendAccessTokenInHeader	型 boolean プロパティ Create、Filter、Update 説明有効 (`true`) の場合、アクセストークンはクエリ文字列ではなくヘッダーで UserInfoUrl に送信されます。API バージョン 30.0 以降で利用できます。
OptionsSendClientCredentialsInHeader	型 boolean プロパティ Create、Filter、Update 説明 OpenID Connect 認証プロバイダーを作成するときに必要です。有効 (`true`) の場合、クライアントのログイン情報はクエリ文字列ではなくヘッダーで tokenUrl に送信されます。ログイン情報には、標準の OpenID Connect 基本ログイン情報ヘッダー形式 `Basic <token>` が使用されます。ここで `<token>` は、base64 符号化文字列 `"clientkey:clientsecret"` です。API バージョン 30.0 以降で利用できます。
OptionsSendSecretInApis	型 boolean プロパティ Create、Filter、Update 説明暗号化されたコンシューマーの秘密を API 応答に表示するかどうかを決定します。有効の場合 (デフォルト)、応答で秘密が表示されます。無効の場合 (`false`)、応答にコンシューマーの秘密は含まれません。セキュリティを向上するために、この設定を無効にすることができます。ただし、次の点に注意してください。この設定を無効にすると、すべての API バージョンでコンシューマーの秘密が API 応答から除外されます。コンシューマーの鍵と秘密の両方が予期されているため、変更セットとその他のメタデータのリリースを使用すると中断します。この問題を解決するには、リリース時にコンシューマー鍵を手動で入力します。 API バージョン 47.0 以降で利用できます。
PluginId	型 reference プロパティ Create、Filter、Group、Nillable、Sort、Update 説明 `Auth.AuthProviderPluginClass` 抽象クラスを拡張する既存の Apex クラス。API バージョン 39.0 以降で利用できます。
ProviderType	型 picklist プロパティ Create、Filter、Group、Restricted picklist、Sort、Update 説明必須。使用するサードパーティの認証プロバイダー。使用できる値は次のとおりです。 `Apple`。API バージョン 48.0 以降で利用できます。 `Custom` — カスタム認証プロバイダープラグインを使用して設定されたプロバイダー。API バージョン 36.0 以降で使用できます。 `Facebook`。 `GitHub` — `GitHub` プロバイダーの認証を提供します。OAuth を使用して Lightning Platform アプリケーションのユーザーを GitHub にログインするために使用されます。GitHub にログインすると、アプリケーションで GitHub API をコールできます。`GitHub` プロバイダーは SSO としては使用できません。ユーザーが GitHub ログイン情報を使用して Salesforce 組織にログインすることはできません。API バージョン 35.0 以降で利用できます。 `Google`。 `Janrain`。 `LinkedIn`。API バージョン 32.0 以降で利用できます。 `Microsoft`。Microsoft Azure Active Directory 経由でアクセス可能なすべてのサービスに対して認証を提供します。API バージョン 55.0 以降で利用できます。 `MicrosoftACS` — Microsoft アクセスコントロールサービスは、SharePoint Online などの Microsoft Office 365 サービスの認証を提供します。`MicrosoftACS` プロバイダーは SSO をサポートしていません。API バージョン 31.0 以降で利用できます。 `OpenIdConnect`。API バージョン 29.0 以降で利用できます。 `Salesforce`。 `Slack`。API バージョン 54.0 以降で利用できます。 `Twitter`。API バージョン 32.0 以降で利用できます。
RegistrationHandlerId	型 reference プロパティ Create、Filter、Group、Nillable、Sort、Update 説明 `Auth.RegistrationHandler` インターフェースを実装する既存の Apex クラス。
SsoKickoffUrl	型 url プロパティ Nillable 説明サードパーティのログイン情報を使用して、サードパーティから Salesforce への SSO を実行するための URL。この項目は参照のみです。API バージョン 43.0 以降で使用できます。
TokenUrl	型 url プロパティ Create、Filter、Nillable、Sort、Update 説明 OpenID Connect 認証プロバイダーの OAuth トークンエンドポイント URL。API バージョン 29.0 以降で利用できます。API バージョンが 33.0 以降で、Salesforce 管理認証プロバイダーの場合、項目を空白のままにし、Salesforce によって値を提供および管理できるようにします。
UserInfoUrl	型 url プロパティ Create、Filter、Nillable、Sort、Update 説明 OpenID Connect 認証プロバイダーの OpenID Connect エンドポイント URL。API バージョン 29.0 以降で利用できます。API バージョンが 33.0 以降で、Salesforce 管理認証プロバイダーの場合、項目を空白のままにし、Salesforce によって値を提供および管理できるようにします。

Salesforce プラットフォームのオブジェクトリファレンス

AuthProvider

サポートされているコール

特別なアクセスルール

項目