Skip to content

[DON'T MERGE YET] Improve documentation on evaluation context to User Object mapping for some OpenFeature providers #712

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adams85 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

[DON'T MERGE YET] Improve documentation on evaluation context to User Object mapping for some OpenFeature providers #712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a5c04c
Improve documentation on evaluation context to User Object mapping fo…
adams85 Jul 30, 2026
f81759e
Fix indentation in code examples
adams85 Jul 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions website/docs/sdk-reference/dotnet/_template.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ using ConfigCat.Extensions.Hosting;
{
configCatBuilder.AddDefaultClient(options =>
{
options.SdkKey = "#YOUR-SDK-KEY#";
options.SdkKey = "#YOUR-SDK-KEY#";
});
});
```
Expand Down Expand Up @@ -301,10 +301,10 @@ using ConfigCat.Extensions.Hosting;
```csharp
services.AddConfigCat(configCatBuilder =>
{
configCatBuilder.AddDefaultClient(options =>
{
options.SdkKey = "#YOUR-SDK-KEY#";
});
configCatBuilder.AddDefaultClient(options =>
{
options.SdkKey = "#YOUR-SDK-KEY#";
});
});
```

Expand Down
21 changes: 14 additions & 7 deletions website/docs/sdk-reference/openfeature/dotnet.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,18 +91,25 @@ The ConfigCat provider translates these evaluation contexts to ConfigCat [User O

The following table shows how the different context attributes are mapped to User Object attributes.

| Evaluation context | User Object | Required |
| ------------------ | ------------ | -------- |
| `Id`/`Identifier` | `Identifier` | ☑ |
| `Email` | `Email` | |
| `Country` | `Country` | |
| Any other | `Custom` | |
| Evaluation context | User Object | Required |
| ------------------------------------ | ------------ | -------- |
| `targetingKey` (`Id` / `Identifier`) | `Identifier` | ☑ |
| `Email` | `Email` | |
| `Country` | `Country` | |
| Any other | `Custom` | |

Remarks:
- If `targetingKey` is present in the evaluation context, it will be mapped to the `Identifier` property. Otherwise, `Id` or `Identifier` will be mapped, whichever occurs first.
(If none of these keys are present, the `Identifier` property will be set to the fallback value `"<n/a>"`.)
- The keys `Id`, `Identifier`, `Email` and `Country` are matched case-insensitively. If the same key appears in multiple cases - e.g. `email` and `Email` - the first occurrence will be mapped to the corresponding property.
- All of the above will also be included in the `Custom` dictionary (except for the exact keys `Identifier`, `Email` and `Country`). This allows them to be referenced using their original names in feature flag rules.
- Other keys are mapped as custom user attributes with their values unchanged. (Although the ConfigCat SDK handles value conversion internally, it's recommended to use the type expected by the referencing feature flag rules. Read more [here](../../dotnet/#user-object-attribute-types).)

To evaluate feature flags for a context, use the <a href="https://openfeature.dev/docs/reference/concepts/evaluation-api/" target="_blank">OpenFeature Evaluation API</a>:

```cs
var context = OpenFeature.Model.EvaluationContext.Builder()
.Set("Id", "#SOME-USER-ID#")
.SetTargetingKey("#SOME-USER-ID#")
.Set("Email", "configcat@example.com")
.Set("Country", "CountryID")
.Set("Rating", 4.5)
Expand Down
19 changes: 13 additions & 6 deletions website/docs/sdk-reference/openfeature/js.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,19 @@ The ConfigCat provider translates these evaluation contexts to ConfigCat [User O

The following table shows how the different context attributes are mapped to User Object attributes.

| Evaluation context | User Object | Required |
| ------------------ | ------------ | -------- |
| `targetingKey` | `identifier` | &#9745; |
| `email` | `email` | |
| `country` | `country` | |
| Any other | `custom` | |
| Evaluation context | User Object | Required |
| ----------------------------- | ------------ | -------- |
| `targetingKey` (`identifier`) | `identifier` | &#9745; |
| `email` | `email` | |
| `country` | `country` | |
| Any other | `custom` | |

Remarks:
- If `targetingKey` is present in the evaluation context, it will be mapped to the `Identifier` property. Otherwise, `identifier` will be mapped.
(If none of these keys are present, the ConfigCat SDK will fall back to using an empty string for the identifier.)
- Predefined keys (i.e., `targetingKey`, `identifier`, `email` and `country`) are matched case-sensitively. (Despite this, never use the keys `Identifier`, `Email` or `Country`, as those are ignored for technical reasons.)
- Predefined keys will also be included in the `custom` object. This allows them to be referenced using their original names in feature flag rules.
- Other keys are mapped as custom user attributes with their values unchanged, except for objects and non-string arrays, which are converted to JSON for historical reasons. (Although the ConfigCat SDK handles value conversion internally, it's recommended to use the type expected by the referencing feature flag rules. Read more [here](../../js/overview#user-object-attribute-types).)

To evaluate feature flags for a context, use the <a href="https://openfeature.dev/docs/reference/concepts/evaluation-api/" target="_blank">OpenFeature Evaluation API</a>:

Expand Down
19 changes: 13 additions & 6 deletions website/docs/sdk-reference/openfeature/node.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,19 @@ The ConfigCat provider translates these evaluation contexts to ConfigCat [User O

The following table shows how the different context attributes are mapped to User Object attributes.

| Evaluation context | User Object | Required |
| ------------------ | ------------ | -------- |
| `targetingKey` | `identifier` | &#9745; |
| `email` | `email` | |
| `country` | `country` | |
| Any other | `custom` | |
| Evaluation context | User Object | Required |
| ----------------------------- | ------------ | -------- |
| `targetingKey` (`identifier`) | `identifier` | &#9745; |
| `email` | `email` | |
| `country` | `country` | |
| Any other | `custom` | |

Remarks:
- If `targetingKey` is present in the evaluation context, it will be mapped to the `Identifier` property. Otherwise, `identifier` will be mapped.
(If none of these keys are present, the ConfigCat SDK will fall back to using an empty string for the identifier.)
- Predefined keys (i.e., `targetingKey`, `identifier`, `email` and `country`) are matched case-sensitively. (Despite this, never use the keys `Identifier`, `Email` or `Country`, as those are ignored for technical reasons.)
- Predefined keys will also be included in the `custom` object. This allows them to be referenced using their original names in feature flag rules.
- Other keys are mapped as custom user attributes with their values unchanged, except for objects and non-string arrays, which are converted to JSON for historical reasons. (Although the ConfigCat SDK handles value conversion internally, it's recommended to use the type expected by the referencing feature flag rules. Read more [here](../../js/overview#user-object-attribute-types).)

To evaluate feature flags for a context, use the <a href="https://openfeature.dev/docs/reference/concepts/evaluation-api/" target="_blank">OpenFeature Evaluation API</a>:

Expand Down
Loading