Skip to content

Commit

Permalink
document that you should not set this parameter to zero (#3083)
Browse files Browse the repository at this point in the history
* document that you should not set this parameter to zero

FusionAuth/fusionauth-issues#2736

* more nuance, please

* updating with correct examples
  • Loading branch information
mooreds committed May 22, 2024
1 parent 542476b commit ba13ee4
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
6 changes: 5 additions & 1 deletion astro/src/content/docs/apis/_tenant-request-body.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,11 @@ import TransactionTypes from 'src/content/docs/apis/_transaction-types.mdx';
</APIField>

<APIField name="tenant.httpSessionMaxInactiveInterval" type="Integer" optional defaults="3600" since="1.8.0">
Time in seconds until an inactive session will be invalidated. Used when creating a new session in the FusionAuth OAuth frontend.
Time in seconds until an inactive session will be invalidated. Used when creating a new session in the FusionAuth OAuth frontend.

If minimizing this value, you must set it high enough to allow users to complete a login workflow. This is application and context dependent. For example, submitting a required registration field or verifying an email address take longer than a typical username and password login.

Do not set this to `0`.
</APIField>

<APIField name="tenant.issuer" type="String" optional since="1.8.0">
Expand Down
4 changes: 4 additions & 0 deletions astro/src/content/docs/get-started/core-concepts/tenants.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,10 @@ Once you have configured your email settings, you may test your configuration wi
<APIBlock>
<APIField name="Session timeout" optional>
The length of time an SSO session can be inactive before it is closed.

If minimizing this value, you must set it high enough to allow users to complete a login workflow. This is application and context dependent. For example, submitting a required registration field or verifying an email address take longer than a typical username and password login.

Do not set this to `0`.
</APIField>
<APIField name="Logout URL" optional>
The URL the user is redirected to upon logout.
Expand Down

0 comments on commit ba13ee4

Please sign in to comment.