aboutsummaryrefslogtreecommitdiffstats
path: root/lib/eldap/doc
diff options
context:
space:
mode:
authorMarcus Arendt <[email protected]>2014-11-03 15:52:36 +0100
committerMarcus Arendt <[email protected]>2014-11-03 15:52:36 +0100
commitc3d006f6542e924c73dbfc76da64dacbeeeadfd0 (patch)
treed9b05e614f3466d9d907c57134ce2a0e1511b435 /lib/eldap/doc
parent5ab95c910b3d0ea2c102f5b6d081e1a548176ec0 (diff)
parent4130dc841ca68e16f5d97e89653fa49b16f4e793 (diff)
downloadotp-c3d006f6542e924c73dbfc76da64dacbeeeadfd0.tar.gz
otp-c3d006f6542e924c73dbfc76da64dacbeeeadfd0.tar.bz2
otp-c3d006f6542e924c73dbfc76da64dacbeeeadfd0.zip
Merge branch 'danielwhite/eldap-password-modify/OTP-12282'
* danielwhite/eldap-password-modify/OTP-12282: eldap: Add support for modifying passwords
Diffstat (limited to 'lib/eldap/doc')
-rw-r--r--lib/eldap/doc/src/eldap.xml40
1 files changed, 40 insertions, 0 deletions
diff --git a/lib/eldap/doc/src/eldap.xml b/lib/eldap/doc/src/eldap.xml
index 4417551aa8..718a8afeec 100644
--- a/lib/eldap/doc/src/eldap.xml
+++ b/lib/eldap/doc/src/eldap.xml
@@ -214,6 +214,46 @@ filter() See present/1, substrings/2,
</desc>
</func>
<func>
+ <name>modify_password(Handle, Dn, NewPasswd) -> ok | {ok, GenPasswd} | {error, Reason}</name>
+ <fsummary>Modify the password of a user.</fsummary>
+ <type>
+ <v>Dn = string()</v>
+ <v>NewPasswd = string()</v>
+ </type>
+ <desc>
+ <p>Modify the password of a user. See <seealso marker="#modify_password/4">modify_password/4</seealso>.</p>
+ </desc>
+ </func>
+ <func>
+ <name>modify_password(Handle, Dn, NewPasswd, OldPasswd) -> ok | {ok, GenPasswd} | {error, Reason}</name>
+ <fsummary>Modify the password of a user.</fsummary>
+ <type>
+ <v>Dn = string()</v>
+ <v>NewPasswd = string()</v>
+ <v>OldPasswd = string()</v>
+ <v>GenPasswd = string()</v>
+ </type>
+ <desc>
+ <p>Modify the password of a user.</p>
+ <list type="bulleted">
+ <item>
+ <p><c>Dn</c>. The user to modify. Should be "" if the
+ modify request is for the user of the LDAP session.</p>
+ </item>
+ <item>
+ <p><c>NewPasswd</c>. The new password to set. Should be ""
+ if the server is to generate the password. In this case,
+ the result will be <c>{ok, GenPasswd}</c>.</p>
+ </item>
+ <item>
+ <p><c>OldPasswd</c>. Sometimes required by server policy
+ for a user to change their password. If not required, use
+ <seealso marker="#modify_password/3">modify_password/3</seealso>.</p>
+ </item>
+ </list>
+ </desc>
+ </func>
+ <func>
<name>modify_dn(Handle, Dn, NewRDN, DeleteOldRDN, NewSupDN) -> ok | {error, Reason}</name>
<fsummary>Modify the DN of an entry.</fsummary>
<type>