{"id":"sforce_api_objects_authsession","title":"AuthSession","content":"

AuthSession

\n
\nThe AuthSession object represents an individual user session in your\n organization. This object is available in versions 29.0 and later.
\n\n
\n

Supported Calls

\n\n \n

delete(), describeSObjects(), query(), retrieve()

\n\n
\n\n
\n

Fields

\n\n \n \n
\n \n \n \n \n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n
Field NameDetails
CreatedDate\n
\n \n
Type
\n\n
dateTime
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Sort
\n\n \n \n
Description
\n\n
The date and time this session was created. This field is a standard system\n field.
\n\n \n
\n\n
Id\n
\n \n
Type
\n\n
id
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, ID Lookup, Sort
\n\n \n \n
Description
\n\n
The current session’s ID.
\n\n \n
\n\n
IsAssociatedWithJwtAccessToken\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, the session is associated with a\n JSON Web Token (JWT)-based access token. This field is available in API version\n 64.0 and later.
\n\n \n
\n\n
IsCurrent\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
\nIf true, the session is a member of the\n user’s current session family. This field is available in API version 37.0 and\n later.
\n\n \n
\n\n
LastModifiedDate\n
\n \n
Type
\n\n
dateTime
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Sort
\n\n \n \n
Description
\n\n
The date and time this session was last updated. A session expires when the current\n date and time equals LastModifiedDate +\n NumSecondsValid. This field is a standard system field.
\n\n \n
\n\n
LoginGeoId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The 18-character ID for the record of the geographic location of the user for a login\n event. Due to the nature of geolocation technology, the accuracy of geolocation fields\n (for example, country, city, postal code) can vary. This field is available in API\n version 34.0 and later.
\n\n
This is a relationship field.
\n\n \n \n
Relationship Name
\n\n
LoginGeo
\n\n \n \n
Relationship Type
\n\n
Lookup
\n\n \n \n
Refers To
\n\n
LoginGeo
\n\n \n
\n\n
LoginHistoryId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The 18-character ID for a successful login event. When a session is reused, Salesforce\n updates the LoginHistoryId with the value from\n the most recent login. This field is available in API version 33.0 and later.
\n\n
This is a relationship field.
\n\n \n \n
Relationship Name
\n\n
LoginHistory
\n\n \n \n
Relationship Type
\n\n
Lookup
\n\n \n \n
Refers To
\n\n
LoginHistory
\n\n \n
\n\n
LoginType\n
\n \n
Type
\n\n
picklist
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Restricted picklist, Sort
\n\n \n \n
Description
\n\n
\nThe type of login used to access the session. Possible\n values are:
    \n
  • AJAX Toolkit
    • \n\n
  • Apex Office Toolkit
    • \n\n
  • AppExchange
    • \n\n
  • Application
    • \n\n
  • AppStore
    • \n\n
  • Certificate-based login
    • \n\n
  • Chatter Communities External User
    • \n\n
  • Chatter Communities External User Third Party\n SSO
    • \n\n
  • Community
    • \n\n
  • Customer Service Portal Third-Party SSO
    • \n\n
  • Customer Service Portal
    • \n\n
  • DataJunction
    • \n\n
  • DB Replication
    • \n\n
  • Employee Login to Community
    • \n\n
  • Excel Integration
    • \n\n
  • Help and Training
    • \n\n
  • HOTP YubiKey
    • \n\n
  • Lightning Login
    • \n\n
  • Networks Portal API Only
    • \n\n
  • Offline Client
    • \n\n
  • Order Center
    • \n\n
  • Other Apex API
    • \n\n
  • Outlook Integration
    • \n\n
  • Partner Portal Third-Party SSO
    • \n\n
  • Partner Portal
    • \n\n
  • Partner Product
    • \n\n
  • Passwordless Login
    • \n\n
  • Remote Access 2.0
    • \n\n
  • Remote Access Client
    • \n\n
  • Sales Anywhere
    • \n\n
  • Salesforce Outlook Integration
    • \n\n
  • Salesforce.com Website
    • \n\n
  • SAML Chatter Communities External User SSO
    • \n\n
  • SAML Customer Service Portal SSO
    • \n\n
  • SAML Idp Initiated SSO
    • \n\n
  • SAML Partner Portal SSO
    • \n\n
  • SAML Sfdc Initiated SSO
    • \n\n
  • SAML Site SSO
    • \n\n
  • Self-Service
    • \n\n
  • Signup
    • \n\n
  • Sync
    • \n\n
  • SysAdmin Switch
    • \n\n
  • Third Party SSO
    • \n\n
  • Unknown
    • \n\n
  • Validate
    • \n\n
\n
\n\n \n
\n\n
LogoutUrl\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Nillable, Sort
\n\n \n \n
Description
\n\n
The page or view to display after users log out of an Experience Cloud site, or an org\n if they authenticated using SAML. This field is available in API version 32.0 and\n later.
\n\n \n
\n\n
NumSecondsValid\n
\n \n
Type
\n\n
int
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The number of seconds before the session expires, starting from the last update\n time.
\n\n \n
\n\n
ParentId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The 18-character ID for the parent session, if one exists (for example, if the current\n session is for a canvas app). If the current session doesn’t have a parent, this value is\n the current session’s own ID.
\n\n \n
\n\n
SessionSecurityLevel\n
\n \n
Type
\n\n
picklist
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Restricted picklist, Sort
\n\n \n \n
Description
\n\n
Standard or High, depending upon the authentication method used.
\n\n \n
\n\n
SessionType\n
\n \n
Type
\n\n
picklist
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Restricted picklist, Sort
\n\n \n \n
Description
\n\n
The type of session. Common ones are UI, Content, API, and Visualforce.
\n\n
For more information, see User Session Types in the\n Object Reference Guide.
\n\n \n
\n\n
SourceIp\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
IP address of the end user’s device from which the session started. This\n address can be an IPv4 or IPv6 address.
\n\n
The SourceIp field doesn't support the LIKE\n comparison operator.
\n\n \n
\n\n
UserType\n
\n \n
Type
\n\n
picklist
\n\n \n \n
Properties
\n\n
Filter, Group, Restricted picklist, Sort
\n\n \n \n
Description
\n\n
The kind of user for this session. Types include Standard, Partner, Customer Portal\n Manager, High Volume Portal, and CSN Only.
\n\n \n
\n\n
UsersId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The user’s Salesforce user ID.
\n\n
This is a relationship field.
\n\n \n \n
Relationship Name
\n\n
Users
\n\n \n \n
Relationship Type
\n\n
Lookup
\n\n \n \n
Refers To
\n\n
User
\n\n \n
\n\n
\n\n
\n\n
\n

Usage

\n\n \n

The AuthSession object exposes session data and enables read and delete operations on that\n data. For example, use this object to see who is signed in to your org. Or you can use this\n object to create a tool to delete a session, ending that user’s session. For a user, only their\n own sessions are available, while administrators can see all sessions.

\n\n

You can’t change user sessions with this object. You can only read and delete them.

\n\n
\n\n
"}