---
name: "CURLOPT_XOAUTH2_BEARER"
section: "3"
platform: "macos"
package: "curl"
version: "166.0.0.0.1"
release: "macOS 26.5"
platforms: ["linux", "macos"]
url: "https://new.carta.tech/CURLOPT_XOAUTH2_BEARER"
---

# CURLOPT\_XOAUTH2\_BEARER(3)

OAuth 2.0 access token

## 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 user name used to generate the Bearer Token should be supplied via the *[CURLOPT\_USERNAME(3)](/CURLOPT_USERNAME/3.md)* 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.

## SEE ALSO

[**CURLOPT\_MAIL\_AUTH**(3)](/CURLOPT_MAIL_AUTH/3.md), [**CURLOPT\_USERNAME**(3)](/CURLOPT_USERNAME/3.md)