[#GenerateAuthCookie]
= GenerateAuthCookie
:mrdocs:

Generate a new RPC authentication cookie and write it to disk

== Synopsis

Declared in `<rpc/request.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:AuthCookieResult.adoc[AuthCookieResult]
GenerateAuthCookie(
    std::optional<fs::perms> const& cookie_perms,
    std::string& user,
    std::string& pass);
----

== Return Value

Whether the cookie was generated, disabled, or failed.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *cookie_perms* [in]
| Filesystem permissions to use for the cookie file.
| *user* [out]
| Generated username, only set if `OK` is returned.
| *pass* [out]
| Generated password, only set if `OK` is returned.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#