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

  <h2 className="memtitle"><span className="permalink"><a href="#a4677397b6e719dfa44657790d64bc6ae">◆ </a></span>alterUser() <span className="overload">\[1/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserResponse">AlterUserResponse</a> gpudb::GPUdb::alterUser </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserRequest">AlterUserRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span></td>
          <td>)</td>
          <td> const</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="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserRequest">Request</a> 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"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a927df937dad09d422fe2c60e4f41d1e6" />

  <h2 className="memtitle"><span className="permalink"><a href="#a927df937dad09d422fe2c60e4f41d1e6">◆ </a></span>alterUser() <span className="overload">\[2/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserResponse">AlterUserResponse</a> & gpudb::GPUdb::alterUser </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_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"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserResponse">AlterUserResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</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="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserRequest">Request</a> object containing the parameters for the operation. </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="a39c7b6e35407837c195f99e004e6c000" />

  <h2 className="memtitle"><span className="permalink"><a href="#a39c7b6e35407837c195f99e004e6c000">◆ </a></span>alterUser() <span className="overload">\[3/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserResponse">AlterUserResponse</a> gpudb::GPUdb::alterUser </td>
          <td>(</td>
          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">name</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">action</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">value</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype">const std::map\< std::string, std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">options</span></span> ) const</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="paramdir">\[in]</td>
              <td className="paramname">name</td>
              <td>Name of the user to be altered. Must be an existing user. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">action</td>

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

                <ul>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a01a7ce037957ff2b629ebc5a6d12ce7a">alter\_user\_set\_activated</a>: Is the user allowed to login. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad0995349ef75aee0da07e6651c4654f9">alter\_user\_true</a>: User may login. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a27a8ceeaf66449512148fd40ec1c81b1">alter\_user\_false</a>: User may not login. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#acbb95ae0ca0b9c5fa9b614e3c81a6df6">alter\_user\_set\_comment</a>: Sets the comment for an internal user. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a7ed399093838e20e656ac8aed9077269">alter\_user\_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/cpp/namespacegpudb#a3a2dc1bfe8a2329c2a1f42ee8e9d5128">alter\_user\_set\_password</a>: Sets the password of the user. The user must be an internal user. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a337ee98324e65cce1f62a37301fd9c2a">alter\_user\_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="paramdir">\[in]</td>
              <td className="paramname">value</td>
              <td>The value of the modification, depending on <span className="em arg">action</span>. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">options</td>
              <td>Optional parameters. The default value is an empty map.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="aed7c48162601a63c3a8331740de86645" />

  <h2 className="memtitle"><span className="permalink"><a href="#aed7c48162601a63c3a8331740de86645">◆ </a></span>alterUser() <span className="overload">\[4/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserResponse">AlterUserResponse</a> & gpudb::GPUdb::alterUser </td>
          <td>(</td>
          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">name</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">action</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">value</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype">const std::map\< std::string, std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">options</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserResponse">AlterUserResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</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="paramdir">\[in]</td>
              <td className="paramname">name</td>
              <td>Name of the user to be altered. Must be an existing user. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">action</td>

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

                <ul>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a01a7ce037957ff2b629ebc5a6d12ce7a">alter\_user\_set\_activated</a>: Is the user allowed to login. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad0995349ef75aee0da07e6651c4654f9">alter\_user\_true</a>: User may login. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a27a8ceeaf66449512148fd40ec1c81b1">alter\_user\_false</a>: User may not login. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#acbb95ae0ca0b9c5fa9b614e3c81a6df6">alter\_user\_set\_comment</a>: Sets the comment for an internal user. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a7ed399093838e20e656ac8aed9077269">alter\_user\_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/cpp/namespacegpudb#a3a2dc1bfe8a2329c2a1f42ee8e9d5128">alter\_user\_set\_password</a>: Sets the password of the user. The user must be an internal user. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a337ee98324e65cce1f62a37301fd9c2a">alter\_user\_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="paramdir">\[in]</td>
              <td className="paramname">value</td>
              <td>The value of the modification, depending on <span className="em arg">action</span>. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">options</td>
              <td>Optional parameters. The default value is an empty map. </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>