Skip to main content
alter_user(name=None, action=None, value=None, options=)[source]

Alters a user.

Parameters

name (str) –

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

action (str) –

Modification operation to be applied to the user. Allowed values are:

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

value (str) –

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

options (dict of str to str) –

Optional parameters. The default value is an empty dict ( ).

Returns

A dict with the following entries–

name (str) –

Value of input parameter name.

info (dict of str to str) –

Additional information.