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

# kinetica.CreateUserExternalRequest.Options

> kinetica.CreateUserExternalRequest.Options — Kinetica C# API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of string constants for the parameter <a className="el" href="/content/api/cs/classkinetica_1_1CreateUserExternalRequest#ae4eb786a706276cdcdc8921c27383db4" title="Optional parameters.">CreateUserExternalRequest.options</a>. <a href="#details">More...</a></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="pub-static-attribs" />

            Static Public Attributes
          </h2>
        </td>
      </tr>

      <tr className="memitem:a2849a234df48f1ae997d08980dadf592" id="r_a2849a234df48f1ae997d08980dadf592">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a2849a234df48f1ae997d08980dadf592">ACTIVATED</a> = "activated"</td>
      </tr>

      <tr className="memdesc:a2849a234df48f1ae997d08980dadf592">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Is the user allowed to login. <br /></td>
      </tr>

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

      <tr className="memitem:a873849843595b4ffe5ad577ab5b87c9d" id="r_a873849843595b4ffe5ad577ab5b87c9d">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a873849843595b4ffe5ad577ab5b87c9d">TRUE</a> = "true"</td>
      </tr>

      <tr className="memdesc:a873849843595b4ffe5ad577ab5b87c9d">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options" title="A set of string constants for the parameter CreateUserExternalRequest.options.">CreateUserExternalRequest.Options</a> options. <br /></td>
      </tr>

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

      <tr className="memitem:a468707ac046d746d955f673912504d75" id="r_a468707ac046d746d955f673912504d75">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a468707ac046d746d955f673912504d75">FALSE</a> = "false"</td>
      </tr>

      <tr className="memdesc:a468707ac046d746d955f673912504d75">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options" title="A set of string constants for the parameter CreateUserExternalRequest.options.">CreateUserExternalRequest.Options</a> options. <br /></td>
      </tr>

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

      <tr className="memitem:a7276aa6996bb9125f944ed89a23a1dbf" id="r_a7276aa6996bb9125f944ed89a23a1dbf">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a7276aa6996bb9125f944ed89a23a1dbf">CREATE\_HOME\_DIRECTORY</a> = "create\_home\_directory"</td>
      </tr>

      <tr className="memdesc:a7276aa6996bb9125f944ed89a23a1dbf">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">When <a className="el" href="#a873849843595b4ffe5ad577ab5b87c9d">TRUE</a>, a home directory in KiFS is created for this user. <br /></td>
      </tr>

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

      <tr className="memitem:a32b044e939d6d9c38f62994afef5403f" id="r_a32b044e939d6d9c38f62994afef5403f">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a32b044e939d6d9c38f62994afef5403f">DEFAULT\_SCHEMA</a> = "default\_schema"</td>
      </tr>

      <tr className="memdesc:a32b044e939d6d9c38f62994afef5403f">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Default schema to associate with this user. <br /></td>
      </tr>

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

      <tr className="memitem:a575c5c1bab91cd0e24bdf8f30bb29474" id="r_a575c5c1bab91cd0e24bdf8f30bb29474">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a575c5c1bab91cd0e24bdf8f30bb29474">DIRECTORY\_DATA\_LIMIT</a> = "directory\_data\_limit"</td>
      </tr>

      <tr className="memdesc:a575c5c1bab91cd0e24bdf8f30bb29474">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The maximum capacity to apply to the created directory if <a className="el" href="#a7276aa6996bb9125f944ed89a23a1dbf">CREATE\_HOME\_DIRECTORY</a> is <a className="el" href="#a873849843595b4ffe5ad577ab5b87c9d">TRUE</a>. <br /></td>
      </tr>

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

      <tr className="memitem:ae712ecab700bffadcc63ffb2e105737f" id="r_ae712ecab700bffadcc63ffb2e105737f">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ae712ecab700bffadcc63ffb2e105737f">RESOURCE\_GROUP</a> = "resource\_group"</td>
      </tr>

      <tr className="memdesc:ae712ecab700bffadcc63ffb2e105737f">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of an existing resource group to associate with this user. <br /></td>
      </tr>

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

    <div id="details" />

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of string constants for the parameter <a className="el" href="/content/api/cs/classkinetica_1_1CreateUserExternalRequest#ae4eb786a706276cdcdc8921c27383db4" title="Optional parameters.">CreateUserExternalRequest.options</a>. </p>
      <p>Optional parameters.</p>
      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateUserExternal.cs#L21">21</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateUserExternal.cs">CreateUserExternal.cs</a>.</p>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>

    <div id="a2849a234df48f1ae997d08980dadf592" />

    <h2 className="memtitle"><span className="permalink"><a href="#a2849a234df48f1ae997d08980dadf592">◆ </a></span>ACTIVATED</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.CreateUserExternalRequest.Options.ACTIVATED = "activated"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Is the user allowed to login. </p>
        <p>Supported values:</p>

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

        <p>The default value is <a className="el" href="#a873849843595b4ffe5ad577ab5b87c9d">TRUE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateUserExternal.cs#L42">42</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateUserExternal.cs">CreateUserExternal.cs</a>.</p>
      </div>
    </div>

    <div id="a7276aa6996bb9125f944ed89a23a1dbf" />

    <h2 className="memtitle"><span className="permalink"><a href="#a7276aa6996bb9125f944ed89a23a1dbf">◆ </a></span>CREATE\_HOME\_DIRECTORY</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.CreateUserExternalRequest.Options.CREATE\_HOME\_DIRECTORY = "create\_home\_directory"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>When <a className="el" href="#a873849843595b4ffe5ad577ab5b87c9d">TRUE</a>, a home directory in KiFS is created for this user. </p>
        <p>Supported values:</p>

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

        <p>The default value is <a className="el" href="#a873849843595b4ffe5ad577ab5b87c9d">TRUE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateUserExternal.cs#L71">71</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateUserExternal.cs">CreateUserExternal.cs</a>.</p>
      </div>
    </div>

    <div id="a32b044e939d6d9c38f62994afef5403f" />

    <h2 className="memtitle"><span className="permalink"><a href="#a32b044e939d6d9c38f62994afef5403f">◆ </a></span>DEFAULT\_SCHEMA</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.CreateUserExternalRequest.Options.DEFAULT\_SCHEMA = "default\_schema"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Default schema to associate with this user. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateUserExternal.cs#L74">74</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateUserExternal.cs">CreateUserExternal.cs</a>.</p>
      </div>
    </div>

    <div id="a575c5c1bab91cd0e24bdf8f30bb29474" />

    <h2 className="memtitle"><span className="permalink"><a href="#a575c5c1bab91cd0e24bdf8f30bb29474">◆ </a></span>DIRECTORY\_DATA\_LIMIT</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.CreateUserExternalRequest.Options.DIRECTORY\_DATA\_LIMIT = "directory\_data\_limit"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The maximum capacity to apply to the created directory if <a className="el" href="#a7276aa6996bb9125f944ed89a23a1dbf">CREATE\_HOME\_DIRECTORY</a> is <a className="el" href="#a873849843595b4ffe5ad577ab5b87c9d">TRUE</a>. </p>
        <p>Set to -1 to indicate no upper limit. If empty, the system default limit is applied.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateUserExternal.cs#L83">83</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateUserExternal.cs">CreateUserExternal.cs</a>.</p>
      </div>
    </div>

    <div id="a468707ac046d746d955f673912504d75" />

    <h2 className="memtitle"><span className="permalink"><a href="#a468707ac046d746d955f673912504d75">◆ </a></span>FALSE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.CreateUserExternalRequest.Options.FALSE = "false"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options" title="A set of string constants for the parameter CreateUserExternalRequest.options.">CreateUserExternalRequest.Options</a> options. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateUserExternal.cs#L50">50</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateUserExternal.cs">CreateUserExternal.cs</a>.</p>
      </div>
    </div>

    <div id="ae712ecab700bffadcc63ffb2e105737f" />

    <h2 className="memtitle"><span className="permalink"><a href="#ae712ecab700bffadcc63ffb2e105737f">◆ </a></span>RESOURCE\_GROUP</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.CreateUserExternalRequest.Options.RESOURCE\_GROUP = "resource\_group"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Name of an existing resource group to associate with this user. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateUserExternal.cs#L87">87</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateUserExternal.cs">CreateUserExternal.cs</a>.</p>
      </div>
    </div>

    <div id="a873849843595b4ffe5ad577ab5b87c9d" />

    <h2 className="memtitle"><span className="permalink"><a href="#a873849843595b4ffe5ad577ab5b87c9d">◆ </a></span>TRUE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.CreateUserExternalRequest.Options.TRUE = "true"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1CreateUserExternalRequest_1_1Options" title="A set of string constants for the parameter CreateUserExternalRequest.options.">CreateUserExternalRequest.Options</a> options. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateUserExternal.cs#L46">46</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateUserExternal.cs">CreateUserExternal.cs</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct was generated from the following file:

    <ul>
      <li>Kinetica/Protocol/<a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateUserExternal.cs">CreateUserExternal.cs</a></li>
    </ul>
  </div>
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.