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

# /alter/user

```
URL: http://<db.host>:<db.port>/alter/user
```

Alters a user.

## Input Parameter Description

<ParamField body="name" type="string">
  Name of the user to be altered. Must be an existing user.
</ParamField>

<ParamField body="action" type="string">
  Modification operation to be applied to the user.

  * **set\_activated**: Is the user allowed to login.
  * **true**: User may login.
  * **false**: User may not login.
  * **set\_comment**: Sets the comment for an internal user.
  * **set\_default\_schema**: Set the default\_schema for an internal user. An empty string means the user will have no default schema.
  * **set\_password**: Sets the password of the user. The user must be an internal user.
  * **set\_resource\_group**: 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.
</ParamField>

<ParamField body="value" type="string">
  The value of the modification, depending on input parameter *action*.
</ParamField>

<ParamField body="options" type="map of string to strings">
  Optional parameters.

  The default value is an empty map ( \{} ).
</ParamField>

## Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query.  Here is a description of the various fields of the wrapper:

<ResponseField name="status" type="String">
  'OK' or 'ERROR'
</ResponseField>

<ResponseField name="message" type="String">
  Empty if success or an error message
</ResponseField>

<ResponseField name="data_type" type="String">
  'alter\_user\_response' or 'none' in case of an error
</ResponseField>

<ResponseField name="data" type="String">
  Empty string
</ResponseField>

<ResponseField name="data_str" type="JSON or String">
  This embedded JSON represents the result of the /alter/user endpoint:

  <Expandable title="data_str">
    <ResponseField name="name" type="string">
      Value of input parameter *name*.
    </ResponseField>

    <ResponseField name="info" type="map of string to strings">
      Additional information.
    </ResponseField>
  </Expandable>

  Empty string in case of an error.
</ResponseField>