LoginAsEvent

Supported Calls

describeSObjects(), query()

Special Access Rules

Accessing this object requires either the Salesforce Shield or Salesforce Event Monitoring add-on subscription and the View Data Leakage Detection Events user permission.

Fields

Field	Details
Application	Type string Properties Nillable Description The application name in English. For example, Salesforce Internal Application, or Microsoft SOAP Toolkit.
Browser	Type string Properties Nillable Description The browser name and version if known. If no browser or version number is available, “Unknown” is returned. Product names are in English. For example, “Chrome 64”.
DelegatedOrganizationId	Type string Properties Nillable Description Organization Id of the admin who performs logs in as another user. For example, 00Dxx0000001gEH
DelegatedUsername	Type string Properties Nillable Description Username of the admin who logs in as another user. For example, admin@company.com
EventDate	Type dateTime Properties Filter, Sort Description The time and date of the event. For example, 2013-01-01T03:01:01Z. Seconds are the most granular setting.
EventIdentifier	Type string Properties Filter, Sort Description The unique identifier for each record in LoginAsEvent. Use this field as the primary key in your queries.
LoginAsCategory	Type picklist Properties Nillable, Restricted picklist Description Represents how the user logs in as another user. For example, OrgAdmin, or Community.
LoginHistoryId	Type reference Properties Nillable Description The ID from the LoginHistory entity associated with this login event. Tracks a user session so you can correlate user activity with a particular login instance. For example, 0Yaxx0000000019.
LoginKey	Type string Properties Nillable Description The string that ties together all events in a given user’s login session. The session starts with a login event and ends with either a logout event or the user session expiring. For example, 8gHOMQu+xvjCmRUt.
LoginType	Type picklist Properties Nillable, Restricted picklist Description The event’s type of login. For example, “Application.”
Platform	Type string Properties Nillable Description The platform name and version that are used during the login event. If no platform name is available, “Unknown” is returned. Platform names are in English. For example, “Mac OSX”.
SessionKey	Type string Properties Nillable Description The user’s unique session ID. 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 LoginAsEvent, this field is usually null because the event is captured before a session is created.
SessionLevel	Type picklist Properties Nillable, Restricted picklist Description Session-level security controls user access to features that support it, such as connected apps and reporting. Possible values are: HIGH_ASSURANCE - A high assurance session was used for resource access. For example, when the user tries to access a resource such as a connected app, report, or dashboard that requires a high-assurance session level. LOW - The user’s security level for the current session meets the lowest requirements. This low level is not available, nor used, in the Salesforce UI. User sessions through the UI are either standard or high assurance. You can set this level using the API, but users assigned this level will experience unpredictable and reduced functionality in their Salesforce org. Note STANDARD - The user’s security level for the current session meets the Standard requirements set in the current organization Session Security Levels.
SourceIp	Type string Properties Nillable Description The source IP address of the client logging in. For example, 126.7.4.2.
TargetUrl	Type string Properties Nillable Description The URL redirected to after logging in as another user succeeds.
UserId	Type reference Properties Nillable Description Unique ID that identifies the user who is being logged in as by the admin. For example, 005000000000123.
Username	Type string Properties Nillable Description Username of the user who is being logged in as by the admin, in the format of someuser@company.com.
UserType	Type picklist Properties Nillable, Restricted picklist Description The category of user license of the user who is being logged in as by the admin. Each UserType is associated with one or more UserLicense records. Each UserLicense is associated with one or more profiles. Valid values are: CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. CspLitePortal—CSP Lite Portal license. Users whose access is limited because they are organization customers and access the application through a customer portal or community. CustomerSuccess—Customer Success license. Users whose access is limited because they are organization customers and access the application through a customer portal. Guest PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because they are organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. PowerPartner—Power Partner license. Users whose access is limited because they are partners and typically access the application through a partner portal or community. SelfService Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, as well as admins for this org.

Standard SOQL Usage

Currently, the only supported SOQL function on LoginAsEvent is WHERE, and you can only use comparison operators (=, <, >, <=, and >=) on the final expression in a WHERE clause. The != operator isn’t supported.

Date functions such as convertTimezone() aren’t supported. For example, SELECT CALENDAR_YEAR(EventDate), Count(EventIdentifier) FROM LoginAsEvent GROUP BY CALENDAR_YEAR(EventDate) returns an error. You can use date literals in your queries and some date and date/time functions like TODAY, YESTERDAY, and LAST_n_DAYS:1. However, these functions use comparison operators behind the scenes. This means you can only use them in the final expression of a WHERE clause.

Note

LoginAsEvent allows filtering over two ordered fields: EventDate and EventIdentifier. There’s a catch here; your query won’t work unless you use the correct order and combination of these fields. The following list provides some examples of valid and invalid queries:

Unfiltered
- Valid—Contains no WHERE clause, so no special rules apply.
Filtered on EventDate
- Valid—You can filter solely on EventDate, but single filters on other fields fail. You can also use a comparison operator in this query type.
- Valid—You can filter on EventDate using date literals.
Filtered on EventDate and EventIdentifier
- Valid—Successful queries on LoginAsEvent filter over both fields.
- Invalid—Queries on LoginAsEvent with EventDate and standard date literals.
- Invalid—Filtering only on EventDate with <= or >= operator and EventIdentifier field isn’t supported.

Async SOQL Usage

With Async SOQL, you can filter on any field in LoginAsEvent and use any comparison operator in your query.

Example: Get yesterday's LoginAs events where an Org Admin is logging into the portal as another user.

SELECT DelegatedUsername, DelegatedOrganizationId, EventDate, LoginAsCategory, LoginHistoryId, LoginType, SourceIp, TargetUrl, UserId, Username, UserType FROM LoginAsEvent WHERE EventDate=Yesterday AND LoginAsCategory=’OrgAdmin’

Platform Events Developer Guide

Supported Calls

Special Access Rules

Fields

Standard SOQL Usage

Async SOQL Usage

See Also