Skip to content
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

Jump to bottom

Clarify and describe how to use initial claims #4460

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −10
Open

Clarify and describe how to use initial claims #4460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 10 additions & 4 deletions docs/self-managed/identity/deployment/configuration-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/self-managed/setup/guides/connect-to-an-oidc-provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ global:
</TabItem>
</Tabs>

:::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.
:::

Expand Down
14 changes: 10 additions & 4 deletions ...ed_docs/version-8.6/self-managed/identity/deployment/configuration-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion ...ioned_docs/version-8.6/self-managed/setup/guides/connect-to-an-oidc-provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ global:
</TabItem>
</Tabs>

:::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.
:::

Expand Down
Loading