> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# gpudb::CreateUserInternalRequest

> gpudb::CreateUserInternalRequest — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a00da63ad9e89859132ae0b44226d9015">GPUdb::createUserInternal</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/create__user__internal_8h_source">gpudb/protocol/create\_user\_internal.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

      <tr className="memitem:a4dfd1fc948bf3b8f7f51cf96ca191318" id="r_a4dfd1fc948bf3b8f7f51cf96ca191318">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a4dfd1fc948bf3b8f7f51cf96ca191318">CreateUserInternalRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a4dfd1fc948bf3b8f7f51cf96ca191318">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserInternalRequest" title="A set of parameters for GPUdb::createUserInternal.">CreateUserInternalRequest</a> object with default parameters. <br /></td>
      </tr>

      <tr className="separator:a4dfd1fc948bf3b8f7f51cf96ca191318">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a063c13e3263138fc929a360e3df306de" id="r_a063c13e3263138fc929a360e3df306de">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a063c13e3263138fc929a360e3df306de">CreateUserInternalRequest</a> (const std::string \&name\_, const std::string \&password\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:a063c13e3263138fc929a360e3df306de">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserInternalRequest" title="A set of parameters for GPUdb::createUserInternal.">CreateUserInternalRequest</a> object with the specified parameters. <br /></td>
      </tr>

      <tr className="separator:a063c13e3263138fc929a360e3df306de">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:a79fb2533eda705dc546dc473452fb869" id="r_a79fb2533eda705dc546dc473452fb869">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a79fb2533eda705dc546dc473452fb869">name</a></td>
      </tr>

      <tr className="memdesc:a79fb2533eda705dc546dc473452fb869">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the user to be created. <br /></td>
      </tr>

      <tr className="separator:a79fb2533eda705dc546dc473452fb869">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a06c013ec3e1ad47e5759ba9b22e7b653" id="r_a06c013ec3e1ad47e5759ba9b22e7b653">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a06c013ec3e1ad47e5759ba9b22e7b653">password</a></td>
      </tr>

      <tr className="memdesc:a06c013ec3e1ad47e5759ba9b22e7b653">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Initial password of the user to be created. <br /></td>
      </tr>

      <tr className="separator:a06c013ec3e1ad47e5759ba9b22e7b653">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a50ec4b06f092b1d98ca45a7f2952af4d" id="r_a50ec4b06f092b1d98ca45a7f2952af4d">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a50ec4b06f092b1d98ca45a7f2952af4d">options</a></td>
      </tr>

      <tr className="memdesc:a50ec4b06f092b1d98ca45a7f2952af4d">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Optional parameters. <br /></td>
      </tr>

      <tr className="separator:a50ec4b06f092b1d98ca45a7f2952af4d">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a00da63ad9e89859132ae0b44226d9015">GPUdb::createUserInternal</a>. </p>
      <p>Creates a new internal user (a user whose credentials are managed by the database system). </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__user__internal_8h_source#l00019">19</a> of file <a className="el" href="/content/api/cpp/create__user__internal_8h_source">create\_user\_internal.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a4dfd1fc948bf3b8f7f51cf96ca191318">◆ </a></span>CreateUserInternalRequest() <span className="overload">\[1/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::CreateUserInternalRequest::CreateUserInternalRequest </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </span>
                  </td>

                  <td>)</td>

                  <td />
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserInternalRequest" title="A set of parameters for GPUdb::createUserInternal.">CreateUserInternalRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__user__internal_8h_source#l00025">25</a> of file <a className="el" href="/content/api/cpp/create__user__internal_8h_source">create\_user\_internal.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a063c13e3263138fc929a360e3df306de">◆ </a></span>CreateUserInternalRequest() <span className="overload">\[2/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::CreateUserInternalRequest::CreateUserInternalRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">name\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">password\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::map\< std::string, std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">options\_</span></span> )</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserInternalRequest" title="A set of parameters for GPUdb::createUserInternal.">CreateUserInternalRequest</a> object with the specified parameters. </p>

        <div className="dl params">
          <div className="dt">Parameters</div>

          <div className="dd">
            <table className="params">
              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">name\_</td>
                <td>Name of the user to be created. Must contain only lowercase letters, digits, and underscores, and cannot begin with a digit. Must not be the same name as an existing user or role. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">password\_</td>
                <td>Initial password of the user to be created. May be an empty string for no password. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">options\_</td>

                <td>
                  Optional parameters.

                  <ul>
                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a7eb777a1a597f5a1e3970afa452494b0">create\_user\_internal\_activated</a>: Is the user allowed to login. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab60cb39a81e1a932dc819dc2ddb478a5">create\_user\_internal\_true</a>: User may login. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#af9ea71b4289809dc994bab3c99680750">create\_user\_internal\_false</a>: User may not login. </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#ab60cb39a81e1a932dc819dc2ddb478a5">create\_user\_internal\_true</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#ab45a5d4f3fda1f3cd4e374ef812d0df7">create\_user\_internal\_create\_home\_directory</a>: When <a className="el" href="/content/api/cpp/namespacegpudb#ab60cb39a81e1a932dc819dc2ddb478a5">true</a>, a home directory in KiFS is created for this user. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab60cb39a81e1a932dc819dc2ddb478a5">create\_user\_internal\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#af9ea71b4289809dc994bab3c99680750">create\_user\_internal\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#ab60cb39a81e1a932dc819dc2ddb478a5">create\_user\_internal\_true</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a1ef594329600bc9f2b2598d0e6d70e1b">create\_user\_internal\_default\_schema</a>: Default schema to associate with this user. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a53d2f5c597c8b760067cc00d91f47d1d">create\_user\_internal\_directory\_data\_limit</a>: The maximum capacity to apply to the created directory if <a className="el" href="/content/api/cpp/namespacegpudb#ab45a5d4f3fda1f3cd4e374ef812d0df7">create\_home\_directory</a> is <a className="el" href="/content/api/cpp/namespacegpudb#ab60cb39a81e1a932dc819dc2ddb478a5">true</a>. Set to -1 to indicate no upper limit. If empty, the system default limit is applied. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad0269eedd215ae86df0e34bff1b78b53">create\_user\_internal\_resource\_group</a>: Name of an existing resource group to associate with this user. </li>
                  </ul>

                  The default value is an empty map.
                </td>
              </tr>
            </table>
          </div>
        </div>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__user__internal_8h_source#l00105">105</a> of file <a className="el" href="/content/api/cpp/create__user__internal_8h_source">create\_user\_internal.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a79fb2533eda705dc546dc473452fb869">◆ </a></span>name</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::CreateUserInternalRequest::name</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Name of the user to be created. </p>
        <p>Must contain only lowercase letters, digits, and underscores, and cannot begin with a digit. Must not be the same name as an existing user or role. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__user__internal_8h_source#l00117">117</a> of file <a className="el" href="/content/api/cpp/create__user__internal_8h_source">create\_user\_internal.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a50ec4b06f092b1d98ca45a7f2952af4d">◆ </a></span>options</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::CreateUserInternalRequest::options</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Optional parameters. </p>

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a7eb777a1a597f5a1e3970afa452494b0">create\_user\_internal\_activated</a>: Is the user allowed to login. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab60cb39a81e1a932dc819dc2ddb478a5">create\_user\_internal\_true</a>: User may login. </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#af9ea71b4289809dc994bab3c99680750">create\_user\_internal\_false</a>: User may not login. </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#ab60cb39a81e1a932dc819dc2ddb478a5">create\_user\_internal\_true</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#ab45a5d4f3fda1f3cd4e374ef812d0df7">create\_user\_internal\_create\_home\_directory</a>: When <a className="el" href="/content/api/cpp/namespacegpudb#ab60cb39a81e1a932dc819dc2ddb478a5">true</a>, a home directory in KiFS is created for this user. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab60cb39a81e1a932dc819dc2ddb478a5">create\_user\_internal\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#af9ea71b4289809dc994bab3c99680750">create\_user\_internal\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#ab60cb39a81e1a932dc819dc2ddb478a5">create\_user\_internal\_true</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a1ef594329600bc9f2b2598d0e6d70e1b">create\_user\_internal\_default\_schema</a>: Default schema to associate with this user. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a53d2f5c597c8b760067cc00d91f47d1d">create\_user\_internal\_directory\_data\_limit</a>: The maximum capacity to apply to the created directory if <a className="el" href="/content/api/cpp/namespacegpudb#ab45a5d4f3fda1f3cd4e374ef812d0df7">create\_home\_directory</a> is <a className="el" href="/content/api/cpp/namespacegpudb#ab60cb39a81e1a932dc819dc2ddb478a5">true</a>. Set to -1 to indicate no upper limit. If empty, the system default limit is applied. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad0269eedd215ae86df0e34bff1b78b53">create\_user\_internal\_resource\_group</a>: Name of an existing resource group to associate with this user. </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__user__internal_8h_source#l00170">170</a> of file <a className="el" href="/content/api/cpp/create__user__internal_8h_source">create\_user\_internal.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a06c013ec3e1ad47e5759ba9b22e7b653">◆ </a></span>password</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::CreateUserInternalRequest::password</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Initial password of the user to be created. </p>
        <p>May be an empty string for no password. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__user__internal_8h_source#l00123">123</a> of file <a className="el" href="/content/api/cpp/create__user__internal_8h_source">create\_user\_internal.h</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct was generated from the following file:

    <ul>
      <li>gpudb/protocol/<a className="el" href="/content/api/cpp/create__user__internal_8h_source">create\_user\_internal.h</a></li>
    </ul>
  </div>
</div>