Skip to content

Commit 5daffd3

Browse files
authored
Document 01N71 and 00N72 for Linked users (#189)
1 parent 19e6d3a commit 5daffd3

File tree

1 file changed

+136
-16
lines changed

1 file changed

+136
-16
lines changed

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

Lines changed: 136 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2787,21 +2787,33 @@ Use `DATABASE *` without the parameter to revoke the privilege on all databases.
27872787
.Notification details
27882788
[cols="<1s,<4"]
27892789
|===
2790-
|Code
2790+
|Neo4j code
27912791
m|Neo.ClientNotification.Security.AuthProviderNotDefined
27922792
|Title
27932793
a|The auth provider is not defined.
27942794
|Description
2795-
a|The auth provider `<provider>` is not defined in the configuration.
2796-
Verify that the spelling is correct or define `<provider>` in the configuration.
2797-
|Severity
2798-
m|INFORMATION
2795+
a|The auth provider `$provider` is not defined in the configuration.
2796+
Verify that the spelling is correct or define `$provider` in the configuration.
27992797
|Category
28002798
m|SECURITY
2799+
|GQLSTATUS code
2800+
m|00N72
2801+
|Status description
2802+
a|note: successful completion - undefined auth provider.
2803+
The auth provider { $auth } is not defined in the configuration.
2804+
Verify that the spelling is correct or define { $auth } in the configuration.
2805+
|Classification
2806+
m|SECURITY
2807+
|SeverityLevel
2808+
m|INFORMATION
28012809
|===
28022810

2811+
28032812
.Create a user with an auth provider that is not defined in the configuration
2804-
====
2813+
[.tabbed-example]
2814+
=====
2815+
[.include-with-neo4j-code]
2816+
======
28052817
Command::
28062818
+
28072819
[source, cypher]
@@ -2816,10 +2828,35 @@ Verify that the spelling is correct or define `unknownProvider` in the configura
28162828
Suggestions for improvement::
28172829
Make sure that the given provider is correct, or replace it if not.
28182830
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`.
2819-
====
2831+
======
2832+
[.include-with-GQLSTATUS-code]
2833+
======
2834+
Command::
2835+
+
2836+
[source, cypher]
2837+
----
2838+
CREATE USER foo SET AUTH 'unknownProvider' { SET ID 'idString' }
2839+
----
2840+
2841+
Returned GQLSTATUS code::
2842+
00N72
2843+
2844+
Returned status description::
2845+
note: successful completion - undefined auth provider.
2846+
The auth provider `unknownProvider` is not defined in the configuration.
2847+
Verify that the spelling is correct or define `unknownProvider` in the configuration.
2848+
2849+
Suggestions for improvement::
2850+
Make sure that the given provider is correct, or replace it if not.
2851+
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`.
2852+
======
2853+
=====
28202854

28212855
.Alter a user to add an auth provider that is not defined in the configuration
2822-
====
2856+
[.tabbed-example]
2857+
=====
2858+
[.include-with-neo4j-code]
2859+
======
28232860
Command::
28242861
+
28252862
[source, cypher]
@@ -2834,28 +2871,62 @@ Verify that the spelling is correct or define `unknownProvider` in the configura
28342871
Suggestions for improvement::
28352872
Make sure that the given provider is correct, or replace it if not.
28362873
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`.
2837-
====
2874+
======
2875+
2876+
[.include-with-GQLSTATUS-code]
2877+
======
2878+
Command::
2879+
+
2880+
[source, cypher]
2881+
----
2882+
ALTER USER foo SET AUTH 'unknownProvider' { SET ID 'idString' }
2883+
----
2884+
2885+
Returned GQLSTATUS code::
2886+
00N72
2887+
2888+
Returned status description::
2889+
note: successful completion - undefined auth provider.
2890+
The auth provider `unknownProvider` is not defined in the configuration.
2891+
Verify that the spelling is correct or define `unknownProvider` in the configuration.
2892+
2893+
Suggestions for improvement::
2894+
Make sure that the given provider is correct, or replace it if not.
2895+
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`.
2896+
======
2897+
=====
2898+
28382899

28392900
[#_neo_clientnotification_security_externalauthnotenabled]
28402901
=== ExternalAuthNotEnabled
28412902

28422903
.Notification details
28432904
[cols="<1s,<4"]
28442905
|===
2845-
|Code
2906+
|Neo4j code
28462907
m|Neo.ClientNotification.Security.ExternalAuthNotEnabled
28472908
|Title
28482909
a|External auth for user is not enabled.
28492910
|Description
28502911
a|Use setting `dbms.security.require_local_user` to enable external auth.
2851-
|Severity
2852-
m|WARNING
28532912
|Category
28542913
m|SECURITY
2914+
|GQLSTATUS code
2915+
m|01N71
2916+
|Status description
2917+
|warn: external auth disabled.
2918+
Use the setting 'dbms.security.require_local_user' to enable external auth.
2919+
|Classification
2920+
m|SECURITY
2921+
|SeverityLevel
2922+
m|WARNING
28552923
|===
28562924

28572925
.Create a user with an external auth provider when linked users are not enabled
2858-
====
2926+
[.tabbed-example]
2927+
=====
2928+
[.include-with-neo4j-code]
2929+
======
28592930
Command::
28602931
+
28612932
[source, cypher]
@@ -2866,10 +2937,35 @@ CREATE USER foo SET AUTH 'exampleProvider' { SET ID 'idString' }
28662937
Suggestions for improvement::
28672938
Enable linked users through the `dbms.security.require_local_user` setting.
28682939
Until enabled, the new external auth will be ignored, and current external auth behaviors will continue to apply.
2869-
====
2940+
======
2941+
[.include-with-GQLSTATUS-code]
2942+
======
2943+
Command::
2944+
+
2945+
[source, cypher]
2946+
----
2947+
CREATE USER foo SET AUTH 'exampleProvider' { SET ID 'idString' }
2948+
----
2949+
2950+
Returned GQLSTATUS code::
2951+
01N71
2952+
2953+
Returned status description::
2954+
warn: external auth disabled.
2955+
Use the setting 'dbms.security.require_local_user' to enable external auth.
2956+
2957+
Suggestions for improvement::
2958+
Enable linked users through the `dbms.security.require_local_user` setting.
2959+
Until enabled, the new external auth will be ignored, and current external auth behaviors will continue to apply.
2960+
2961+
======
2962+
=====
28702963

28712964
.Alter a user to add an external auth provider when linked users are not enabled
2872-
====
2965+
[.tabbed-example]
2966+
=====
2967+
[.include-with-neo4j-code]
2968+
======
28732969
Command::
28742970
+
28752971
[source, cypher]
@@ -2880,7 +2976,31 @@ ALTER USER foo SET AUTH 'exampleProvider' { SET ID 'idString' }
28802976
Suggestions for improvement::
28812977
Enable linked users through the `dbms.security.require_local_user` setting.
28822978
Until enabled, the new external auth will be ignored, and current external auth behaviors will continue to apply.
2883-
====
2979+
======
2980+
2981+
[.include-with-GQLSTATUS-code]
2982+
======
2983+
Command::
2984+
+
2985+
[source, cypher]
2986+
----
2987+
ALTER USER foo SET AUTH 'exampleProvider' { SET ID 'idString' }
2988+
----
2989+
2990+
Returned GQLSTATUS code::
2991+
01N71
2992+
2993+
Returned status description::
2994+
warn: external auth disabled.
2995+
Use the setting 'dbms.security.require_local_user' to enable external auth.
2996+
2997+
Suggestions for improvement::
2998+
Enable linked users through the `dbms.security.require_local_user` setting.
2999+
Until enabled, the new external auth will be ignored, and current external auth behaviors will continue to apply.
3000+
3001+
======
3002+
=====
3003+
28843004

28853005
[#_topology_notifications]
28863006
== `TOPOLOGY` category

0 commit comments

Comments
 (0)