|
2 | 2 |
|
3 | 3 | {{ ydb-short-name }} supports various user authentication methods. The configuration for authentication providers is specified in the `auth_config` section.
|
4 | 4 |
|
5 |
| -## Configuring internal {{ ydb-short-name }} user authentication {#internal-auth-config} |
| 5 | +## Configuring local {{ ydb-short-name }} user authentication {#local-auth-config} |
6 | 6 |
|
7 |
| -For more information about the authentication of [internal {{ ydb-short-name }} users](../../concepts/glossary.md#access-user), see [{#T}](../../security/authentication.md#static-credentials). To configure authentication by username and password, define the following parameters in the `auth_config` section: |
| 7 | +For more information about the authentication of [local {{ ydb-short-name }} users](../../concepts/glossary.md#access-user), see [{#T}](../../security/authentication.md#static-credentials). To configure authentication by username and password, define the following parameters in the `auth_config` section: |
8 | 8 |
|
9 | 9 | #|
|
10 | 10 | || Parameter | Description ||
|
11 | 11 | || use_login_provider
|
12 |
| -| Indicates whether to allow the authentication of internal users with an [authentication token](../../concepts/glossary.md#auth-token) that is obtained after entering a username and password. |
| 12 | +| Indicates whether to allow the authentication of local users with an [authentication token](../../concepts/glossary.md#auth-token) that is obtained after entering a username and password. |
13 | 13 |
|
14 | 14 | Default value: `true`
|
15 | 15 | ||
|
16 | 16 | || enable_login_authentication
|
17 |
| -| Indicates whether to allow adding internal users to {{ ydb-short-name }} databases and generating authentication tokens after an internal user enters a username and password. |
| 17 | +| Indicates whether to allow adding local users to {{ ydb-short-name }} databases and generating authentication tokens after an local user enters a username and password. |
18 | 18 |
|
19 | 19 | Default value: `true`
|
20 | 20 | ||
|
21 | 21 | || domain_login_only
|
22 |
| -| Determines the scope of internal user access rights in a {{ ydb-short-name }} cluster. |
| 22 | +| Determines the scope of local user access rights in a {{ ydb-short-name }} cluster. |
23 | 23 |
|
24 | 24 | Valid values:
|
25 | 25 |
|
26 |
| -- `true` — internal users exist in a {{ ydb-short-name }} cluster and can be granted rights to access multiple [tenant databases](../../concepts/glossary.md#tenant-database). |
| 26 | +- `true` — local users exist in a {{ ydb-short-name }} cluster and can be granted rights to access multiple [databases](../../concepts/glossary.md#database). |
27 | 27 |
|
28 |
| - In this scenario, users are added only to the [root database](../../concepts/glossary.md#root-database). |
29 |
| - |
30 |
| -- `false` — internal users can exist either in a {{ ydb-short-name }} cluster or in tenant databases. The scope of access rights for internal users in tenant databases is limited to the database, in which they are created. |
31 |
| - |
32 |
| - In this scenario, users are added either to the root database or to tenant databases. |
| 28 | +- `false` — local users can exist either at the cluster or database level. The scope of access rights for local users created at the database level is limited to the database, in which they are created. |
33 | 29 |
|
34 | 30 | Default value: `true`
|
35 | 31 | ||
|
36 | 32 | || login_token_expire_time
|
37 |
| -| Specifies the expiration time of the authentication token created when an internal user logs in to {{ ydb-short-name }}. |
| 33 | +| Specifies the expiration time of the authentication token created when an local user logs in to {{ ydb-short-name }}. |
38 | 34 |
|
39 | 35 | Default value: `12h`
|
40 | 36 | ||
|
@@ -75,7 +71,7 @@ Default value: `1h`
|
75 | 71 |
|
76 | 72 | ### Configuring password complexity requirements {#password-complexity}
|
77 | 73 |
|
78 |
| -{{ ydb-short-name }} allows internal users to authenticate using a login and password. For more information, see [authentication by login and password](../../security/authentication.md#static-credentials). To enhance security in {{ ydb-short-name }}, configure complexity requirements for the passwords of [internal users](../../concepts/glossary.md#access-user) in the `password_complexity` subsection inside the `auth_config` section. |
| 74 | +{{ ydb-short-name }} allows local users to authenticate using a login and password. For more information, see [authentication by login and password](../../security/authentication.md#static-credentials). To enhance security in {{ ydb-short-name }}, configure complexity requirements for the passwords of [local users](../../concepts/glossary.md#access-user) in the `password_complexity` subsection inside the `auth_config` section. |
79 | 75 |
|
80 | 76 | Example of the `password_complexity` section:
|
81 | 77 |
|
@@ -288,9 +284,11 @@ Default value: `false`
|
288 | 284 | ||
|
289 | 285 | |#
|
290 | 286 |
|
291 |
| -## Configuring user token life cycle |
| 287 | +## Configuring caching for authentication results |
| 288 | + |
| 289 | +During the authentication process, a user session receives an authentication token, which is transmitted along with each request to the cluster {{ydb-short-name }}. Since {{ydb-short-name }} is a distributed system, user requests will eventually be processed on one or more {{ydb-short-name }} nodes. After receiving a request from the user, a {{ydb-short-name }} node verifies the authentication token. If successful, the node generates a **user token**, which is valid only inside the current node and is used to authorize the actions requested by the user. Subsequent requests with the same authentication token to the same node do not require verification of the authentication token. |
292 | 290 |
|
293 |
| -Parameters for configuring the [user token](../../concepts/glossary.md#user-token) life cycle are applicable to all authentication methods. |
| 291 | +To configure the life cycle and other important aspects of managing user tokens, define the following parameters: |
294 | 292 |
|
295 | 293 | #|
|
296 | 294 | || refresh_period
|
|
0 commit comments