Skip to content

Commit 1138bd8

Browse files
committed
Update documentation
1 parent c6f799f commit 1138bd8

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

Doc/reference/ldap.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -810,7 +810,7 @@ and wait for and return with the server's result, or with
810810

811811
.. py:method:: LDAPObject.passwd(user, oldpw, newpw [, serverctrls=None [, clientctrls=None]]) -> int
812812
813-
.. py:method:: LDAPObject.passwd_s(user, oldpw, newpw [, serverctrls=None [, clientctrls=None]]) -> None
813+
.. py:method:: LDAPObject.passwd_s(user, oldpw, newpw [, serverctrls=None [, clientctrls=None]]) -> (respoid, respvalue)
814814
815815
Perform a ``LDAP Password Modify Extended Operation`` operation
816816
on the entry specified by *user*.
@@ -821,6 +821,11 @@ and wait for and return with the server's result, or with
821821
of the specified *user* which is sometimes used when a user changes
822822
his own password.
823823

824+
``respoid`` is always :py:const:`None`. ``respvalue`` is also
825+
:py:const:`None` unless *newpw* was :py:const:`None`, this requests
826+
that the server generates a new random password. With :py:meth:`passwd_s()`
827+
method, this password is available through ``respvalue.genPasswd``.
828+
824829
*serverctrls* and *clientctrls* like described in section :ref:`ldap-controls`.
825830

826831
The asynchronous version returns the initiated message id.
@@ -830,6 +835,7 @@ and wait for and return with the server's result, or with
830835
.. seealso::
831836

832837
:rfc:`3062` - LDAP Password Modify Extended Operation
838+
:py:mod:`ldap.extop.passwd`
833839

834840

835841

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy