File tree Expand file tree Collapse file tree 1 file changed +35
-0
lines changed Expand file tree Collapse file tree 1 file changed +35
-0
lines changed Original file line number Diff line number Diff line change @@ -499,6 +499,41 @@ Name of the database to query.
499
499
:Default: ``neo4j.DEFAULT_DATABASE ``
500
500
501
501
502
+ .. _impersonated-user-ref :
503
+
504
+ ``impersonated_user ``
505
+ ---------------------
506
+ Name of the user to impersonate.
507
+ This means that all actions in the session will be executed in the security
508
+ context of the impersonated user. For this, the user for which the
509
+ :class: ``Driver` ` has been created needs to have the appropriate permissions.
510
+
511
+ :Type: ``str ``, None
512
+
513
+
514
+ .. py :data :: None
515
+ :noindex:
516
+
517
+ Will not perform impersonation.
518
+
519
+
520
+ .. Note ::
521
+
522
+ The server or all servers of the cluster need to support impersonation when.
523
+ Otherwise, the driver will raise :py:exc: `.ConfigurationError `
524
+ as soon as it encounters a server that does not.
525
+
526
+
527
+ .. code-block :: python
528
+
529
+ from neo4j import GraphDatabase
530
+ driver = GraphDatabase.driver(uri, auth = (user, password))
531
+ session = driver.session(impersonated_user = " alice" )
532
+
533
+
534
+ :Default: ``None ``
535
+
536
+
502
537
.. _default-access-mode-ref :
503
538
504
539
``default_access_mode ``
You can’t perform that action at this time.
0 commit comments