Skip to content

Commit c0cef00

Browse files
phil198renetapopova
authored andcommitted
adding "migrating" note
1 parent 701cd54 commit c0cef00

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

modules/ROOT/pages/authentication-authorization/auth-providers.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,18 @@ The way that the matching lookup is done depends on the type of provider. For ex
3434
== Enabling User Auth Providers mode
3535
When the xref:configuration/configuration-settings.adoc#config_dbms.security.require_local_user[`dbms.security.require_local_user`] configuration setting is set to `true`, the lookups described above will be performed when the user authenticates, and a matching user Auth Provider *must* exist in order for a user to be able to successfully authenticate and authorize.
3636

37+
== Migrating to Auth Providers mode
38+
If you have existing users in the database and you want to migrate to Auth Providers mode, you can use the `ALTER USER ... SET AUTH` command to attach Auth Provider(s) to an existing user. Until you change `dbms.security.require_local_user` to `true`, this will have no impact on the users' ability to authenticate and authorize as they always have done.
39+
40+
Once the process of adding Auth Providers to your users is completed, you can then set `dbms.security.require_local_user` to true and restart the DBMS to complete the migration. After this time, only users with a corresponding Auth Provider in the database will be able to authenticate and authorize.
41+
42+
[NOTE]
43+
====
44+
Existing users which were created using the original `CREATE USER ... SET PASSWORD` syntax, will implicitly have the native (username / password) Auth Provider, so that would not need to be added explicitly using `SET AUTH`.
45+
46+
To be certain about which Auth Providers are attached to a user, you can use the xref:authentication-authorization/manage-users.adoc#access-control-list-users[`SHOW USERS WITH AUTH`] command to see the Auth Providers attached to a user.
47+
====
48+
3749
== Examples
3850
For examples of how to use Auth Providers with different authentication providers, see the following sections:
3951

0 commit comments

Comments
 (0)