Skip to content

Commit 43915f2

Browse files
committed
[TASK] Use confval-menu for user tsconfig
Releases: main, 13.4
1 parent ce86ec0 commit 43915f2

File tree

3 files changed

+133
-187
lines changed

3 files changed

+133
-187
lines changed

Documentation/UserTsconfig/Auth.rst

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,21 @@ auth
88

99
The `auth` key is used for configuration of authentication services.
1010

11+
.. contents::
12+
:depth: 2
13+
1114
.. _user-auth-properties:
1215

1316
Properties
1417
==========
1518

16-
.. contents::
17-
:depth: 2
18-
:local:
19+
.. confval-menu::
20+
:name: auth
21+
:display: table
22+
:type:
1923

2024
.. _user-auth-be-redirectToURL:
2125

22-
auth.BE.redirectToURL
23-
---------------------
24-
2526
.. confval:: auth.BE.redirectToURL
2627
:name: user-auth-be-redirectToURL
2728
:type: string
@@ -31,9 +32,6 @@ auth.BE.redirectToURL
3132

3233
.. _user-auth-mfa-required:
3334

34-
auth.mfa.required
35-
-----------------
36-
3735
.. confval:: auth.mfa.required
3836
:name: user-auth-mfa-required
3937
:type: boolean
@@ -48,44 +46,45 @@ auth.mfa.required
4846
4947
.. _user-auth-mfa-disableProviders:
5048

51-
auth.mfa.disableProviders
52-
-------------------------
53-
5449
.. confval:: auth.mfa.disableProviders
5550
:name: auth.mfa.disableProviders
5651
:type: string, comma separated list of strings
52+
:Example: :ref:`user-auth-mfa-disableProviders-example`
5753

5854
Disable multi-factor authentication providers for the current user or group.
5955
It overrules the configuration from the Backend usergroup "Access List". This
6056
means, if a provider is allowed in "Access List" but disallowed with TSconfig,
6157
it will be disallowed for the user or user group.
6258

63-
.. _user-auth-mfa-disableProviders-example:
64-
65-
Example: Disable a multi-factor authentication provider
66-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
67-
68-
.. code-block:: typoscript
69-
:caption: EXT:site_package/Configuration/user.tsconfig
70-
71-
auth.mfa.disableProviders := addToList(totp)
72-
7359
.. _user-auth-mfa-recommendedProvider:
7460

75-
auth.mfa.recommendedProvider
76-
----------------------------
77-
7861
.. confval:: auth.mfa.recommendedProvider
7962
:name: auth.mfa.recommendedProvider
8063
:type: string
64+
:Example: :ref:`user-auth-mfa-recommendedProvider-example`
8165

8266
Set a recommended multi-factor authentication provider on a per user or user group basis, which overrules
8367
the global configuration.
8468

69+
.. _user-auth-mfa-example:
70+
71+
Examples
72+
========
73+
74+
.. _user-auth-mfa-disableProviders-example:
75+
76+
Example: Disable a multi-factor authentication provider
77+
-------------------------------------------------------
78+
79+
.. code-block:: typoscript
80+
:caption: EXT:site_package/Configuration/user.tsconfig
81+
82+
auth.mfa.disableProviders := addToList(totp)
83+
8584
.. _user-auth-mfa-recommendedProvider-example:
8685

8786
Example: Set a recommended multi-factor authentication provider
88-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
87+
---------------------------------------------------------------
8988

9089
.. code-block:: typoscript
9190
:caption: EXT:site_package/Configuration/user.tsconfig

Documentation/UserTsconfig/Options.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Properties
2222
==========
2323

2424
.. confval-menu::
25-
:name: confval-group-1
25+
:name: useroptions
2626
:display: table
2727
:type:
2828
:Default:

0 commit comments

Comments
 (0)