Skip to content
This repository has been archived by the owner. It is now read-only.

/ fxa-oauth-server Archived

WIP fix(docs): document keys and verification_redirect options #255

Closed
wants to merge 1 commit into from
+5 −0
Closed

WIP fix(docs): document keys and verification_redirect options #255

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter
Filter file types
Beta Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.

Always

Just for now

5 docs/api.md
View file
Open in desktop
@@ -292,6 +292,11 @@ content-server page.
signed in email address will be used as the default.
- If `action` is `force_auth`, the user is unable to modify the email
address and is unable to sign up if the address is not registered.
- `keys`: Optional. Boolean setting, set this if the relier wants access to the account encryption keys.

This comment has been minimized.

Sign in to view
@rfk

rfk May 14, 2015
Member

IMO "wants access to the account encryption keys" suggests they can access the raw keys, which is not the case. Something more generic like "wants to receive encryption keys" might be better.
- `verification_redirect`: Optional. This option adds a "Proceed" button into the "Account Ready" view. See options for details.

This comment has been minimized.

Sign in to view
@shane-tomlinson

shane-tomlinson May 13, 2015
Member

This is difficult to document too. A "Proceed" button is only displayed if the user verifies in a 2nd browser. If the user verifies in the same browser, they are automatically redirected w/o user interaction.
- Default. If `verification_redirect` is `no` the account ready view will not show a "Proceed" button that will return to the relier.
- If `verification_redirect` is `samebrowser` the account ready view will show a "Proceed" to the relier button only if the flow is in the same browser.
- If `verification_redirect` is `always` the account ready view will always show a "Proceed" that will redirect to the relier, even if the user completed an email action in another browser that has no OAuth state.

**Example:**

ProTip! Use n and p to navigate between commits in a pull request.