> ## 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="a66fa1b6b57ab173403e8a251afc3747f" />

  <h2 className="memtitle"><span className="permalink"><a href="#a66fa1b6b57ab173403e8a251afc3747f">◆ </a></span>createUserExternal() <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"><a className="el" href="/content/api/cs/classkinetica_1_1CreateUserExternalResponse">CreateUserExternalResponse</a> kinetica.Kinetica.createUserExternal </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1CreateUserExternalRequest">CreateUserExternalRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></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>Creates a new external user (a user whose credentials are managed by an external LDAP). </p>
      <p>This method should be used for on-premise deployments only.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request 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">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L30742">30742</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a5cba7626d0c65f09c7f3d7bfa5fde4f7" />

  <h2 className="memtitle"><span className="permalink"><a href="#a5cba7626d0c65f09c7f3d7bfa5fde4f7">◆ </a></span>createUserExternal() <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"><a className="el" href="/content/api/cs/classkinetica_1_1CreateUserExternalResponse">CreateUserExternalResponse</a> kinetica.Kinetica.createUserExternal </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</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>Creates a new external user (a user whose credentials are managed by an external LDAP). </p>
      <p>This method should be used for on-premise deployments only.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <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="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a2849a234df48f1ae997d08980dadf592">ACTIVATED</a>: Is the user allowed to login. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a873849843595b4ffe5ad577ab5b87c9d">TRUE</a>: User may login. </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a468707ac046d746d955f673912504d75">FALSE</a>: User may not login. </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a873849843595b4ffe5ad577ab5b87c9d">TRUE</a>.
                  </li>

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a7276aa6996bb9125f944ed89a23a1dbf">CREATE\_HOME\_DIRECTORY</a>: When <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a873849843595b4ffe5ad577ab5b87c9d">TRUE</a>, a home directory in KiFS is created for this user. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a873849843595b4ffe5ad577ab5b87c9d">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a468707ac046d746d955f673912504d75">FALSE</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a873849843595b4ffe5ad577ab5b87c9d">TRUE</a>.
                  </li>

                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a32b044e939d6d9c38f62994afef5403f">DEFAULT\_SCHEMA</a>: Default schema to associate with this user. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a575c5c1bab91cd0e24bdf8f30bb29474">DIRECTORY\_DATA\_LIMIT</a>: The maximum capacity to apply to the created directory if <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a7276aa6996bb9125f944ed89a23a1dbf">CREATE\_HOME\_DIRECTORY</a> is <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a873849843595b4ffe5ad577ab5b87c9d">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/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#ae712ecab700bffadcc63ffb2e105737f">RESOURCE\_GROUP</a>: Name of an existing resource group to associate with this user. </li>
                </ul>

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

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L30856">30856</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a5ebcec0394f37d17e945f53b600d6fca" />

  <h2 className="memtitle"><span className="permalink"><a href="#a5ebcec0394f37d17e945f53b600d6fca">◆ </a></span>CreateUserExternalAsync() <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">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1CreateUserExternalResponse">CreateUserExternalResponse</a> > kinetica.Kinetica.CreateUserExternalAsync </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_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">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Creates a new external user (a user whose credentials are managed by an external LDAP). </p>
      <p>(async) </p>
      <p>This method should be used for on-premise deployments only.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request object containing the parameters for the operation.</td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L30760">30760</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="ae7572895e6e765c53183890c44c1421d" />

  <h2 className="memtitle"><span className="permalink"><a href="#ae7572895e6e765c53183890c44c1421d">◆ </a></span>CreateUserExternalAsync() <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">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1CreateUserExternalResponse">CreateUserExternalResponse</a> > kinetica.Kinetica.CreateUserExternalAsync </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Creates a new external user (a user whose credentials are managed by an external LDAP). </p>
      <p>(async) </p>
      <p>This method should be used for on-premise deployments only.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <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="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a2849a234df48f1ae997d08980dadf592">ACTIVATED</a>: Is the user allowed to login. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a873849843595b4ffe5ad577ab5b87c9d">TRUE</a>: User may login. </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a468707ac046d746d955f673912504d75">FALSE</a>: User may not login. </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a873849843595b4ffe5ad577ab5b87c9d">TRUE</a>.
                  </li>

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a7276aa6996bb9125f944ed89a23a1dbf">CREATE\_HOME\_DIRECTORY</a>: When <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a873849843595b4ffe5ad577ab5b87c9d">TRUE</a>, a home directory in KiFS is created for this user. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a873849843595b4ffe5ad577ab5b87c9d">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a468707ac046d746d955f673912504d75">FALSE</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a873849843595b4ffe5ad577ab5b87c9d">TRUE</a>.
                  </li>

                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a32b044e939d6d9c38f62994afef5403f">DEFAULT\_SCHEMA</a>: Default schema to associate with this user. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a575c5c1bab91cd0e24bdf8f30bb29474">DIRECTORY\_DATA\_LIMIT</a>: The maximum capacity to apply to the created directory if <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a7276aa6996bb9125f944ed89a23a1dbf">CREATE\_HOME\_DIRECTORY</a> is <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#a873849843595b4ffe5ad577ab5b87c9d">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/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options#ae712ecab700bffadcc63ffb2e105737f">RESOURCE\_GROUP</a>: Name of an existing resource group to associate with this user. </li>
                </ul>

                The default value is an empty Dictionary.
              </td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L30952">30952</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>
</div>