Inconsistent "revoke_active_sessions" hook docs
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 161
- Forks
- 1.9k
- PR merge metrics
- No merged PRs in 30d
Description
Preflight checklist
- I could not find a solution in the existing issues, docs, nor discussions.
- I agree to follow this project's Code of Conduct.
- I have read and am following this repository's Contribution Guidelines.
- I have joined the Ory Community Slack.
- I am signed up to the Ory Security Patch Newsletter.
Ory Network Project
No response
Describe the bug
The docs related to the "revoke_active_sessions" hook are inconsistent: there is one page which shows how to use this hook after a user changes their password:
https://www.ory.com/docs/kratos/session-management/revoke-sessions-hook
But on the https://www.ory.com/docs/kratos/hooks/configure-hooks#available-actions page, in the table it says that only the login flow is supported.
I propose a change to the table:
| revoke_active_sessions | Revokes all other active sessions of the user on successful login. | For use with either the login flow or the after settings flow, password method (as shown here).
Reproducing the bug
visit https://www.ory.com/docs/kratos/hooks/configure-hooks#available-actions
Relevant log output
Relevant configuration
Version
26.2
On which operating system are you observing this issue?
None
In which environment are you deploying?
None
Additional Context
There is a restriction preventing me from opening a PR. The proposed change is already on https://github.com/nbycomp/docs
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Available Actions table in the configure-hooks documentation and compare its revoke_active_sessions entry with the revoke-sessions-hook page. Update the table to document support for the login flow and the after settings flow using the password method, then verify the links and rendered wording.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100