> ## 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::CreateUserExternalRequest

> gpudb::CreateUserExternalRequest — 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#a0b63a9b008db5b7c78b098877286af3c">GPUdb::createUserExternal</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/create__user__external_8h_source">gpudb/protocol/create\_user\_external.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:ae1fd469c366497d23ff5d514adae22d9" id="r_ae1fd469c366497d23ff5d514adae22d9">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ae1fd469c366497d23ff5d514adae22d9">CreateUserExternalRequest</a> ()</td>
      </tr>

      <tr className="memdesc:ae1fd469c366497d23ff5d514adae22d9">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserExternalRequest" title="A set of parameters for GPUdb::createUserExternal.">CreateUserExternalRequest</a> object with default parameters. <br /></td>
      </tr>

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

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

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

      <tr className="separator:acec020d691176094fc5cef07590a2d92">
        <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:a9aeb83a40aaf42a0c85cc097ba9a222a" id="r_a9aeb83a40aaf42a0c85cc097ba9a222a">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a9aeb83a40aaf42a0c85cc097ba9a222a">name</a></td>
      </tr>

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

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

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

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

      <tr className="separator:a2875f8439357f9f85d6d1aed3d7f1029">
        <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#a0b63a9b008db5b7c78b098877286af3c">GPUdb::createUserExternal</a>. </p>
      <p>Creates a new external user (a user whose credentials are managed by an external LDAP). </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__user__external_8h_source#l00019">19</a> of file <a className="el" href="/content/api/cpp/create__user__external_8h_source">create\_user\_external.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#ae1fd469c366497d23ff5d514adae22d9">◆ </a></span>CreateUserExternalRequest() <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::CreateUserExternalRequest::CreateUserExternalRequest </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_1CreateUserExternalRequest" title="A set of parameters for GPUdb::createUserExternal.">CreateUserExternalRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__user__external_8h_source#l00025">25</a> of file <a className="el" href="/content/api/cpp/create__user__external_8h_source">create\_user\_external.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#acec020d691176094fc5cef07590a2d92">◆ </a></span>CreateUserExternalRequest() <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::CreateUserExternalRequest::CreateUserExternalRequest </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::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_1CreateUserExternalRequest" title="A set of parameters for GPUdb::createUserExternal.">CreateUserExternalRequest</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 exactly match the user's name in the external LDAP, prefixed with a . Must not be the same name as an existing user. </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#afe69532ac3f347e6009504014b13cc41">create\_user\_external\_activated</a>: Is the user allowed to login. Supported values:

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

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

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

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a88e333db994619b41748d4cd19ff079a">create\_user\_external\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6c95688cb1239a45335e23a9cbe26f7e">create\_user\_external\_false</a> </li>
                      </ul>

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

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a8749c1a123ba224bcdee3254c65e5946">create\_user\_external\_default\_schema</a>: Default schema to associate with this user. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a50b8802403b5539d54ef4ee854f28da7">create\_user\_external\_directory\_data\_limit</a>: The maximum capacity to apply to the created directory if <a className="el" href="/content/api/cpp/namespacegpudb#a5c63f45103dd2638a7a16ea13b809849">create\_home\_directory</a> is <a className="el" href="/content/api/cpp/namespacegpudb#a88e333db994619b41748d4cd19ff079a">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#a424a974b660910e857807f8bf5c6da58">create\_user\_external\_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__external_8h_source#l00102">102</a> of file <a className="el" href="/content/api/cpp/create__user__external_8h_source">create\_user\_external.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the user to be created. </p>
        <p>Must exactly match the user's name in the external LDAP, prefixed with a . Must not be the same name as an existing user. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__user__external_8h_source#l00113">113</a> of file <a className="el" href="/content/api/cpp/create__user__external_8h_source">create\_user\_external.h</a>.</p>
      </div>
    </div>

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

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

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

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

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

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

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

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a88e333db994619b41748d4cd19ff079a">create\_user\_external\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6c95688cb1239a45335e23a9cbe26f7e">create\_user\_external\_false</a> </li>
            </ul>

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

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a8749c1a123ba224bcdee3254c65e5946">create\_user\_external\_default\_schema</a>: Default schema to associate with this user. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a50b8802403b5539d54ef4ee854f28da7">create\_user\_external\_directory\_data\_limit</a>: The maximum capacity to apply to the created directory if <a className="el" href="/content/api/cpp/namespacegpudb#a5c63f45103dd2638a7a16ea13b809849">create\_home\_directory</a> is <a className="el" href="/content/api/cpp/namespacegpudb#a88e333db994619b41748d4cd19ff079a">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#a424a974b660910e857807f8bf5c6da58">create\_user\_external\_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__external_8h_source#l00160">160</a> of file <a className="el" href="/content/api/cpp/create__user__external_8h_source">create\_user\_external.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__external_8h_source">create\_user\_external.h</a></li>
    </ul>
  </div>
</div>