docs: Account Management page (change password, backup/export, delete) — closes #23#24
Merged
Merged
Conversation
New features/account-management.md documenting the self-service user-rights trio plus passkeys, each with method, path, auth, request body, response shape, and failure modes: - PUT /idp/credentials change password (#351) - GET /idp/account/export pod backup/export, tar.gz + manifest (#353) - DELETE /idp/account account deletion, optional purgeData (#352) - GET/POST /idp/account/delete browser delete flow - POST /idp/passkey/* WebAuthn register/login - jss account delete <user> operator CLI Wired into the Features sidebar after Authentication, added to the features overview table, and cross-linked from authentication.md. Closes #23
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.
Closes #23.
Adds a new Account Management page documenting the IDP's self-service "user-rights trio" plus passkeys and the operator delete CLI. Each feature is documented with method, path, auth requirement, request body, response shape, and failure modes — per the request to include API endpoints.
New page:
features/account-management.mdPUT /idp/credentialsGET /idp/account/exportDELETE /idp/accountGET/POST /idp/account/deletePOST /idp/passkey/{register,login}/{options,verify}jss account delete <username>Highlights surfaced in the doc:
currentPasswordas a re-auth proof.tar.gz(application/x-tar+gzip) of the pod tree +manifest.json, and intentionally includes/private/privkey.jsonldwhen provisioned with keys (the "Credible Exit").DELETE /idp/accountis disabled in single-user mode; operators use the CLI instead.Wiring
sidebars.ts).features/overview.md).features/authentication.md.Verification
npm run buildpasses with no broken-link errors.All endpoint shapes were read from
src/idp/andbin/jss.jsin the main JSS repo — no invented behavior.