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

# alterUser

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

  <h2 className="memtitle"><span className="permalink"><a href="#a28d78f2ea0dd1d486e4d830d80931688">◆ </a></span>alterUser() <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_1AlterUserResponse">AlterUserResponse</a> kinetica.Kinetica.alterUser </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1AlterUserRequest">AlterUserRequest</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>Alters a user. </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#L14718">14718</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="ac8279ed14942e1e12acdc282b364ae22" />

  <h2 className="memtitle"><span className="permalink"><a href="#ac8279ed14942e1e12acdc282b364ae22">◆ </a></span>alterUser() <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_1AlterUserResponse">AlterUserResponse</a> kinetica.Kinetica.alterUser </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">string</td>
                <td className="paramname"><span className="paramname"><span className="em">action</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">\_value</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>Alters a user. </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 altered. Must be an existing user.</td>
            </tr>

            <tr>
              <td className="paramname">action</td>

              <td>
                Modification operation to be applied to the user. Supported values:

                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterUserRequest_1_1Action#a998b1525acd25a77fb0faeba580f3ff6">SET\_ACTIVATED</a>: Is the user allowed to login. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterUserRequest_1_1Action#a79f933069232b25d89ba8a12b17946c1">TRUE</a>: User may login. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterUserRequest_1_1Action#a2f8a10db24a35587b4e4641c1dd7345d">FALSE</a>: User may not login. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterUserRequest_1_1Action#acb613c6cd3bb285316a426a5ac1a3b6d">SET\_COMMENT</a>: Sets the comment for an internal user. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterUserRequest_1_1Action#aa93da8516c91dfcde37afc29fbead98e">SET\_DEFAULT\_SCHEMA</a>: Set the default\_schema for an internal user. An empty string means the user will have no default schema. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterUserRequest_1_1Action#ac3769b458ccd0b5ead4225c07d8d668c">SET\_PASSWORD</a>: Sets the password of the user. The user must be an internal user. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterUserRequest_1_1Action#a97c771b34c70fbb2c3353efcdde0fe7d">SET\_RESOURCE\_GROUP</a>: Sets the resource group for an internal user. The resource group must exist, otherwise, an empty string assigns the user to the default resource group. </li>
                </ul>
              </td>
            </tr>

            <tr>
              <td className="paramname">\_value</td>
              <td>The value of the modification, depending on <span className="em">action</span> .</td>
            </tr>

            <tr>
              <td className="paramname">options</td>
              <td>Optional parameters. 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#L14801">14801</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="afcb2893d4734af6e3b5bcb9dce8a22b4" />

  <h2 className="memtitle"><span className="permalink"><a href="#afcb2893d4734af6e3b5bcb9dce8a22b4">◆ </a></span>AlterUserAsync() <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_1AlterUserResponse">AlterUserResponse</a> > kinetica.Kinetica.AlterUserAsync </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1AlterUserRequest">AlterUserRequest</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>Alters a user. </p>
      <p>(async)</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#L14733">14733</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="a79066ea67c201f21384fe0d7bce0215f" />

  <h2 className="memtitle"><span className="permalink"><a href="#a79066ea67c201f21384fe0d7bce0215f">◆ </a></span>AlterUserAsync() <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_1AlterUserResponse">AlterUserResponse</a> > kinetica.Kinetica.AlterUserAsync </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">string</td>
                <td className="paramname"><span className="paramname"><span className="em">action</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">\_value</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>Alters a user. </p>
      <p>(async)</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 altered. Must be an existing user.</td>
            </tr>

            <tr>
              <td className="paramname">action</td>

              <td>
                Modification operation to be applied to the user. Supported values:

                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterUserRequest_1_1Action#a998b1525acd25a77fb0faeba580f3ff6">SET\_ACTIVATED</a>: Is the user allowed to login. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterUserRequest_1_1Action#a79f933069232b25d89ba8a12b17946c1">TRUE</a>: User may login. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterUserRequest_1_1Action#a2f8a10db24a35587b4e4641c1dd7345d">FALSE</a>: User may not login. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterUserRequest_1_1Action#acb613c6cd3bb285316a426a5ac1a3b6d">SET\_COMMENT</a>: Sets the comment for an internal user. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterUserRequest_1_1Action#aa93da8516c91dfcde37afc29fbead98e">SET\_DEFAULT\_SCHEMA</a>: Set the default\_schema for an internal user. An empty string means the user will have no default schema. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterUserRequest_1_1Action#ac3769b458ccd0b5ead4225c07d8d668c">SET\_PASSWORD</a>: Sets the password of the user. The user must be an internal user. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterUserRequest_1_1Action#a97c771b34c70fbb2c3353efcdde0fe7d">SET\_RESOURCE\_GROUP</a>: Sets the resource group for an internal user. The resource group must exist, otherwise, an empty string assigns the user to the default resource group. </li>
                </ul>
              </td>
            </tr>

            <tr>
              <td className="paramname">\_value</td>
              <td>The value of the modification, depending on <span className="em">action</span> .</td>
            </tr>

            <tr>
              <td className="paramname">options</td>
              <td>Optional parameters. 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#L14871">14871</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>