Imported Upstream version 1.15.1
[platform/upstream/krb5.git] / doc / html / _sources / appdev / refs / api / krb5_change_password.txt
1 krb5_change_password -  Change a password for an existing Kerberos account. 
2 ============================================================================
3
4 ..
5
6 .. c:function:: krb5_error_code krb5_change_password(krb5_context context, krb5_creds * creds, const char * newpw, int * result_code, krb5_data * result_code_string, krb5_data * result_string)
7
8 ..
9
10
11 :param:
12
13                   **[in]** **context** - Library context
14
15                   **[in]** **creds** - Credentials for kadmin/changepw service
16
17                   **[in]** **newpw** - New password
18
19                   **[out]** **result_code** - Numeric error code from server
20
21                   **[out]** **result_code_string** - String equivalent to *result_code*
22
23                   **[out]** **result_string** - Change password response from the KDC
24
25
26 ..
27
28
29 :retval:
30          -   0   Success; otherwise - Kerberos error codes
31
32
33 ..
34
35
36
37
38
39
40
41 Change the password for the existing principal identified by *creds* .
42
43
44
45 The possible values of the output *result_code* are:
46
47
48
49  
50  
51          - :data:`KRB5_KPASSWD_SUCCESS` (0) - success
52  
53  
54          - :data:`KRB5_KPASSWD_MALFORMED` (1) - Malformed request error
55  
56  
57          - :data:`KRB5_KPASSWD_HARDERROR` (2) - Server error
58  
59  
60          - :data:`KRB5_KPASSWD_AUTHERROR` (3) - Authentication error
61  
62  
63          - :data:`KRB5_KPASSWD_SOFTERROR` (4) - Password change rejected
64  
65  
66
67
68
69
70
71
72 ..
73
74
75
76
77