> ## 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-javadoc">
  <ul className="member-list">
    <li>
      <div className="section detail" id="alterUser(com.gpudb.protocol.AlterUserRequest)">
        <h3>alterUser</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/AlterUserResponse" title="class in com.gpudb.protocol">AlterUserResponse</a></span> <span className="element-name">alterUser</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/protocol/AlterUserRequest" title="class in com.gpudb.protocol">AlterUserRequest</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">Alters a user.</div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>request</code> - <a href="/content/api/java/com/gpudb/protocol/AlterUserRequest" 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/AlterUserResponse" 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="alterUser(java.lang.String,java.lang.String,java.lang.String,java.util.Map)">
        <h3>alterUser</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/AlterUserResponse" title="class in com.gpudb.protocol">AlterUserResponse</a></span> <span className="element-name">alterUser</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/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> action, <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> value, <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">Alters a user.</div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>name</code> - Name of the user to be altered. Must be an existing user.</div>

          <div className="dd">
            <code>action</code> - Modification operation to be applied to the user. Supported values:

            <ul>
              <li><a href="/content/api/java/com/gpudb/protocol/AlterUserRequest.Action#SET_ACTIVATED"><code>SET\_ACTIVATED</code></a>: Is the user allowed to login. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/AlterUserRequest.Action#TRUE"><code>TRUE</code></a>: User may login. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/AlterUserRequest.Action#FALSE"><code>FALSE</code></a>: User may not login. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/AlterUserRequest.Action#SET_COMMENT"><code>SET\_COMMENT</code></a>: Sets the comment for an internal user. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/AlterUserRequest.Action#SET_DEFAULT_SCHEMA"><code>SET\_DEFAULT\_SCHEMA</code></a>: Set the default\_schema for an internal user. An empty string means the user will have no default schema. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/AlterUserRequest.Action#SET_PASSWORD"><code>SET\_PASSWORD</code></a>: Sets the password of the user. The user must be an internal user. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/AlterUserRequest.Action#SET_RESOURCE_GROUP"><code>SET\_RESOURCE\_GROUP</code></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>
          </div>

          <div className="dd"><code>value</code> - The value of the modification, depending on <code> action</code>.</div>
          <div className="dd"><code>options</code> - Optional parameters. 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/AlterUserResponse" 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>