Newer Version Available

This content describes an older version of this product. View Latest

Platform Encryption Event Type

Platform Encryption event contains information about tenant secret and derived encryption key usage. This event type is available in API versions 41.0 and later.

For details about event monitoring, see the Trailhead Event Monitoring module or REST API Developer’s Guide.

Fields

Field Details
ACTION
Type
String
Description
The name and type of the event.
Possible Values
  • TS Imported: A tenant secret generated by the Shield Key Management Service (KMS), or customer-supplied key material, imported by a customer.
  • TS Generated: A tenant secret generated by the Shield Key Management Service (KMS).
  • Key Derived: An encryption key derived from a tenant secret for encryption or decryption.
  • TS Wrapped: A tenant secret generated by the Shield Key Management Service (KMS), or customer-supplied key material, encrypted for storage.
  • Key Delivered: A data encryption key delivered for encryption or decryption.
  • TS Stored: A tenant secret generated by the Shield Key Management Service (KMS), or customer-supplied key material, stored encrypted in the database.
  • TS Read: An encrypted tenant secret generated by the Shield Key Management Service (KMS), or encrypted customer-supplied key material, that is loaded for encryption or decryption.
  • TS Unwrapped: An encrypted tenant secret generated by the Shield Key Management Service (KMS), or encrypted customer-supplied key material, unwrapped for use by the KMS.
  • TS Exported: An encrypted tenant secret exported by a customer.
  • TS Destroyed: A tenant secret and related data encryption key destroyed by a customer.
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
EVENT_TYPE
Type
String
Description
The type of event. The value is always PlatformEncryption.
KEY_ID
Type
String
Description
The 15-character ID of the tenant secret.
Example
02GD000000096Cb
KEY_ID_DERIVED
Type
String
Description
The 18-character ID of the derived encryption key.
Example
02GD000000096CbMAI
KEY_TYPE
Type
String
Description
The type of tenant secret.
Possible Values
  • Data
  • DeterministicData
  • EinsteinAnalytics
  • SearchIndex
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
METHOD
Type
String
Description
The string that identifies a change in tenant secret Active state. For example, tenant secrets become active when they are created, and are made inactive when they are exported.
Examples
  • TS Exported: User ID
  • TS Generated: HSM or BYOK
  • TS Unwrapped: Tenant Secret or BYOK
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.