Salesforce および Force.com のオブジェクトリファレンス
jLoginEvent
サポートされているコール
query()
特別なアクセスルール
このオブジェクトにアクセスするには、「イベントログファイルを参照」��よび「API の有効化」ユーザ権限が必要です。
項目
| 項目 | 詳細 |
|---|---|
| AdditionalInfo |
|
| ApiType |
|
| ApiVersion |
|
| Application |
|
| AuthServiceId |
|
| Browser |
|
| ClientVersion |
|
| EventDate |
|
| LoginGeoId |
|
| LoginHistoryId |
|
| LoginType |
|
| LoginUrl |
|
| Platform |
|
| SourceIp |
|
| Status |
|
| UserId |
|
| Username |
|
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 ～ 29 文字にする必要があります。
- 先頭が x-sfdc-addinfo- でない項目名は無視されます。
- x-sfdc-addinfo- より後に無効な文字が含まれる名前は無視されます。
- 最初の有効な 30 個の項目名のみが AdditionalInfo に保存されます。項目名は、認証に渡されたのと同じ順序で保存されるとは限りません。
項目値を決定する場合は、次の点に注意してください。
- 既存の API 項目名は HTTP ヘッダー内の AdditionalInfo 名に使用できません。AdditionalInfo 名がオブジェクトの API 名と競合した場合、項目値は保存されません。たとえば、X-SFDC-ADDINFO-UserId='abc123' という HTTP ヘッダーは AdditionalInfo に保存されません。
- 追加項目値には、英数字、「_」、「-」文字のみを使用できます。
- 項目値は 255 文字以下にする必要があります。項目値が 255 文字を超えた場合、最初の 255 文字のみが保存され、残りは切り捨てられます。
- 無効な文字を含む項目値は保存されますが、項目ヘッダーが空の文字列 ("") になります。
- 最初の有効な 30 個の項目名のみが AdditionalInfo 項目に保存されます。項目名は、認証に渡されたのと同じ順序で保存されるとは限りません。
- AggregationFieldName または PlatformEventMetrics が SourceIp の場合、値が Salesforce.com IP の AggregationFiledValue を絞り込めません。
HTTP と cURL を使用して追加情報を渡す方法
次に、コマンドラインを介して追加情報を渡す例を示します。
1curl https://yourInstance.salesforce.com/services/oauth2/token -d "grant_type=password" -d
2"client_id=3MVG9PhR6g6B7ps4RF_kNPoWSxVQstrazijsE8njPtkpUzVPPffzy8
3jIoRE6q9rPznNtlsqbP9ob8kUfMjXXX" -d "client_secret=4180313776440635XXX" -d
4"username=user@company.com" -d "password=123456" -H "X-PrettyPrint:1" -H
5"x-sfdc-addinfo-correlationid:
6d18c5a3f-4fba-47bd-bbf8-6bb9a1786624"Java で追加情報を渡す方法
次に、Java で追加情報を渡す例を示します。
1//adding additional info headers ..
2Map<String, String> httpHeaders = new HashMap<String,String>();
3httpHeaders.put("x-sfdc-addinfo-fieldname1" /* additional info field*/ ,
4"d18c5a3f-4fba-47bd-bbf8-6bb9a1786624" /* value*/);
5httpHeaders.put("x-sfdc-addinfo-fieldname2" /* additional info field*/ ,
6"d18c5a3f-4fba-47bd-bbf8-6bb9a1786624" /* value*/);
7ConnectorConfig config = new ConnectorConfig();
8config.setUsername(userId);
9config.setPassword(passwd);
10config.setAuthEndpoint(authEndPoint);
11config.setProxy(proxyHost, proxyPort);
12//setting additional info headers
13for (Map.Entry<String, String> entry : httpHeaders.entrySet()) {
14config.setRequestHeader(entry.getKey(), entry.getValue());
15}
16// Set the username and password if your proxy must be authenticated
179
18LoginEvent
19config.setProxyUsername(proxyUsername);
20config.setProxyPassword(proxyPassword);
21try {
22EnterpriseConnection connection = new EnterpriseConnection(config);
23// etc.
24} catch (ConnectionException ce) {
25ce.printStackTrace();
26}