> ## 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-javadoc">
  <ul className="member-list">
    <li>
      <div className="section detail" id="createUserExternal(com.gpudb.protocol.CreateUserExternalRequest)">
        <h3>createUserExternal</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/CreateUserExternalResponse" title="class in com.gpudb.protocol">CreateUserExternalResponse</a></span> <span className="element-name">createUserExternal</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/protocol/CreateUserExternalRequest" title="class in com.gpudb.protocol">CreateUserExternalRequest</a> request)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>

        <div className="block">
          Creates a new external user (a user whose credentials are managed by an external LDAP).
          <p> <span className="b">Note:</span> This method should be used for on-premise deployments only.</p>
        </div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>request</code> - <a href="/content/api/java/com/gpudb/protocol/CreateUserExternalRequest" title="class in com.gpudb.protocol"><code>Request</code></a> object containing the parameters for the operation.</div>
          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/CreateUserExternalResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>

    <li>
      <div className="section detail" id="createUserExternal(java.lang.String,java.util.Map)">
        <h3>createUserExternal</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/CreateUserExternalResponse" title="class in com.gpudb.protocol">CreateUserExternalResponse</a></span> <span className="element-name">createUserExternal</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> name, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>

        <div className="block">
          Creates a new external user (a user whose credentials are managed by an external LDAP).
          <p> <span className="b">Note:</span> This method should be used for on-premise deployments only.</p>
        </div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>name</code> - 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.</div>

          <div className="dd">
            <code>options</code> - Optional parameters.

            <ul>
              <li>
                <a href="/content/api/java/com/gpudb/protocol/CreateUserExternalRequest.Options#ACTIVATED"><code>ACTIVATED</code></a>: Is the user allowed to login. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/CreateUserExternalRequest.Options#TRUE"><code>TRUE</code></a>: User may login. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/CreateUserExternalRequest.Options#FALSE"><code>FALSE</code></a>: User may not login. </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/CreateUserExternalRequest.Options#TRUE"><code>TRUE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/CreateUserExternalRequest.Options#CREATE_HOME_DIRECTORY"><code>CREATE\_HOME\_DIRECTORY</code></a>: When <a href="/content/api/java/com/gpudb/protocol/CreateUserExternalRequest.Options#TRUE"><code>TRUE</code></a>, a home directory in KiFS is created for this user. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/CreateUserExternalRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/CreateUserExternalRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/CreateUserExternalRequest.Options#TRUE"><code>TRUE</code></a>.
              </li>

              <li><a href="/content/api/java/com/gpudb/protocol/CreateUserExternalRequest.Options#DEFAULT_SCHEMA"><code>DEFAULT\_SCHEMA</code></a>: Default schema to associate with this user. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateUserExternalRequest.Options#DIRECTORY_DATA_LIMIT"><code>DIRECTORY\_DATA\_LIMIT</code></a>: The maximum capacity to apply to the created directory if <a href="/content/api/java/com/gpudb/protocol/CreateUserExternalRequest.Options#CREATE_HOME_DIRECTORY"><code>CREATE\_HOME\_DIRECTORY</code></a> is <a href="/content/api/java/com/gpudb/protocol/CreateUserExternalRequest.Options#TRUE"><code>TRUE</code></a>. Set to -1 to indicate no upper limit. If empty, the system default limit is applied. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateUserExternalRequest.Options#RESOURCE_GROUP"><code>RESOURCE\_GROUP</code></a>: Name of an existing resource group to associate with this user. </li>
            </ul>

            The default value is an empty <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link"><code>Map</code></a>.
          </div>

          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/CreateUserExternalResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>
  </ul>
</div>