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.

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

Clarify and describe how to use initial claims #4460

Merged
merged 1 commit into from
Oct 29, 2024

Conversation

conceptualshark
Copy link
Contributor

Description

Closes #4357

The INITIAL_CLAIMS identity variables were not fully described, leading to user confusion when setting up OIDC providers.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@conceptualshark conceptualshark requested review from FarkasRabai and a team October 11, 2024 20:05
@christinaausley christinaausley added component:identity Issues related with Identity project component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed labels Oct 14, 2024
Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ID 💪


| 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` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use Oxford comma, though this is such a tiny nitpick I am approving 😆

@FarkasRabai
Copy link

Looks great to me!

@conceptualshark conceptualshark merged commit 130b789 into main Oct 29, 2024
10 checks passed
@conceptualshark conceptualshark deleted the cg-initial-claims branch October 29, 2024 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:identity Issues related with Identity project component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Add additional description for claims usage in Identity
3 participants