Identify Users
Identify a user
Whenever a user logs in, call the FS.identify() function to associate your own application-specific id with the active user for current and future sessions.
Parameters
- uid String required
A string containing your unique identifier for the current user.
- userVars Map optional
A Map with key/value pairs that provides additional information about your user.
Special Fields
These are reserved field names that can be included in
userVars
that have special meaning and usage.
- displayName String optional
The value of
displayNameis displayed in the session list and on the user card in the app. - email String optional
The value of
emailis used to let you email the user directly from the app. Theemailvalue can also be used to retrieve users and sessions via the Get User and List Sessions HTTP APIs.
Re-identification
Fullstory doesn't let you change the identity of a user once they have been assigned a unique user
ID using FS.identify. If you attempt to change the user id of an identified user, Fullstory will
recognize the new user ID and automatically split the session into a new session.
Limits
- Sustained calls are limited to 12 calls per minute, with a burst limit of 5 calls per second.
Additional Information
- FS.anonymize()
- Identifying users
- If you only want to pass in
userVarsyou can use the FS.setUserVars function. - Can I change a user's identity using FS.identify?
- userVars name requirements
- userVars value requirements