curl / libcurl / API / curl_easy_setopt / CURLOPT_DISALLOW_USERNAME_IN_URL

CURLOPT_DISALLOW_USERNAME_IN_URL explained

Name

CURLOPT_DISALLOW_USERNAME_IN_URL - disallow specifying username in the URL

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DISALLOW_USERNAME_IN_URL,
                          long disallow);

Description

A long parameter set to 1 tells the library to not allow URLs that include a username.

This is the equivalent to the CURLU_DISALLOW_USER flag for the curl_url_set function.

Default

0 (disabled)

Protocols

This functionality affects all supported protocols

Example

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
 
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
    curl_easy_setopt(curl, CURLOPT_DISALLOW_USERNAME_IN_URL, 1L);
 
    curl_easy_perform(curl);
  }
}

Availability

Added in curl 7.61.0

Return value

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.

curl_easy_perform returns CURLE_LOGIN_DENIED if this option is enabled and a URL containing a username is specified.