]> git.proxmox.com Git - ceph.git/blob - ceph/src/civetweb/docs/api/mg_send_digest_access_authentication_request.md
update sources to ceph Nautilus 14.2.1
[ceph.git] / ceph / src / civetweb / docs / api / mg_send_digest_access_authentication_request.md
1 # Civetweb API Reference
2
3 ### `mg_send_digest_access_authentication_request( conn, realm );`
4
5 ### Parameters
6
7 | Parameter | Type | Description |
8 | :--- | :--- | :--- |
9 |**`conn`**|`struct mg_connection *`| A pointer to the connection to be used to send data |
10 |**`realm`**|`const char *`| The requested authentication realm or NULL |
11
12 ### Return Value
13
14 | Type | Description |
15 | :--- | :--- |
16 |`int`| An integer indicating success or failure |
17
18 ### Description
19
20 This function can be used to send a HTTP Digest Authentication request to the client.
21 Browsers will react with repeating the request with user authentication data.
22 If they do not yet know the user authentication for the requested realm, they will show
23 a dialog to query username and password.
24 In case the authentication realm (also called domain) is NULL, the parameter
25 `authentication_domain` from the server configuration is used.
26 The function returns a negative number on errors.
27
28 ### See Also
29
30 * [`mg_check_digest_access_authentication();`](mg_check_digest_access_authentication.md)
31 * [`mg_modify_passwords_file();`](mg_modify_passwords_file.md)
32 * [`mg_send_http_error();`](mg_send_http_error.md)
33 * [`mg_write();`](mg_write.md)
34 * [`mg_printf();`](mg_print.md)
35