> ## 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.

# createUserExternal

<div className="kinetica-doxygen">
  <div id="a0b63a9b008db5b7c78b098877286af3c" />

  <h2 className="memtitle"><span className="permalink"><a href="#a0b63a9b008db5b7c78b098877286af3c">◆ </a></span>createUserExternal() <span className="overload">\[1/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserExternalResponse">CreateUserExternalResponse</a> gpudb::GPUdb::createUserExternal </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserExternalRequest">CreateUserExternalRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span></td>
          <td>)</td>
          <td> const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Creates a new external user (a user whose credentials are managed by an external LDAP). </p>

      <div className="dl section attention">
        <div className="dt">Attention</div>
        <div className="dd">This method should be used for on-premise deployments only.</div>
      </div>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserExternalRequest">Request</a> object containing the parameters for the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserExternalResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a536d649e7acb6a0e2c0a138c8c8d7dda" />

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

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserExternalResponse">CreateUserExternalResponse</a> & gpudb::GPUdb::createUserExternal </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserExternalRequest">CreateUserExternalRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserExternalResponse">CreateUserExternalResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Creates a new external user (a user whose credentials are managed by an external LDAP). </p>

      <div className="dl section attention">
        <div className="dt">Attention</div>
        <div className="dd">This method should be used for on-premise deployments only.</div>
      </div>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserExternalRequest">Request</a> object containing the parameters for the operation. </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserExternalResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserExternalResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="abf75994b026f56c55ebc0abef27b0227" />

  <h2 className="memtitle"><span className="permalink"><a href="#abf75994b026f56c55ebc0abef27b0227">◆ </a></span>createUserExternal() <span className="overload">\[3/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserExternalResponse">CreateUserExternalResponse</a> gpudb::GPUdb::createUserExternal </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> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Creates a new external user (a user whose credentials are managed by an external LDAP). </p>

      <div className="dl section attention">
        <div className="dt">Attention</div>
        <div className="dd">This method should be used for on-premise deployments only.</div>
      </div>

      <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>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserExternalResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="abbcbb0ef0e7787d413ae18f5e9f3cfd7" />

  <h2 className="memtitle"><span className="permalink"><a href="#abbcbb0ef0e7787d413ae18f5e9f3cfd7">◆ </a></span>createUserExternal() <span className="overload">\[4/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserExternalResponse">CreateUserExternalResponse</a> & gpudb::GPUdb::createUserExternal </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>

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

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserExternalResponse">CreateUserExternalResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Creates a new external user (a user whose credentials are managed by an external LDAP). </p>

      <div className="dl section attention">
        <div className="dt">Attention</div>
        <div className="dd">This method should be used for on-premise deployments only.</div>
      </div>

      <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>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserExternalResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateUserExternalResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>