Skip to content

Commit

Permalink
fix: verification flow diagram (#1486)
Browse files Browse the repository at this point in the history
  • Loading branch information
vinckr authored Aug 3, 2023
1 parent 809caad commit 181455e
Showing 1 changed file with 27 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,33 @@ Ory allows users to verify email addresses associated with their accounts. This
the address they used to create their account. If verification is enabled, Ory Identities starts the verification process
automatically when users sign up. Users can also verify their addresses manually.

The verification flow is supported in both browsers and API clients.
The verification flow is supported in both browsers and API clients and can be summarized as the following state machine:

```mdx-code-block
import Mermaid from "@site/src/theme/Mermaid"
<Mermaid
chart={`
stateDiagram
s1: Flow is initialized
s2: User Interface renders Verification Flow Forms
s3: Update Verification Flow with Error Context(s)
s4: Verification challenge initiated (link or code via email)
s5: UI renders code input form (if code, link skips this)
s6: Show error message and reload form
s7: Verification completed
[*] --> s1 : User clicks "Verify Email/SMS/..."
s1 --> s2
s2 --> s4 : User provides valid verification data
s2 --> s3 : User provides invalid verification data
s3 --> s2
s4 --> s5
s5 --> s6 : Challenge response invalid
s5 --> s7 : Challenge response valid
s6 --> s5
`}
/>
```

:::caution

Expand Down

0 comments on commit 181455e

Please sign in to comment.