From 94ac461812fe8776aec5e7e5e2ddacda35a84703 Mon Sep 17 00:00:00 2001 From: Cole Garbo Date: Fri, 11 Oct 2024 15:59:14 -0400 Subject: [PATCH] clarify and describe how to use initial claims --- .../identity/deployment/configuration-variables.md | 14 ++++++++++---- .../setup/guides/connect-to-an-oidc-provider.md | 2 +- .../identity/deployment/configuration-variables.md | 14 ++++++++++---- .../setup/guides/connect-to-an-oidc-provider.md | 2 +- 4 files changed, 22 insertions(+), 10 deletions(-) diff --git a/docs/self-managed/identity/deployment/configuration-variables.md b/docs/self-managed/identity/deployment/configuration-variables.md index 2f37d61ef1..09066025e1 100644 --- a/docs/self-managed/identity/deployment/configuration-variables.md +++ b/docs/self-managed/identity/deployment/configuration-variables.md @@ -35,10 +35,16 @@ import Licensing from '../../../self-managed/react-components/licensing.md' ## OIDC configuration -| Evnironment variable | Description | Default value | -| ---------------------------- | --------------------------------------------------- | ------------- | -| IDENTITY_INITIAL_CLAIM_NAME | The name of the claim to use for the initial user. | oid | -| IDENTITY_INITIAL_CLAIM_VALUE | The value of the claim to use for the initial user. | | +Claims are name/value pairs used to represent an individual identity. Configure your initial claim and value to match the claim used with your OIDC provider. For example, to use your Microsoft Entra unique account ID, set `IDENTITY_INITIAL_CLAIM_NAME` to `oid`, and `IDENTITY_INITIAL_CLAIM_VALUE` to the ID. + +:::note +Once set, you cannot update your initial claim name and value using environment or Helm values. You must change these values directly in the database. +::: + +| Environment variable | Description | Default value | +| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | +| `IDENTITY_INITIAL_CLAIM_NAME` | The type of claim to use for the initial user. Examples can include `oid`, `name` or `email`. | `oid` | +| `IDENTITY_INITIAL_CLAIM_VALUE` | The value of the claim to use for the initial user. For the default `oid`, the value usually corresponds to the unique ID of your user account. | | ## Component configuration diff --git a/docs/self-managed/setup/guides/connect-to-an-oidc-provider.md b/docs/self-managed/setup/guides/connect-to-an-oidc-provider.md index f51e1f47b3..dfdaabd239 100644 --- a/docs/self-managed/setup/guides/connect-to-an-oidc-provider.md +++ b/docs/self-managed/setup/guides/connect-to-an-oidc-provider.md @@ -103,7 +103,7 @@ global: -:::warning +:::note Once set, you cannot update your initial claim name and value using environment or Helm values. You must change these values directly in the database. ::: diff --git a/versioned_docs/version-8.6/self-managed/identity/deployment/configuration-variables.md b/versioned_docs/version-8.6/self-managed/identity/deployment/configuration-variables.md index 2f37d61ef1..09066025e1 100644 --- a/versioned_docs/version-8.6/self-managed/identity/deployment/configuration-variables.md +++ b/versioned_docs/version-8.6/self-managed/identity/deployment/configuration-variables.md @@ -35,10 +35,16 @@ import Licensing from '../../../self-managed/react-components/licensing.md' ## OIDC configuration -| Evnironment variable | Description | Default value | -| ---------------------------- | --------------------------------------------------- | ------------- | -| IDENTITY_INITIAL_CLAIM_NAME | The name of the claim to use for the initial user. | oid | -| IDENTITY_INITIAL_CLAIM_VALUE | The value of the claim to use for the initial user. | | +Claims are name/value pairs used to represent an individual identity. Configure your initial claim and value to match the claim used with your OIDC provider. For example, to use your Microsoft Entra unique account ID, set `IDENTITY_INITIAL_CLAIM_NAME` to `oid`, and `IDENTITY_INITIAL_CLAIM_VALUE` to the ID. + +:::note +Once set, you cannot update your initial claim name and value using environment or Helm values. You must change these values directly in the database. +::: + +| Environment variable | Description | Default value | +| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | +| `IDENTITY_INITIAL_CLAIM_NAME` | The type of claim to use for the initial user. Examples can include `oid`, `name` or `email`. | `oid` | +| `IDENTITY_INITIAL_CLAIM_VALUE` | The value of the claim to use for the initial user. For the default `oid`, the value usually corresponds to the unique ID of your user account. | | ## Component configuration diff --git a/versioned_docs/version-8.6/self-managed/setup/guides/connect-to-an-oidc-provider.md b/versioned_docs/version-8.6/self-managed/setup/guides/connect-to-an-oidc-provider.md index f51e1f47b3..dfdaabd239 100644 --- a/versioned_docs/version-8.6/self-managed/setup/guides/connect-to-an-oidc-provider.md +++ b/versioned_docs/version-8.6/self-managed/setup/guides/connect-to-an-oidc-provider.md @@ -103,7 +103,7 @@ global: -:::warning +:::note Once set, you cannot update your initial claim name and value using environment or Helm values. You must change these values directly in the database. :::