Skip to navigation

User Data

After a successful login or registration, the SDK keeps the current identity data available on its client object. Read it wherever your app needs to show the signed-in person’s details. It is cleared when the person signs out or AuthlyX confirms that access has ended. The exact access syntax differs by language, as shown below.

The exact object shape depends on the language. The API fields use camelCase. C# exposes a typed UserData object with PascalCase properties. C++, Python, JavaScript, TypeScript, and Go keep the API fields and add a smaller set of PascalCase aliases. Java and Rust expose the API fields directly.

Fields you can read

API fieldC# propertyWhat it contains
identityIdIdID of the signed-in record. C# reads this from the login response envelope.
typeLoginTypeuser, license, or device, describing how this identity is stored.
nameUsernameName for this login. C# and the alias-enabled SDKs set Username only for user accounts.
licenseKeyLicenseKeyLinked key when this identity has one. It can be empty for device login. Treat it as private account data.
emailEmailEmail saved on the user record, if one was provided.
systemIdSID, HwidDevice identifier used for this sign-in, when applicable.
planPlan, SubscriptionPlan name assigned to the identity.
expiryExpiryDateAccess expiration time, or null for lifetime access. C# also exposes IsLifetime, calculated from this value.
deviceLimitDeviceLimitNumber of devices allowed for this identity.
registeredAtRegisteredAtWhen the identity was created, when the server has that date.
lastLoginLastLoginMost recent successful login time.
ipAddressIpAddressAddress observed by AuthlyX during sign-in. Avoid showing it unless your app needs it.
countryCountryApproximate country derived from that address. It is not GPS or a precise location.
featuresFeaturesNames of enabled Boolean features inherited from the plan or set on this identity. Expired features are omitted.
featureValuesFeatureValuesCurrent feature values, including text and numbers. Identity values override plan defaults.
metadataMetadataPublic metadata allowed for SDK access. Private metadata is not sent to the customer app.

The C++, Python, JavaScript, TypeScript, and Go SDKs currently add these PascalCase aliases: Username, LicenseKey, SID, Email, Plan, ExpiryDate, Country, IpAddress, and DeviceLimit. Their raw API fields, including features, featureValues, metadata, registeredAt, and lastLogin, remain camelCase. Java and Rust use the raw API names. C# exposes the typed properties shown in the table, plus Hwid as an alias for SID and Subscription as an alias for Plan.

Some fields do not apply to every sign-in. For example, a device identity may not have a username, email, or license key. Do not assume an empty field means the login failed.

Example data

This is an example of the identity information returned after a successful sign-in. The values are illustrative; your app receives its own account data.

{
"type": "user",
"name": "maya",
"licenseKey": "MAYA-4R8P-2N6K-9Q3W",
"email": "maya@example.com",
"systemId": "S-1-5-21-1938475620-2719458301-1209384756-1001",
"plan": "Plus",
"expiry": "2027-04-30T23:59:59.000Z",
"deviceLimit": 3,
"registeredAt": "2026-08-12T14:22:10.000Z",
"lastLogin": "2026-10-28T18:41:32.000Z",
"ipAddress": "203.0.113.42",
"country": "NG",
"features": ["exportPdf", "cloudSync"],
"featureValues": {
"videoQuality": "4K",
"monthlyExports": 250
},
"metadata": {
"customerTier": "studio"
}
}

Read values in your app

The SDK stores this data after login. These examples read it; they do not make another API request.

var username = app.userData.Username;
var plan = app.userData.Plan;
var expiry = app.userData.ExpiryDate;
var features = app.userData.Features;
var videoQuality = app.userData.FeatureValues["videoQuality"];

Use Check session when you need current authorization. User Data is convenient account information; it is not a substitute for a session check or a server-side permission check.