Skip to content

Commit 03b59df

Browse files
committed
Add notifications for linked users
1 parent 2aaad03 commit 03b59df

File tree

2 files changed

+117
-0
lines changed

2 files changed

+117
-0
lines changed

modules/ROOT/pages/changelogs.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
:description: This page lists all changes to status codes per Neo4j version.
22
= Changes to status codes per Neo4j version
33

4+
== Neo4j 5.21
5+
6+
**New:**
7+
8+
[source, status codes, role="noheader"]
9+
-----
10+
Neo.ClientNotification.Security.AuthProviderNotDefined
11+
Neo.ClientNotification.Security.ExternalAuthNotEnabled
12+
-----
13+
414
== Neo4j 5.17
515

616
**New:**

modules/ROOT/pages/notifications/all-notifications.adoc

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1241,6 +1241,113 @@ Suggestions for improvement::
12411241
Use `DATABASE *` without the parameter to revoke the privilege on all databases.
12421242
====
12431243

1244+
[#_neo_clientnotification_security_authprovidernotdefined]
1245+
=== AuthProviderNotDefined
1246+
1247+
.Notification details
1248+
[cols="<1s,<4"]
1249+
|===
1250+
|Code
1251+
m|Neo.ClientNotification.Security.AuthProviderNotDefined
1252+
|Title
1253+
a|The auth provider is not defined.
1254+
|Description
1255+
a|The auth provider `<provider>` is not defined in the configuration.
1256+
Verify that the spelling is correct or define `<provider>` in the configuration.
1257+
|Severity
1258+
m|INFORMATION
1259+
|Category
1260+
m|SECURITY
1261+
|===
1262+
1263+
.Create a user with an auth provider that isn't defined in config
1264+
====
1265+
Command::
1266+
+
1267+
[source, cypher]
1268+
----
1269+
CREATE USER foo SET AUTH 'unknownProvider' { SET ID 'idString' }
1270+
----
1271+
1272+
Description of the returned code::
1273+
The auth provider `unknownProvider` is not defined in the configuration.
1274+
Verify that the spelling is correct or define `unknownProvider` in the configuration.
1275+
1276+
Suggestions for improvement::
1277+
Make sure that the given provider is correct, or replace it if not.
1278+
If it is correct, make sure to add it as a known auth provider in one or both of `dbms.security.authentication_providers` and `dbms.security.authorization_providers`.
1279+
====
1280+
1281+
.Alter a user to add an auth provider that isn't defined in config
1282+
====
1283+
Command::
1284+
+
1285+
[source, cypher]
1286+
----
1287+
ALTER USER foo SET AUTH 'unknownProvider' { SET ID 'idString' }
1288+
----
1289+
1290+
Description of the returned code::
1291+
The auth provider `unknownProvider` is not defined in the configuration.
1292+
Verify that the spelling is correct or define `unknownProvider` in the configuration.
1293+
1294+
Suggestions for improvement::
1295+
Make sure that the given provider is correct, or replace it if not.
1296+
If it is correct, make sure to add it as a known auth provider in one or both of `dbms.security.authentication_providers` and `dbms.security.authorization_providers`.
1297+
====
1298+
1299+
[#_neo_clientnotification_security_externalauthnotenabled]
1300+
=== ExternalAuthNotEnabled
1301+
1302+
.Notification details
1303+
[cols="<1s,<4"]
1304+
|===
1305+
|Code
1306+
m|Neo.ClientNotification.Security.ExternalAuthNotEnabled
1307+
|Title
1308+
a|External auth for user is not enabled.
1309+
|Description
1310+
a|Use setting `dbms.security.require_local_user` to enable external auth.
1311+
|Severity
1312+
m|WARNING
1313+
|Category
1314+
m|SECURITY
1315+
|===
1316+
1317+
.Create a user with an external auth provider when linked users are not enabled
1318+
====
1319+
Command::
1320+
+
1321+
[source, cypher]
1322+
----
1323+
CREATE USER foo SET AUTH 'exampleProvider' { SET ID 'idString' }
1324+
----
1325+
1326+
Description of the returned code::
1327+
Use setting `dbms.security.require_local_user` to enable external auth.
1328+
1329+
Suggestions for improvement::
1330+
Enable linked users through the `dbms.security.require_local_user` setting.
1331+
Until enabled the new external auth will be ignored and current external auth behaviours will continue to apply.
1332+
====
1333+
1334+
.Alter a user to add an external auth provider when linked users are not enabled
1335+
====
1336+
Command::
1337+
+
1338+
[source, cypher]
1339+
----
1340+
ALTER USER foo SET AUTH 'exampleProvider' { SET ID 'idString' }
1341+
----
1342+
1343+
Description of the returned code::
1344+
Use setting `dbms.security.require_local_user` to enable external auth.
1345+
1346+
Suggestions for improvement::
1347+
Enable linked users through the `dbms.security.require_local_user` setting.
1348+
Until enabled the new external auth will be ignored and current external auth behaviours will continue to apply.
1349+
====
1350+
12441351
[#_topology_notifications]
12451352
== `TOPOLOGY` category
12461353

0 commit comments

Comments
 (0)