docs: note new identities default to active state#2660
Open
jhickmanit wants to merge 2 commits into
Open
Conversation
Explain that identities created via the admin API default to the active state, and how to create an inactive identity, linking to the identity state page.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a clarifying note to the existing (pre-migration) Kratos “Create identities” documentation explaining the default identity state returned by the Admin API and how to create an inactive identity.
Changes:
- Document that identities created via the Admin API default to
state: active. - Add guidance to set
state: inactiveto prevent sign-in until activation. - Link readers to the identity state documentation for additional details.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Absolute /docs/...mdx links aren't resolved as source-file references by Docusaurus and ignore the target's custom slug, producing a broken link. Use a relative .mdx link so the route resolves via the doc graph.
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.
What
Adds a short note to the Create identities page explaining that identities created via the admin API default to the `active` state (already visible as `"state": "active"` in the sample response, but previously unexplained), and how to create an `inactive` identity instead.
Why
The sample response on this page shows `"state": "active"` with no explanation. This clarifies the default and points readers to the identity state page for activating/de-activating identities.
Notes