Skip to content

Commit

Permalink
docs: document new account recovery feature
Browse files Browse the repository at this point in the history
Closes #436
  • Loading branch information
aeneasr committed Jul 3, 2020
1 parent be79724 commit c6fe7f5
Show file tree
Hide file tree
Showing 11 changed files with 876 additions and 36 deletions.
25 changes: 13 additions & 12 deletions docs/docs/reference/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2937,9 +2937,9 @@ Accept: application/json
```

This endpoint initializes a browser-based user login flow. Once initialized, the
browser will be redirected to `selfservice.flows.login.ui_url` with the request ID set as a query
parameter. If a valid user session exists already, the browser will be
redirected to `urls.default_redirect_url`.
browser will be redirected to `selfservice.flows.login.ui_url` with the request
ID set as a query parameter. If a valid user session exists already, the browser
will be redirected to `urls.default_redirect_url`.

> This endpoint is NOT INTENDED for API clients and only works with browsers
> (Chrome, Firefox, ...).
Expand Down Expand Up @@ -3321,9 +3321,10 @@ Accept: application/json
```

This endpoint initializes a browser-based user registration flow. Once
initialized, the browser will be redirected to `selfservice.flows.registration.ui_url` with the
request ID set as a query parameter. If a valid user session exists already, the
browser will be redirected to `urls.default_redirect_url`.
initialized, the browser will be redirected to
`selfservice.flows.registration.ui_url` with the request ID set as a query
parameter. If a valid user session exists already, the browser will be
redirected to `urls.default_redirect_url`.

> This endpoint is NOT INTENDED for API clients and only works with browsers
> (Chrome, Firefox, ...).
Expand Down Expand Up @@ -3703,9 +3704,9 @@ Accept: application/json
```

This endpoint initializes a browser-based settings flow. Once initialized, the
browser will be redirected to `selfservice.flows.settings.ui_url` with the request ID set as a
query parameter. If no valid user session exists, a login flow will be
initialized.
browser will be redirected to `selfservice.flows.settings.ui_url` with the
request ID set as a query parameter. If no valid user session exists, a login
flow will be initialized.

> This endpoint is NOT INTENDED for API clients and only works with browsers
> (Chrome, Firefox, ...).
Expand Down Expand Up @@ -4312,9 +4313,9 @@ Accept: application/json
```

This endpoint initializes a browser-based verification flow. Once initialized,
the browser will be redirected to `selfservice.flows.settings.ui_url` with the request ID set as
a query parameter. If no valid user session exists, a login flow will be
initialized.
the browser will be redirected to `selfservice.flows.settings.ui_url` with the
request ID set as a query parameter. If no valid user session exists, a login
flow will be initialized.

> This endpoint is NOT INTENDED for API clients and only works with browsers
> (Chrome, Firefox, ...).
Expand Down
Loading

0 comments on commit c6fe7f5

Please sign in to comment.