chore: document organization settings flows#2614
Open
jonas-jonas wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands the Ory Kratos documentation to describe how organization membership can be established via the user settings flow, and cross-links the settings-flow docs with the organizations docs to make the flow discoverable.
Changes:
- Added an info note to the settings-flow documentation describing organization-scoped settings flows and linking to the organizations guide.
- Added a new “Bind an identity to an organization through the settings flow” section to the organizations documentation, including expected behavioral differences.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/kratos/self-service/flows/user-settings.mdx | Adds a note about scoping the settings flow to an organization and links to the organizations doc. |
| docs/kratos/organizations/organizations.mdx | Documents how linking an org SSO connection in settings binds the identity to the organization and describes behavior changes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+620
to
+622
| You can scope the settings flow to an organization by passing the `organization` query parameter. The flow then returns link nodes | ||
| only for that organization's SSO connections, and linking one binds the identity to the organization. See | ||
| [Bind an identity to an organization through the settings flow](../../organizations/organizations.mdx#bind-an-identity-to-an-organization-through-the-settings-flow). |
Comment on lines
+270
to
+271
| To scope a settings flow to an organization, pass the organization ID in the `organization` query parameter when you initialize | ||
| the flow: |
| https://$PROJECT_SLUG.projects.oryapis.com/self-service/settings/browser?organization=$ORGANIZATION_ID | ||
| ``` | ||
|
|
||
| The same parameter works for the API (native) flow at `/self-service/settings/api`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issue or Design Document
Checklist
If this pull request addresses a security vulnerability,
I confirm that I got approval (please contact security@ory.com) from the maintainers to push the changes.
Further comments