Skip to content

Commit

Permalink
Update authflow api reference
Browse files Browse the repository at this point in the history
  • Loading branch information
tung2744 authored and louischan-oursky committed May 7, 2024
1 parent 8907ee1 commit 715d244
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/specs/authentication-flow-api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -399,14 +399,15 @@ During identification steps in signup flow, an account linking could be triggere
"identification": "oauth",
"data": {
"type": "account_linking_identification_data",
"account_linking_action": "login_and_link",
"options": [
{
"identification": "email",
"action": "login_and_link",
"masked_display_name": "exam****@gmail.com"
},
{
"identification": "oauth",
"action": "login_and_link",
"masked_display_name": "exam****@gmail.com",
"provider_type": "github",
"alias": "github"
Expand All @@ -420,10 +421,10 @@ During identification steps in signup flow, an account linking could be triggere

This means account linking was triggered by the previously identified identity. You can find the followings in `action.data`:

- `account_linking_action`: This field specify what is going to happen in this account linking. The only possible value in current version is `login_and_link`.
- `login_and_link`: You need to login to one of the account in `options`. After that, the identity you have just created in previous steps will be linked to the logged in account.
- `options`: Contains options that you can use to continue the account linking flow. The items contains the following fields:
- `identification`: See [type: signup; action.type: identification](#type-signup-actiontype-identification). They are having the same meaning.
- `action`: This field specify what is going to happen when this option is selected. The only possible value in current version is `login_and_link`.
- `login_and_link`: You need to login to one of the account in `options`. After that, the identity you have just created in previous steps will be linked to the logged in account.
- `masked_display_name`: The display name of the identity to use. Different from signup flow, during account linking, you must use an existing identity to start account linking. The display name here is the display name of the referred identity of this option. If it is an `email`, a masked email will be displayed. If it is a `phone`, a masked phone number will be displayed. If it is a `username`, the username will be displayed without masking. If it is a `oauth` identity, the display name will be a name which you should be able to recongize the account in that provider.

- `provider_type`: Only exist if `identification` is `oauth`. It is the type of the oauth provider. Read [identification: oauth](#identification-oauth) for details.
Expand Down

0 comments on commit 715d244

Please sign in to comment.