LoginEvent

このオブジェクトは、API バージョン 36.0 以降で使用できます。

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

query()

特別なアクセスルール

このオブジェクトにアクセスするには、「イベントログファイルを参照」および「API の有効化」ユーザ権限が必要です。

項目

項目	詳細
AdditionalInfo	型 string プロパティ Nillable、Sort 説明ログイン要求中に `HTTP` ヘッダーから取得した追加情報を JSON に逐次化したもの。たとえば、`{"field1": "value1","field2": "value2"}` です。「AdditionalInfo の使用」を参照してください。
ApiType	型 string プロパティ Nillable、Sort 説明英語のみ。ログインに使用される API の種別。次のような値があります。 `XML-RPC` `OSOAP` `SOAP Enterprise` `SOAP Partner` `SOAP Internal/CrossInstance` `REST API` `メタデータ API` `N/A`
ApiVersion	型 string プロパティ Nillable、Sort 説明英語のみ。API のバージョン番号。バージョン番号が不明の場合は、「Unknown」が返されます。
Application	型 string プロパティ Nillable、Sort 説明アプリケーション名 (英語)。たとえば、Salesforce Internal Application や Microsoft SOAP Toolkit などです。
AuthServiceId	型 reference プロパティ Nillable、Sort 説明 LoginHistory オブジェクトの AuthenticationServiceId 項目を参照してください。たとえば、この項目を使用して、ユーザのログインに使用された SAML または認証プロバイダ設定を識別できます。
Browser	型 string プロパティ Nillable、Sort 説明ブラウザの名前とバージョン (わかっている場合)。ブラウザまたはバージョン番号が不明の場合は、「Unknown」が返されます。製品名は英語で記述されます。
ClientVersion	型 string プロパティ Nillable、Sort 説明英語のみ。ログインクライアントのバージョン番号。バージョン番号が不明の場合は、「Unknown」が返されます。
EventDate	型 dateTime プロパティ Filter、Nillable、Sort 説明指定されたイベントのログイン時刻。たとえば、2013-01-01T03:01:01Z のようになります。最も細かい設定は秒です。
LoginGeoId	型 reference プロパティ Nillable、Sort 説明ログインユーザの IP アドレスに関連付けられている LoginGeo オブジェクトの Salesforce ID。
LoginHistoryId	型 reference プロパティ Nillable、Sort 説明ユーザアクティビティと特定のログインインスタンスを関連付けられるように、ユーザセッションを追跡します。
LoginType	型 string プロパティ Nillable、Restricted picklist、Sort 説明イベントのログイン種別。たとえば「Application」などです。
LoginUrl	型 string プロパティ Nillable、Sort 説明ログインホストの URL。たとえば、`na1.salesforce.com` です。
Platform	型 string プロパティ Nillable、Sort 説明ログインイベント中に使用されるプラットフォームの名前とバージョン。プラットフォーム名が不明の場合は、「Unknown」が返されます。プラットフォーム名は英語で記述されます。
SourceIp	型 string プロパティ Nillable、Sort 説明ログインしているクライアントのソース IP アドレス。たとえば、126.7.4.2 です。
Status	型 string プロパティ Nillable、Sort 説明ログイン状況は英語で記述されます。成功したときは「Success」が返されます。それ以外の場合は、エラーメッセージが返されます。
UserId	型 ID プロパティ Nillable、Sort 説明ユーザの一意の ID。たとえば、005000000000123 です。
Username	型 string プロパティ Nillable、Sort 説明ユーザ名の形式は user@company.com です。

AdditionalInfo の使用

AdditionalInfo を使用すると、ログインイベントを拡張してカスタムデータを含めることができます。このデータは後でクエリできます。たとえば、一意の相関 ID を共有する外部システムからユーザがログインしたときに、その ID を取得できます。このプロセスにより、システム間でログインを追跡できます。LoginEvent を使用してデータを保存するには、すべての AdditionalInfo 項目名の先頭を x-sfdc-addinfo-{fieldname} にします。たとえば、有効な項目割り当ては、x-sfdc-addinfo-correlation_id = ABC123 です。ここで、x-sfdc-addinfo-correlation_id は項目名、ABC123 は項目値です。

項目名を定義するときには、次の点に注意してください。

x-sfdc-addinfo- は大文字と小文字を区別しません。x-sfdc-addinfo-{field name} は、X-SFDC-ADDINFO-{FIELD NAME} と同じです。
項目には、英数字と「_」(アンダースコア) 文字のみを使用できます。
項目名は、x-sfdc-addinfo- を含めずに 2 ～ 30 文字にする必要があります。
先頭が x-sfdc-addinfo- でない項目名は無視されます。
x-sfdc-addinfo- より後に無効な文字が含まれる名前は無視されます。
最初の有効な 30 個の項目名のみが AdditionalInfo に保存されます。項目名は、認証に渡されたのと同じ順序で保存されるとは限りません。

項目値を決定する場合は、次の点に注意してください。

既存の API 項目名は HTTP ヘッダー内の AdditionalInfo 名に使用できません。AdditionalInfo 名がオブジェクトの API 名と競合した場合、項目値は保存されません。たとえば、SFDC_ADD_INF_UserId='abc123' という HTTP ヘッダーは AdditionalInfo に保存されません。
追加項目値には、英数字、「_」、「-」文字のみを使用できます。
項目値は 255 文字以下にする必要があります。項目値が 255 文字を超えた場合、最初の 255 文字のみが保存され、残りは切り捨てられます。
無効な文字を含む項目値は保存されますが、項目ヘッダーが空の文字列 ("") になります。
最初の有効な 30 個の項目名のみが AdditionalInfo 項目に保存されます。項目名は、認証に渡されたのと同じ順序で保存されるとは限りません。
AggregationFieldName または PlatformEventMetrics が SourceIp の場合、値が Salesforce.com IP の AggregationFiledValue を絞り込めません。

HTTP と cURL を使用して追加情報を渡す方法

次に、コマンドラインを介して追加情報を渡す例を示します。

Java で追加情報を渡す方法

次に、Java で追加情報を渡す例を示します。

Salesforce および Force.com のオブジェクトリファレンス

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

特別なアクセスルール

項目

AdditionalInfo の使用

HTTP と cURL を使用して追加情報を渡す方法

Java で追加情報を渡す方法

SOQL 使用状況