2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from CURLOPT_USERNAME.md
|
2024-06-01 14:49:19 -06:00
|
|
|
.TH CURLOPT_USERNAME 3 "2024-06-01" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
2024-03-30 12:28:04 -06:00
|
|
|
CURLOPT_USERNAME \- username to use in authentication
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_USERNAME,
|
|
|
|
|
char *username);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Pass a char pointer as parameter, which should be pointing to the
|
2024-03-30 12:28:04 -06:00
|
|
|
null\-terminated username to use for the transfer.
|
2024-03-15 20:55:33 -06:00
|
|
|
|
2024-03-30 12:28:04 -06:00
|
|
|
\fICURLOPT_USERNAME(3)\fP sets the username to be used in protocol
|
2024-03-15 20:55:33 -06:00
|
|
|
authentication. You should not use this option together with the (older)
|
|
|
|
|
\fICURLOPT_USERPWD(3)\fP option.
|
|
|
|
|
|
|
|
|
|
When using Kerberos V5 authentication with a Windows based server, you should
|
|
|
|
|
include the domain name in order for the server to successfully obtain a
|
|
|
|
|
Kerberos Ticket. If you do not then the initial part of the authentication
|
|
|
|
|
handshake may fail.
|
|
|
|
|
|
2024-03-30 12:28:04 -06:00
|
|
|
When using NTLM, the username can be specified simply as the username without
|
|
|
|
|
the domain name should the server be part of a single domain and forest.
|
2024-03-15 20:55:33 -06:00
|
|
|
|
|
|
|
|
To include the domain name use either Down\-Level Logon Name or UPN (User
|
|
|
|
|
Principal Name) formats. For example, \fBEXAMPLE\user\fP and
|
|
|
|
|
\fBuser@example.com\fP respectively.
|
|
|
|
|
|
|
|
|
|
Some HTTP servers (on Windows) support inclusion of the domain for Basic
|
|
|
|
|
authentication as well.
|
|
|
|
|
|
2024-03-30 12:28:04 -06:00
|
|
|
To specify the password and login options, along with the username, use the
|
2024-03-15 20:55:33 -06:00
|
|
|
\fICURLOPT_PASSWORD(3)\fP and \fICURLOPT_LOGIN_OPTIONS(3)\fP options.
|
|
|
|
|
|
|
|
|
|
The application does not have to keep the string around after setting this
|
|
|
|
|
option.
|
|
|
|
|
.SH DEFAULT
|
|
|
|
|
blank
|
|
|
|
|
.SH PROTOCOLS
|
2024-03-30 12:28:04 -06:00
|
|
|
All
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH EXAMPLE
|
|
|
|
|
.nf
|
|
|
|
|
int main(void)
|
|
|
|
|
{
|
|
|
|
|
CURL *curl = curl_easy_init();
|
|
|
|
|
if(curl) {
|
|
|
|
|
CURLcode res;
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
|
|
|
|
|
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_USERNAME, "clark");
|
|
|
|
|
|
|
|
|
|
res = curl_easy_perform(curl);
|
|
|
|
|
|
|
|
|
|
curl_easy_cleanup(curl);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.fi
|
|
|
|
|
.SH AVAILABILITY
|
|
|
|
|
Added in 7.19.1
|
|
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
|
|
|
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR CURLOPT_HTTPAUTH (3),
|
|
|
|
|
.BR CURLOPT_PASSWORD (3),
|
|
|
|
|
.BR CURLOPT_PROXYAUTH (3),
|
|
|
|
|
.BR CURLOPT_USERPWD (3)
|
