• Public
  • Public/Protected
  • All

A LaunchDarkly user object.


  • LDUser



Optional anonymous

anonymous: undefined | false | true

If true, the user will not appear on the Users page in the LaunchDarkly dashboard.

Optional avatar

avatar: undefined | string

An absolute URL to an avatar image for the user.

Optional country

country: undefined | string

The country associated with the user.

Optional custom

custom: undefined | {}

Any additional attributes associated with the user.

Optional email

email: undefined | string

The user's email address.

If an avatar URL is not provided, LaunchDarkly will use Gravatar to try to display an avatar for the user on the Users page.

Optional firstName

firstName: undefined | string

The user's first name.

Optional ip

ip: undefined | string

The user's IP address.

If you provide an IP, LaunchDarkly will use a geolocation service to automatically infer a country for the user, unless you've already specified one.


key: string

A unique string identifying a user.

Optional lastName

lastName: undefined | string

The user's last name.

Optional name

name: undefined | string

The user's name.

You can search for users on the User page by name.

Optional privateAttributeNames

privateAttributeNames: Array<string>

Specifies a list of attribute names (either built-in or custom) which should be marked as private, and not sent to LaunchDarkly in analytics events. This is in addition to any private attributes designated in the global configuration with LDOptions.privateAttributeNames or LDOptions.allAttributesPrivate.

Optional secondary

secondary: undefined | string

An optional secondary key for a user.

This affects feature flag targeting as follows: if you have chosen to bucket users by a specific attribute, the secondary key (if set) is used to further distinguish between users who are otherwise identical according to that attribute.

Generated using TypeDoc