Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_SASL_AUTHZID (3)

Name

CURLOPT_SASL_AUTHZID - authorization identity (identity to act as)

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SASL_AUTHZID, char *authzid);

Description

CURLOPT_SASL_AUTHZID(3)    curl_easy_setopt options    CURLOPT_SASL_AUTHZID(3)



NAME
       CURLOPT_SASL_AUTHZID - authorization identity (identity to act as)

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SASL_AUTHZID, char *authzid);

DESCRIPTION
       Pass a char * as parameter, which should be pointing to the null-termi-
       nated authorization identity (authzid) for the transfer. Only  applica-
       ble to the PLAIN SASL authentication mechanism where it is optional.

       When not specified only the authentication identity (authcid) as speci-
       fied by the username will be sent to the server, along with  the  pass-
       word.  The  server will derive a authzid from the authcid when not pro-
       vided, which it will then uses internally.

       When the authzid is specified, the use of which is server dependent, it
       can  be  used  to  access  another user's inbox, that the user has been
       granted access to, or a shared mailbox for example.

DEFAULT
       blank

PROTOCOLS
       IMAP, LDAP, POP3 and SMTP

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "imap://example.com/");
         curl_easy_setopt(curl, CURLOPT_USERNAME, "Kurt");
         curl_easy_setopt(curl, CURLOPT_PASSWORD, "xipj3plmq");
         curl_easy_setopt(curl, CURLOPT_SASL_AUTHZID, "Ursel");
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.66.0. Support for OpenLDAP added in 7.82.0.

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


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLOPT_USERNAME(3), CURLOPT_PASSWORD(3), .BRCURLOPT_USERPWD(3)



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source       was       downloaded      from       https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                  April 05, 2022         CURLOPT_SASL_AUTHZID(3)