curl / libcurl / API / curl_easy_setopt / CURLOPT_XOAUTH2_BEARER

CURLOPT_XOAUTH2_BEARER explained

Name

CURLOPT_XOAUTH2_BEARER - OAuth 2.0 access token

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_XOAUTH2_BEARER, char *token);

Description

Pass a char pointer as parameter, which should point to the null-terminated OAuth 2.0 Bearer Access Token for use with HTTP, IMAP, LDAP, POP3 and SMTP servers that support the OAuth 2.0 Authorization Framework.

Note: For IMAP, LDAP, POP3 and SMTP, the username used to generate the Bearer Token should be supplied via the CURLOPT_USERNAME option.

The application does not have to keep the string around after setting this option.

Default

NULL

Protocols

HTTP, IMAP, LDAP, POP3 and SMTP

Example

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "pop3://example.com/");
    curl_easy_setopt(curl, CURLOPT_XOAUTH2_BEARER, "1ab9cb22ba269a7");
    res = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

Availability

Added in 7.33.0. Support for OpenLDAP added in 7.82.0.

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.