Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

/alter/user

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

Alters a user.

Input Parameter Description

Name

Type

Description

name

string

Name of the user to be altered. Must be an existing user.

action

string

Modification operation to be applied to the user.

Supported Values	Description
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.
set_default_schema	Set the default_schema for an internal user. An empty string means the user will have no default schema.

value

string

The value of the modification, depending on input parameter action.

options

map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Output Parameter Description

The GPUdb 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:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'alter_user_response' or 'none' in case of an error

data

String

Empty string

data_str

JSON or String

This embedded JSON represents the result of the /alter/user endpoint:

Name	Type	Description
name	string	Value of input parameter name.
info	map of string to strings	Additional information.

Empty string in case of an error.