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

# create_user_external

<div className="kinetica-pydoc">
  <div className="dl py method">
    <div className="dt sig sig-object py" id="gpudb.GPUdb.create_user_external"> <span className="sig-name descname"><span className="pre">create\_user\_external</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">name</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">None</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">options</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">{"{"}{"}"}</span></span></span><span className="sig-paren">)</span><a href="https://github.com/kineticadb/kinetica-api-python/blob/master/gpudb/gpudb.py#L26166"><span className="viewcode-link"><span className="pre">\[source]</span></span></a></div>

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

      <div className="admonition note">
        <p className="admonition-title">Note</p>
        <p>This method should be used for on-premise deployments only.</p>
      </div>

      <p><strong>Parameters</strong></p>

      <div className="blockquote">
        <div>
          <div className="dl">
            <div className="dt">name (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>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.</p>
            </div>

            <div className="dt">options (<span className="em">dict of str to str</span>) –</div>

            <div className="dd">
              <p>Optional parameters. Allowed keys are:</p>

              <ul>
                <li>
                  <p><strong>activated</strong> – Is the user allowed to login. Allowed values are:</p>

                  <ul className="simple">
                    <li>
                      <p><strong>true</strong> – User may login.</p>
                    </li>

                    <li>
                      <p><strong>false</strong> – User may not login.</p>
                    </li>
                  </ul>

                  <p>The default value is ‘true’.</p>
                </li>

                <li>
                  <p><strong>create\_home\_directory</strong> – When <span className="em">true</span>, a home directory in KiFS is created for this user. Allowed values are:</p>

                  <ul className="simple">
                    <li>
                      <p>true</p>
                    </li>

                    <li>
                      <p>false</p>
                    </li>
                  </ul>

                  <p>The default value is ‘true’.</p>
                </li>

                <li>
                  <p><strong>default\_schema</strong> – Default schema to associate with this user.</p>
                </li>

                <li>
                  <p><strong>directory\_data\_limit</strong> – The maximum capacity to apply to the created directory if <span className="em">create\_home\_directory</span> is <span className="em">true</span>. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.</p>
                </li>

                <li>
                  <p><strong>resource\_group</strong> – Name of an existing resource group to associate with this user.</p>
                </li>
              </ul>

              <p>The default value is an empty dict ( {"{"}{"}"} ).</p>
            </div>
          </div>
        </div>
      </div>

      <p><strong>Returns</strong></p>

      <div className="blockquote">
        <div>
          <p>A dict with the following entries–</p>

          <div className="dl simple">
            <div className="dt">name (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>Value of input parameter <span className="em">name</span>.</p>
            </div>

            <div className="dt">info (<span className="em">dict of str to str</span>) –</div>

            <div className="dd">
              <p>Additional information.</p>
            </div>
          </div>
        </div>
      </div>
    </div>
  </div>
</div>