⏱ Estimated Time To Completion: 2 minutes

Overview of User Fields

Users in Decipher are identified by at least one of the following fields:

  • id: Your internal identifier for the user.
  • username: The username, typically used as a more readable label than the internal id.
  • email: The user’s email address. This is useful for messaging.
  • ip_address: The user’s IP address. If the user is unauthenticated, Decipher uses the IP address as a unique identifier. For server-side SDKs, this is often pulled from the HTTP request data.

You can also provide additional key/value pairs beyond these reserved names, and Decipher will store them with the user information.

Anywhere in your application where you have user information, call the setUser (or set_user, depending on language) method.

// Set user information in Sentry for TypeScript
Sentry.setUser({
  id: "unique_user_id",
  email: "jane.doe@example.com",
  username: "username",
  // Additional user information can be added here
});