Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document new login intent TTL #3129

Merged
merged 8 commits into from
Sep 4, 2024
Merged

Document new login intent TTL #3129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1b8df1f
add doc for new completion token TTL ENG-988
spwitt Jun 21, 2024
9bf4c7c
rename to loginIntent ENG-988
spwitt Jun 27, 2024
f838b7c
Shrink images
spwitt Jun 27, 2024
6d41963
missed one. revert screenshot height ENG-988
spwitt Jun 27, 2024
c3cc141
Merge branch 'spencer/eng-988/completion-token' of github.com:FusionA…
spwitt Jun 27, 2024
cc42842
Merge branch 'release/1.53.0' into spencer/eng-988/completion-token
spwitt Aug 13, 2024
769d1fd
add doc for fusionauth.li cookie ENG-988
spwitt Aug 13, 2024
73dc75d
Shrink images
spwitt Aug 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified ...lic/img/docs/get-started/core-concepts/tenant-configuration-extId-durations.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions astro/src/content/docs/apis/_tenant-request-body.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,11 +170,17 @@ import TransactionTypes from 'src/content/docs/apis/_transaction-types.mdx';
<TenantGeneratorTypeConfigRules generator_display_name="email verification one time code" />

</APIField>

<APIField name="tenant.externalIdentifierConfiguration.externalAuthenticationIdTimeToLiveInSeconds" type="Integer" optional defaults="300" since="1.12.0">
The time in seconds until an external authentication Id is no longer valid and cannot be used by the Token API. Value must be greater than 0.

Prior to version `1.28.0` this value was required.
</APIField>

<APIField name="tenant.externalIdentifierConfiguration.loginIntentTimeToLiveInSeconds" type="Integer" optional defaults="1800" since="1.52.0">
The time in seconds until a Login Timeout identifier is no longer valid to complete post-authentication steps in the OAuth workflow. Must be greater than 0.
</APIField>

<APIField name="tenant.externalIdentifierConfiguration.oneTimePasswordTimeToLiveInSeconds" type="Integer" optional defaults="60" since="1.8.0">
The time in seconds until a One Time Password is no longer valid and cannot be used by the Login API. Value must be greater than 0.

Expand Down
4 changes: 4 additions & 0 deletions astro/src/content/docs/apis/_tenant-response-body-base.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,10 @@ import JSON from 'src/components/JSON.astro';
The time in seconds until an external authentication Id is no longer valid and cannot be used by the Token API. Value must be greater than 0.
</APIField>

<APIField name={props.base_field_name + '.externalIdentifierConfiguration.loginIntentTimeToLiveInSeconds'} type="Integer" since="1.52.0">
The time in seconds until a Login Timeout identifier is no longer valid to complete post-authentication steps in the OAuth workflow. Must be greater than 0.
</APIField>

<APIField name={props.base_field_name + '.externalIdentifierConfiguration.oneTimePasswordTimeToLiveInSeconds'} type="Integer" since="1.8.0">
The time in seconds until a One Time Password is no longer valid and cannot be used by the Login API. Value must be greater than 0.
</APIField>
Expand Down
9 changes: 9 additions & 0 deletions astro/src/content/docs/get-started/core-concepts/tenants.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -757,6 +757,9 @@ The Rate limit settings allow you to set a number of times an action can be atte
<APIField name="External Authentication" required>
The number of seconds before the External Authentication identifier is no longer valid to complete the Authentication request.
</APIField>
<APIField name="Login timeout" required>
The number of seconds before the Login Timeout identifier is no longer valid to complete post-authentication steps in the OAuth workflow.
</APIField>
<APIField name="One Time Password" required>
The number of seconds before the One Time Password identifier is no longer valid to complete a Login request.
</APIField>
Expand Down Expand Up @@ -787,6 +790,12 @@ The Rate limit settings allow you to set a number of times an action can be atte
<APIField name="Two Factor Trust" required>
The number of seconds before the Two Factor Trust is no longer valid and the user will be prompted for Two Factor during login.
</APIField>
<APIField name="WebAuthn authentication" required>
The number of seconds before the WebAuthn authentication challenge is no longer valid and the user will need to restart the authentication workflow.
</APIField>
<APIField name="WebAuthn registration" required>
The number of seconds before the WebAuthn registration challenge is no longer valid and the user will need to restart the credential registration workflow.
</APIField>
</APIBlock>


Expand Down
1 change: 1 addition & 0 deletions astro/src/content/docs/reference/cookies.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Cookies set by the hosted login pages are displayed here for informational purpo
|--------------------------------|------------|-----------------------------------------------------------------------------------|
| `fusionauth.flash-message` | Request | Used to display a message across requests. |
| `fusionauth.known-device.*` | Persistent | Identifies a device known to FusionAuth. More than one cookie may be set. |
| `fusionauth.li` | Persistent | Used to support post-authentication steps during login. |
| `fusionauth.locale` | Persistent | The locale used to localize the themed pages. |
| `fusionauth.pkce-verifier` | Request | Used to support Proof Key for Code Exchange during login. |
| `fusionauth.remember-device` | Persistent | Records if the user wants to remain logged in on this device. |
Expand Down
1 change: 1 addition & 0 deletions astro/src/content/json/tenants/request.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@
"type": "randomAlphaNumeric"
},
"externalAuthenticationIdTimeToLiveInSeconds": 300,
"loginIntentTimeToLiveInSeconds": 1800,
"oneTimePasswordTimeToLiveInSeconds": 60,
"passwordlessLoginGenerator": {
"length": 32,
Expand Down
1 change: 1 addition & 0 deletions astro/src/content/json/tenants/response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@
"type": "randomAlphaNumeric"
},
"externalAuthenticationIdTimeToLiveInSeconds": 300,
"loginIntentTimeToLiveInSeconds": 1800,
"oneTimePasswordTimeToLiveInSeconds": 60,
"passwordlessLoginGenerator": {
"length": 32,
Expand Down
1 change: 1 addition & 0 deletions astro/src/content/json/tenants/responses.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@
"type": "randomAlphaNumeric"
},
"externalAuthenticationIdTimeToLiveInSeconds": 300,
"loginIntentTimeToLiveInSeconds": 1800,
"oneTimePasswordTimeToLiveInSeconds": 60,
"passwordlessLoginGenerator": {
"length": 32,
Expand Down
1 change: 1 addition & 0 deletions astro/src/content/json/tenants/search-response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@
"type": "randomAlphaNumeric"
},
"externalAuthenticationIdTimeToLiveInSeconds": 300,
"loginIntentTimeToLiveInSeconds": 1800,
"oneTimePasswordTimeToLiveInSeconds": 60,
"passwordlessLoginGenerator": {
"length": 32,
Expand Down
1 change: 1 addition & 0 deletions config/spellcheck/knownwords.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1580,6 +1580,7 @@ loginId
loginIdAttribute
loginIdType
loginIds
loginIntentTimeToLiveInSeconds
loginMethod
loginProvider
loginRecordConfiguration
Expand Down