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

# gpudb::AlterUserRequest

> gpudb::AlterUserRequest — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a4677397b6e719dfa44657790d64bc6ae">GPUdb::alterUser</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/alter__user_8h_source">gpudb/protocol/alter\_user.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

      <tr className="memitem:a100983fa253f5517fe0477cfae6d5f94" id="r_a100983fa253f5517fe0477cfae6d5f94">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a100983fa253f5517fe0477cfae6d5f94">AlterUserRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a100983fa253f5517fe0477cfae6d5f94">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserRequest" title="A set of parameters for GPUdb::alterUser.">AlterUserRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:aec9e37fc87ddfa453519054cf81126df" id="r_aec9e37fc87ddfa453519054cf81126df">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aec9e37fc87ddfa453519054cf81126df">AlterUserRequest</a> (const std::string \&name\_, const std::string \&action\_, const std::string \&value\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:aec9e37fc87ddfa453519054cf81126df">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserRequest" title="A set of parameters for GPUdb::alterUser.">AlterUserRequest</a> object with the specified parameters. <br /></td>
      </tr>

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

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:af927e36491ef2207b67ddf5c8d339c32" id="r_af927e36491ef2207b67ddf5c8d339c32">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#af927e36491ef2207b67ddf5c8d339c32">name</a></td>
      </tr>

      <tr className="memdesc:af927e36491ef2207b67ddf5c8d339c32">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the user to be altered. <br /></td>
      </tr>

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

      <tr className="memitem:aa7f491e0d4d9b6d649ebacc469c3ab0e" id="r_aa7f491e0d4d9b6d649ebacc469c3ab0e">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aa7f491e0d4d9b6d649ebacc469c3ab0e">action</a></td>
      </tr>

      <tr className="memdesc:aa7f491e0d4d9b6d649ebacc469c3ab0e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Modification operation to be applied to the user. <br /></td>
      </tr>

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

      <tr className="memitem:ae41806fd6b08e9ed1ff10f66f176752e" id="r_ae41806fd6b08e9ed1ff10f66f176752e">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ae41806fd6b08e9ed1ff10f66f176752e">value</a></td>
      </tr>

      <tr className="memdesc:ae41806fd6b08e9ed1ff10f66f176752e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The value of the modification, depending on <a className="el" href="#aa7f491e0d4d9b6d649ebacc469c3ab0e">action</a>. <br /></td>
      </tr>

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

      <tr className="memitem:a75cb27da3e2ab8a8c98841dff20fae6e" id="r_a75cb27da3e2ab8a8c98841dff20fae6e">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a75cb27da3e2ab8a8c98841dff20fae6e">options</a></td>
      </tr>

      <tr className="memdesc:a75cb27da3e2ab8a8c98841dff20fae6e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Optional parameters. <br /></td>
      </tr>

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

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

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a4677397b6e719dfa44657790d64bc6ae">GPUdb::alterUser</a>. </p>
      <p>Alters a user. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__user_8h_source#l00017">17</a> of file <a className="el" href="/content/api/cpp/alter__user_8h_source">alter\_user.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a100983fa253f5517fe0477cfae6d5f94">◆ </a></span>AlterUserRequest() <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">gpudb::AlterUserRequest::AlterUserRequest </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </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>Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserRequest" title="A set of parameters for GPUdb::alterUser.">AlterUserRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__user_8h_source#l00022">22</a> of file <a className="el" href="/content/api/cpp/alter__user_8h_source">alter\_user.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aec9e37fc87ddfa453519054cf81126df">◆ </a></span>AlterUserRequest() <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">gpudb::AlterUserRequest::AlterUserRequest </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>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AlterUserRequest" title="A set of parameters for GPUdb::alterUser.">AlterUserRequest</a> object with the specified parameters. </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>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__user_8h_source#l00072">72</a> of file <a className="el" href="/content/api/cpp/alter__user_8h_source">alter\_user.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#aa7f491e0d4d9b6d649ebacc469c3ab0e">◆ </a></span>action</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::AlterUserRequest::action</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Modification operation to be applied to the user. </p>
        <p>Supported values: </p>

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

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__user_8h_source#l00111">111</a> of file <a className="el" href="/content/api/cpp/alter__user_8h_source">alter\_user.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#af927e36491ef2207b67ddf5c8d339c32">◆ </a></span>name</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::AlterUserRequest::name</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Name of the user to be altered. </p>
        <p>Must be an existing user. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__user_8h_source#l00083">83</a> of file <a className="el" href="/content/api/cpp/alter__user_8h_source">alter\_user.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a75cb27da3e2ab8a8c98841dff20fae6e">◆ </a></span>options</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::AlterUserRequest::options</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Optional parameters. </p>
        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__user_8h_source#l00121">121</a> of file <a className="el" href="/content/api/cpp/alter__user_8h_source">alter\_user.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ae41806fd6b08e9ed1ff10f66f176752e">◆ </a></span>value</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::AlterUserRequest::value</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The value of the modification, depending on <a className="el" href="#aa7f491e0d4d9b6d649ebacc469c3ab0e">action</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__user_8h_source#l00116">116</a> of file <a className="el" href="/content/api/cpp/alter__user_8h_source">alter\_user.h</a>.</p>
      </div>
    </div>

    <hr />

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

    <ul>
      <li>gpudb/protocol/<a className="el" href="/content/api/cpp/alter__user_8h_source">alter\_user.h</a></li>
    </ul>
  </div>
</div>