Skip to content

docs: Account Management page (change password, backup/export, delete) — closes #23#24

Merged
melvincarvalho merged 1 commit into
mainfrom
issue-23-account-management-docs
May 27, 2026
Merged

docs: Account Management page (change password, backup/export, delete) — closes #23#24
melvincarvalho merged 1 commit into
mainfrom
issue-23-account-management-docs

Conversation

@melvincarvalho
Copy link
Copy Markdown
Contributor

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

Action Endpoint Source issue
Change password PUT /idp/credentials #351
Backup / export pod GET /idp/account/export #353
Delete account (API) DELETE /idp/account #352
Delete account (browser) GET/POST /idp/account/delete #352
Passkeys POST /idp/passkey/{register,login}/{options,verify}
Delete account (operator) jss account delete <username>

Highlights surfaced in the doc:

  • Password change and deletion both require re-entering currentPassword as a re-auth proof.
  • Export streams a tar.gz (application/x-tar+gzip) of the pod tree + manifest.json, and intentionally includes /private/privkey.jsonld when provisioned with keys (the "Credible Exit").
  • DELETE /idp/account is disabled in single-user mode; operators use the CLI instead.

Wiring

  • Added to the Features sidebar after Authentication (sidebars.ts).
  • Added a row to the features overview table (features/overview.md).
  • Cross-linked from features/authentication.md.

Verification

npm run build passes with no broken-link errors.

All endpoint shapes were read from src/idp/ and bin/jss.js in the main JSS repo — no invented behavior.

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
@melvincarvalho melvincarvalho merged commit c8a4226 into main May 27, 2026
@melvincarvalho melvincarvalho deleted the issue-23-account-management-docs branch May 27, 2026 04:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: document self-service account management (change password, backup/export, delete)

1 participant