1 .\" **************************************************************************
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
8 .\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al.
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
21 .\" **************************************************************************
23 .TH CURLOPT_USERNAME 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
25 CURLOPT_USERNAME \- user name to use in authentication
28 #include <curl/curl.h>
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_USERNAME,
33 Pass a char * as parameter, which should be pointing to the zero terminated
34 user name to use for the transfer.
36 \fICURLOPT_USERNAME(3)\fP sets the user name to be used in protocol
37 authentication. You should not use this option together with the (older)
38 \fICURLOPT_USERPWD(3)\fP option.
40 When using Kerberos V5 authentication with a Windows based server, you should
41 include the domain name in order for the server to successfully obtain a
42 Kerberos Ticket. If you don't then the initial part of the authentication
45 When using NTLM, the user name can be specified simply as the user name
46 without the domain name should the server be part of a single domain and
49 To include the domain name use either Down-Level Logon Name or UPN (User
50 Principal Name) formats. For example, EXAMPLE\\user and user@example.com
53 Some HTTP servers (on Windows) support inclusion of the domain for Basic
54 authentication as well.
56 To specify the password and login options, along with the user name, use the
57 \fICURLOPT_PASSWORD(3)\fP and \fICURLOPT_LOGIN_OPTIONS(3)\fP options.
67 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
68 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
70 .BR CURLOPT_USERPWD "(3), " CURLOPT_PASSWORD "(3), "
71 .BR CURLOPT_HTTPAUTH "(3), " CURLOPT_PROXYAUTH "(3)"