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

AuthProvider

組織の認証プロバイダを表します。

認証プロバイダは Facebook© や Janrain© などの外部サービスプロバイダのログイン情報を使用して、Salesforce 組織にユーザがログインできるようにします。

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

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

特別なアクセスルール

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

項目

項目名 詳細
AuthorizeUrl
url
プロパティ
Create、Filter、Nillable、Sort、Update
説明
ProviderTypeOpenIdConnect である場合にのみ必須です。OAuth 認証エンドポイント URL。OpenID Connect 認証プロバイダでのみ使用されます。API バージョン 29.0 以降で利用できます。
ConsumerKey
string
プロパティ
Create、Filter、Nillable、Sort、Update
説明
必須。サードパーティのシングルサインオンプロバイダに登録されているアプリケーションの鍵。
ConsumerSecret
string
プロパティ
Create、Nillable
説明
必須。サードパーティのシングルサインオンプロバイダに登録されているアプリケーションのコンシューマの秘密。この項目は更新できません。create() を使用する場合、この項目は暗号化する必要があります。テキスト形式から暗号化形式のコンシューマの秘密を作成する手順は、次のとおりです。
  1. ConsumerSecret プレーンテキスト値を使用して認証プロバイダを作成します。
  2. 認証プロバイダを保存します。
  3. 認証プロバイダコンポーネントを含む送信変更セットを作成します。
新規変更セットの .xml ファイルには <consumerSecret>++XYZ++</consumerSecret> という形式の入力があります。++XYZ++ は暗号化された秘密です。
CustomMetadataTypeRecord
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
ProviderTypeCustom で、カスタム認証プロバイダプラグインを使用する場合にのみ必須です。認証プロバイダの API 名です。API バージョン 36.0 以降で使用できます。
DefaultScopes
string
プロパティ
Create、Filter、Nillable、Sort、Update
説明

ProviderTypeOpenIdConnect である場合にのみ必須です。フローの開始時に指定されていない場合に、認証要求で送信される範囲。OpenID Connect 認証プロバイダでのみ使用されます。API バージョン 29.0 以降で利用できます。

DeveloperName
string
プロパティ
Create、Filter、Group、Sort、Update
説明

必須。プログラムから認証プロバイダを参照するときに使用します。

ErrorUrl
string
プロパティ
Create、Filter、Nillable、Sort、Update
説明

エラーのレポートに使用するプロバイダのカスタムエラー URL。

ExecutionUserId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明

Apex ハンドラクラスを実行するユーザ。このユーザは「ユーザの管理」権限を持っている必要があります。登録ハンドラクラスを指定した場合は、ユーザが必要です。

FriendlyName
string
プロパティ
Create、Filter、Group、Sort、Update
説明

必須。わかりやすいプロバイダ名。

IconUrl
url
プロパティ
Create、Filter、Nillable、Sort、Update
説明

ログインページのボタンとして使用するアイコンへのパス。ユーザは、このボタンをクリックし、関連付けられた認証プロバイダを使用してログインします。

IdTokenIssuer
string
プロパティ
Create、Filter、Nillable、Sort、Update
説明

ProviderTypeOpenIdConnect の場合にのみ使用できます。この値には、認証トークンのソースを https: URI 形式で指定します。OpenID Connect 認証プロバイダでのみ使用されます。指定されている場合、Salesforce は返された id_token 値を検証します。OpenID Connect 仕様では、id_token 値と一緒に access_token 値を返す必要があります。API バージョン 30.0 以降で使用できます。

LogoutUrl
url
プロパティ
Create、Filter、Nillable、Sort、Update
説明
ユーザがソーシャルサインオンを使用して認証された場合にログアウト後の特定の移動先を指定します。URL は、http または https プレフィックス (https://acme.my.salesforce.com など) で完全修飾する必要があります。API バージョン 33.0 以降で使用できます。
OptionsIncludeOrgIdInId
boolean
プロパティ
Create、Filter、Update
説明

2 つのソース (2 つの Sandbox など) からの同じユーザ ID を持つユーザを区別するための組織 ID が含まれます。Salesforce 認証プロバイダでのみ使用できます。一度 true に設定すると、false には設定できません。API バージョン 32.0 以降で使用できます。

OptionsSendAccessTokenInHeader
boolean
プロパティ
Create、Filter、Update
説明

ProviderTypeOpenIdConnect の場合にのみ必須です。true の場合、アクセストークンはクエリ文字列ではなくヘッダーで UserInfoUrl に送信されます。OpenID Connect 認証プロバイダでのみ使用されます。API バージョン 30.0 以降で使用できます。

OptionsSendClientCredentialsInHeader
boolean
プロパティ
Create、Filter、Update
説明

ProviderTypeOpenIdConnect の場合にのみ必須です。true の場合、クライアントログイン情報はクエリ文字列ではなくヘッダーで tokenUrl に送信されます。ログイン情報には、標準の OpenID Connect 基本ログイン情報ヘッダー形式 Basic <token> が使用されます。ここで <token> は、base64 符号化文字列 "clientkey:clientsecret" です。OpenID Connect 認証プロバイダでのみ使用されます。API バージョン 30.0 以降で使用できます。

ProviderType
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort、Update
説明
必須。使用するサードパーティのシングルサインオンプロバイダ。有効な値は、次のとおりです。
  • Facebook
  • Salesforce
  • Janrain
  • LinkedIn (API バージョン 32.0 以降で使用可能)
  • Twitter (API バージョン 32.0 以降で使用可能)
  • OpenIdConnect (API バージョン 29.0 以降で使用可能)

    この型には、次の項目に値が必要です。

    • AuthorizeUrl
    • DefaultScopes
    • TokenUrl
    • UserInfoUrl

    メモ

  • 通常、MicrosoftACS Microsoft アクセスコントロールサービスは、SharePoint® Online などの Microsoft Office 365 サービスの認証を提供します (API バージョン 31.0 以降で使用可能)。
  • GitHubGitHub プロバイダを使用し、OAuth を使用して Force.com アプリケーションのユーザを GitHub にログインします。GitHub にログインすると、アプリケーションで GitHub API をコールできます。GitHub プロバイダはシングルサインオンプロバイダとしては使用できません。つまり、ユーザが GitHub ログイン情報を使用して Salesforce 組織にログインすることはできません (API バージョン 35.0 以降で使用可能)。
  • Custom (API バージョン 36.0 以降で使用可能)
PluginId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
Auth.AuthProviderPlugin インターフェースを実装する既存の Apex クラス。API バージョン 36.0 以降で利用できます。
RegistrationHandlerId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明

Auth.RegistrationHandler インターフェースを実装する既存の Apex クラス。

TokenUrl
url
プロパティ
Create、Filter、Nillable、Sort、Update
説明
ProviderTypeOpenIdConnect である場合にのみ必須です。OAuth トークンエンドポイント URL。OpenID Connect 認証プロバイダでのみ使用されます。API バージョン 29.0 以降で利用できます。
UserInfoUrl
url
プロパティ
Create、Filter、Nillable、Sort、Update
説明

Provider-typeOpenIdConnect である場合にのみ必須です。OpenID Connect エンドポイント URL。OpenID Connect 認証プロバイダでのみ使用されます。API バージョン 29.0 以降で利用できます。