Skip to content

Commit c72df33

Browse files
committed
Document 01N71 and 00N72 for Linked users
1 parent 19e6d3a commit c72df33

File tree

1 file changed

+132
-14
lines changed

1 file changed

+132
-14
lines changed

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

Lines changed: 132 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2792,16 +2792,28 @@ 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,7 +2871,31 @@ 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
@@ -2848,14 +2909,22 @@ m|Neo.ClientNotification.Security.ExternalAuthNotEnabled
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+
|SeverityLevel
2920+
m|WARNING
28552921
|===
28562922

28572923
.Create a user with an external auth provider when linked users are not enabled
2858-
====
2924+
[.tabbed-example]
2925+
=====
2926+
[.include-with-neo4j-code]
2927+
======
28592928
Command::
28602929
+
28612930
[source, cypher]
@@ -2866,10 +2935,35 @@ CREATE USER foo SET AUTH 'exampleProvider' { SET ID 'idString' }
28662935
Suggestions for improvement::
28672936
Enable linked users through the `dbms.security.require_local_user` setting.
28682937
Until enabled, the new external auth will be ignored, and current external auth behaviors will continue to apply.
2869-
====
2938+
======
2939+
[.include-with-GQLSTATUS-code]
2940+
======
2941+
Command::
2942+
+
2943+
[source, cypher]
2944+
----
2945+
CREATE USER foo SET AUTH 'exampleProvider' { SET ID 'idString' }
2946+
----
2947+
2948+
Returned GQLSTATUS code::
2949+
01N71
2950+
2951+
Returned status description::
2952+
warn: external auth disabled.
2953+
Use the setting 'dbms.security.require_local_user' to enable external auth.
2954+
2955+
Suggestions for improvement::
2956+
Enable linked users through the `dbms.security.require_local_user` setting.
2957+
Until enabled, the new external auth will be ignored, and current external auth behaviors will continue to apply.
2958+
2959+
======
2960+
=====
28702961

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

28853003
[#_topology_notifications]
28863004
== `TOPOLOGY` category

0 commit comments

Comments
 (0)