Identify Users

id

Your internal identifier for the user.

username

The username. Typically used as a better label than the internal id.

name

The user's first and/or last name.

email

An alternative, or addition, to the username. Sentry is aware of email addresses and can display things such as Gravatars and unlock messaging capabilities.

segment

The user segment, for apps that divide users in user segments.

ip_address

The user's IP address. If the user is unauthenticated, Sentry uses the IP address as a unique identifier for the user. Serverside SDKs that instrument incoming requests will attempt to pull the IP address from the HTTP request data (request.env.REMOTE_ADDR field in JSON), if available. That might require sendDefaultPii set to `true` in the SDK options.

If the user's ip_address is set to "{{auto}}", Sentry will infer the IP address from the connection between your app and Sentry's server.

If the field is omitted, the default value is null. However, due to backwards compatibility concerns, certain platforms (in particular JavaScript) have a different default value for "{{auto}}". SDKs and other clients should not rely on this behavior and should set IP addresses or "{{auto}}" explicitly.

To opt out of storing users' IP addresses in your event data, you can go to your

settings, click on "Security & Privacy", and enable "Prevent Storing of IP Addresses" or use Sentry's server-side data scrubbing to remove $user.ip_address. Adding such a rule ultimately overrules any other logic.

import 'package:sentry/sentry.dart';

Sentry.configureScope(
  (scope) => scope.setUser(SentryUser(id: '1234', email: 'jane.doe@example.com')),
);

import 'package:sentry/sentry.dart';

Sentry.configureScope((scope) => scope.setUser(null));