Managing Identities

Feature flags are great, but they can be a very blunt tool, only allowing you to enable or disable flags across your entire user base. In order to target users more precisely, and to be able to perform staged feature roll-outs or A/B and multi-variate tests, you need to Identify your Users.

Identities are created within Flagsmith automatically the first time they are identified from your client SDKs. Generally you'd make a call to identify a user with a unique string/id whenever they log into your app/site. The SDK will then send an API message to the Flagsmith API, with the relevant Identity information.

tip

The SDK part of the Flagsmith API is public by design; the Environment Key is designed to be public. When identifying users, it is important to use an Identity value that is not easy to guess. For example, if you used an incrementing integer to identify your users, it would be trivial to request Identities by enumerating this integer. This would effectively give public access to any user traits that are associated with users.

We strongly recommend using an unguessable, unidentifiable Identity Key, such as a GUID, when identifying your users, to prevent unintentionally leaking Identity trait data.

Identity Overrides

Once you have uniquely identified a user, you can then override features for that user from your environment defaults. For example, you've pushed a feature into production, but the relevant feature flag is still hiding that feature to all of your users. You can now override that flag for your own user, and test that feature. Once you are happy with everything, you can roll that feature out to all of your users by enabling the flag itself.

Identities are specific and individual for each Environment within your project. For example, joe@yourwebsite.com would be a different identity in your development environment to the one in production, and they can have different features enabled for each environment.

Identity Feature Flags

By default, Identities receive the default flags for their environment. The main use-case for identities is to be able to override flags and configs on a per-identity basis. You can do this by navigating to the Users page, finding the User and modifying their Flags.

Identity Traits

You can also use Flagsmith to store 'Traits' against identities. Traits are key/value pairs that are associated with individual Identities for a particular Environment. Traits have two purposes outlined below, but the main use case is to drive Segments.

info

The maximum size of each individual Trait Value is 2000 bytes. You cannot store more data than that in a single trait, and the API will return a 500 error if you try to do so.

Using Traits to drive Segments

Let's say you are working on a mobile app, and you want to control a feature based on the version of the application that the Identity is using. When you integrate the Flagsmith SDK, you would pass the application version number to the Flagsmith platform as a trait key/value pair:

String identifier = "user_512356"
Map<String, Object> traits = new HashMap<String, Object>();
traits.put("app_version", YourApplication.getVersion());

Flags flags = flagsmith.getIdentityFlags(identifier, traits);

Here we are setting the trait key app_version with the value of YourApplication.getVersion().You can now create a Segment that is based on the application version and manage features based on the application version.

Traits are completely free-form. You can store any number of traits, with any relevant information you see fit, in the platform and then use Segments to control features based on these Trait values.

Using Traits as a data-store

Traits can also be used to store additional data about your users that would be cumbersome to store within your application. Some possible uses for traits could be:

• Storing whether the user has accepted a new set of terms and conditions.
• Storing the last viewed page of the application so that you can resume the users place later, across any device.

Generally if they are lower-value pieces of information about your user, it might be simpler/easier to store them in Flagsmith rather than in your core application.

Traits are stored natively as either numbers, strings or booleans.

Traits powering Segments

Traits can be used within your application, but they also be used to power Segments.

Trait Value Data Types

Trait values can be stored as one of four different data types:

• Boolean
• String (max length 2000 bytes)
• Int (32 bit signed)
• Float (typically has a range of around 1E-307 to 1E+308 with a precision of at least 15 digits)

If you need to store 64 bit integers or very high precision floats we suggest storing them as Strings and then doing the type conversion within the SDK.

Bulk Uploading Identities and Traits

Identities are lazily created within Flagsmith. There might be instances where you want to push Identity and Trait data into the platform outside of a user session. You can achieve this with a POST to the identities endpoint:

curl -X "POST" "https://edge.api.flagsmith.com/api/v1/identities/?identifier=<identity_id>" \
     -H 'X-Environment-Key: <Your Environment Key>' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "traits":   "traits": [
    {
      "trait_key": "this_key",
      "trait_value": "this_value"
    },
    {
      "trait_key": "this_key2",
      "trait_value": "this_value2"
    }
  ],
  "identifier": "<identity_id>"
}'