mongoc_uri_set_auth_mechanism()#

Synopsis#

bool
mongoc_uri_set_auth_mechanism (mongoc_uri_t *uri, const char *value);

Parameters#

  • uri: A mongoc_uri_t.

  • value: The new “authMechanism” value.

Description#

Sets the “authMechanism” URI option, such as “SCRAM-SHA-1” or “GSSAPI”, after the URI has been parsed from a string.

Updates the option in-place if already set, otherwise appends it to the URI’s bson_t of options.

Returns#

Returns false if the option cannot be set, for example if value is not valid UTF-8.

See also

Authentication
mongoc_uri_get_auth_mechanism()
mongoc_uri_get_auth_source()
mongoc_uri_get_mechanism_properties()
mongoc_uri_set_auth_mechanism()
mongoc_uri_set_auth_source()
mongoc_uri_set_mechanism_properties()