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

NamedCredential

指定ログイン情報を表します。指定ログイン情報では、コールアウトエンドポイントの URL と必要な認証パラメーターを 1 つの定義内に指定します。指定ログイン情報は、エンドポイントとして指定できるため、認証コールアウトの設定が簡略化されます。このオブジェクトは、API バージョン 33.0 以降で使用できます。

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。コード内の用語を変更すると、現在の実装が壊れる可能性があるため、このオブジェクトの名前は維持しました。

重要

このエンティティ内に保存されているログイン情報はすべて、プラットフォーム上のほかの暗号化フレームワークと一貫性のあるフレームワークで暗号化されます。Salesforce は、組織固有の鍵を自動作成してログイン情報を暗号化します。以前の暗号化スキームを使用して暗号化されたログイン情報は、新しいフレームワークに移行されました。

メモ

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

describeSObjects()、query()、retrieve()

特別なアクセスルール

Spring ’20 以降、このオブジェクトにアクセスできるのは、「設定・定義を参照する」権限を持つユーザーのみとなります。

項目

項目名	詳細
AuthProviderId	型 reference プロパティ Filter、Group、Nillable、Sort 説明認証プロバイダーの Salesforce ID。ログインプロセスを提供し、外部システムへのアクセスを承認するサービスを定義します。この項目を表示できるのは、「アプリケーションのカスタマイズ」権限および「認証プロバイダーの管理」権限のあるユーザーのみです。この項目はリレーション項目です。この項目は、従来の指定ログイン情報でのみ有効です。この項目は API バージョン 39.0 で初めて使用可能になりましたが、API バージョン 56.0 では非推奨になりました。リレーション名 AuthProvider リレーション種別 Lookup 参照先 AuthProvider
AuthTokenEndpointUrl	型 textarea プロパティ Nillable 説明 JSON Web トークン (JWT) をアクセストークンと交換する場所の URL。この項目は、従来の指定ログイン情報でのみ有効です。この項目は API バージョン 46.0 で初めて使用可能になりましたが、API バージョン 56.0 では非推奨になりました。
CalloutOptionsAllowMergeFieldsInBody	型 boolean プロパティ Filter 説明 Apex コールアウトの場合、コードで差し込み項目を使用して HTTP リクエストボディに組織データを入力できるかどうかを示します。この項目は、API バージョン 35.0 以降で使用できます。
CalloutOptionsAllowMergeFieldsInHeader	型 boolean プロパティ Filter 説明 Apex コールアウトの場合、コードで差し込み項目を使用して HTTP ヘッダーに組織データを入力できるかどうかを示します。この項目は、API バージョン 35.0 以降で使用できます。
CalloutOptionsGenerateAuthorizationHeader	型 boolean プロパティ Filter 説明 Salesforce で、指定ログイン情報で定義されたエンドポイントへの各コールアウトの標準認証ヘッダーを自動的に生成するかどうかを示します。この項目は、API バージョン 35.0 以降で使用できます。
DeveloperName	型 string プロパティ Filter、Group、Sort 説明 API のオブジェクトの一意の名前。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。管理パッケージでこの項目を使用することにより、パッケージインストール時の名前の競合を回避します。この項目を使用して、開発者は管理パッケージのオブジェクト名を変更し、変更はサブスクライバーの組織で反映されます。「DeveloperName を表示」または「設定・定義を参照する」権限を持っているユーザーのみがこの項目の表示、グループ化、並べ替え、絞り込みを行えます。
Endpoint	型 textarea プロパティ Nillable 説明エンドポイントのルート URL。この項目は、従来の指定ログイン情報でのみ有効です。この項目は API バージョン 56.0 では非推奨です。
JwtAudience	型 textarea プロパティ Nillable 説明 JSON Web トークンの外部サービスまたはその他の許可された受信者。JSON として記述され、単一の利用者では文字列が引用符で囲まれ、複数の利用者では文字列が引用符で囲まれて配列となります。単一の利用者の例: `“aud1”`。複数の利用者の例:: `[”aud1”, “aud2”, “aud3”]`。この項目は、従来の指定ログイン情報でのみ有効です。この項目は API バージョン 46.0 で初めて使用可能になりましたが、API バージョン 56.0 では非推奨になりました。
JwtFormulaSubject	型 string プロパティ Filter、Group、Nillable、Sort 説明 JSON Web トークンの件名を計算する数式文字列。単一引用符付きの API 参照名と定数文字列を含めることができます。トークンを要求するユーザーごとに一意な動的な件名が使用できます。たとえば、`'User='+$User.Id` です。この項目は、PrincipalType が `PerUser` に設定されている場合に使用します。ユーザーインターフェースの [ユーザーごとの件名] に対応します。この項目は、従来の指定ログイン情報でのみ有効です。この項目は API バージョン 46.0 で初めて使用可能になりましたが、API バージョン 56.0 では非推奨になりました。
JwtIssuer	型 string プロパティ Filter、Group、Nillable、Sort 説明大文字と小文字を区別する文字列を使用して JSON Web トークンの発行者を指定します。この項目は、従来の指定ログイン情報でのみ有効です。この項目は API バージョン 46.0 で初めて使用可能になりましたが、API バージョン 56.0 では非推奨になりました。
JwtTextSubject	型 string プロパティ Filter、Group、Nillable、Sort 説明 JSON Web トークンの件名を指定する引用符なしの静的テキスト。この項目は、PrincipalType が `NamedUser` に設定されている場合に使用します。ユーザーインターフェースの [指定ユーザーの件名] に対応します。この項目は、従来の指定ログイン情報でのみ有効です。この項目は API バージョン 46.0 で初めて使用可能になりましたが、API バージョン 56.0 では非推奨になりました。
JwtValidityPeriodSeconds	型 int プロパティ Filter、Group、Nillable、Sort 説明 JSON Web トークンが有効な秒数。この項目は、従来の指定ログイン情報でのみ有効です。この項目は API バージョン 46.0 で初めて使用可能になりましたが、API バージョン 56.0 では非推奨になりました。
Language	型 picklist プロパティ Filter、Group、Restricted picklist、Sort 説明 MasterLabel の言語。
MasterLabel	型 string プロパティ Filter、Group、Sort 説明指定ログイン情報の表示ラベル。この表示値は、翻訳されない内部ラベルです。
NamespacePrefix	型 string プロパティ Filter、Group、Nillable、Sort 説明このオブジェクトと関連付けられた名前空間プレフィックス。管理パッケージを作成する Developer Edition 組織ごとに一意の名前空間プレフィックスがあります。最大 15 文字です。`namespacePrefix__componentName` 表記を使用して、管理パッケージのコンポーネントを参照できます。
PrincipalType	型 picklist プロパティ Filter、Group、Restricted picklist、Sort 説明外部システムにアクセスするユーザーを追跡します。`Anonymous` は、外部システムアクセスに対してユーザー ID が指定されていないことを意味します。`Named Principal` は、外部システムにアクセスするすべてのユーザーに対して 1 つのユーザー ID を使用します。この項目は、従来の指定ログイン情報でのみ有効です。この項目は API バージョン 56.0 では非推奨です。

使用方法

組織の指定ログイン情報を照会するには、NamedCredential オブジェクトを使用します。

一部の指定ログイン情報項目では、外部システムへの接続にユーザー単位の認証が使用されます。システム管理者がこのいずれかの項目を編集すると、以前に認証されたログイン情報が無効になり、個々のユーザーの再認証が必要になる可能性があります。

メモ

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

NamedCredential

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

特別なアクセスルール

項目

使用方法

関連項目: