Alter User

Alters a user.

Input Parameter Description

NameTypeDescription
namestringName of the user to be altered. Must be an existing user.
actionstring

Modification operation to be applied to the user.

Supported ValuesDescription
set_commentSets the comment for an internal user.
set_passwordSets the password of the user. The user must be an internal user.
set_resource_groupSets 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_schemaSet the default_schema for an internal user. An empty string means the user will have no default schema.
valuestringThe value of the modification, depending on input parameter action.
optionsmap of string to stringsOptional parameters. The default value is an empty map ( {} ).

Output Parameter Description

NameTypeDescription
namestringValue of input parameter name.
infomap of string to stringsAdditional information.