Skip to main content

UserSessionInfo

Package: @nauth-toolkit/client Type: Response

User session information returned from session listing endpoints. Contains device details, location information, and authentication metadata.

import { UserSessionInfo } from '@nauth-toolkit/client';

Properties

PropertyTypeDescription
authMethodstring | nullAuthentication method used for this session (e.g., 'password', 'social', 'admin', 'admin-social')
authProviderstring | nullOAuth provider name (only present for social logins, e.g., 'google', 'facebook', 'github', 'apple')
browserstring | nullBrowser name
createdAtDate | stringSession creation timestamp
deviceIdstring | nullDevice ID
deviceNamestring | nullDevice name
deviceTypestring | nullDevice type
expiresAtDate | stringSession expiration timestamp
ipAddressstring | nullIP address
ipCitystring | nullIP city location
ipCountrystring | nullIP country location
isCurrentbooleanWhether this is the current session
isRememberedbooleanWhether session is remembered
lastActivityAtDate | stringLast activity timestamp
platformstring | nullPlatform name
sessionIdstringSession ID

Example

{
"sessionId": "sess_abc123",
"deviceId": "dev_xyz789",
"deviceName": "Chrome on Mac",
"deviceType": "desktop",
"platform": "macOS",
"browser": "Chrome",
"ipAddress": "192.168.1.1",
"ipCountry": "US",
"ipCity": "San Francisco",
"lastActivityAt": "2024-01-15T12:30:00.000Z",
"createdAt": "2024-01-15T10:00:00.000Z",
"expiresAt": "2024-01-16T10:00:00.000Z",
"isRemembered": true,
"isCurrent": true,
"authMethod": "password",
"authProvider": null
}

Social login session:

{
"sessionId": "sess_def456",
"deviceId": null,
"deviceName": "Mobile Safari",
"deviceType": "mobile",
"platform": "iOS",
"browser": "Safari",
"ipAddress": "10.0.0.1",
"ipCountry": "CA",
"ipCity": "Toronto",
"lastActivityAt": "2024-01-15T11:00:00.000Z",
"createdAt": "2024-01-15T09:00:00.000Z",
"expiresAt": "2024-01-16T09:00:00.000Z",
"isRemembered": false,
"isCurrent": false,
"authMethod": "social",
"authProvider": "google"
}

Used By