Skip to main content
create_user_internal(name=None, password=None, options=)[source]

Creates a new internal user (a user whose credentials are managed by the database system).

Parameters

name (str) –

Name of the user to be created. Must contain only lowercase letters, digits, and underscores, and cannot begin with a digit. Must not be the same name as an existing user or role.

password (str) –

Initial password of the user to be created. May be an empty string for no password.

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • activated – Is the user allowed to login. Allowed values are:

    • true – User may login.

    • false – User may not login.

    The default value is ‘true’.

  • create_home_directory – When true, a home directory in KiFS is created for this user. Allowed values are:

    • true

    • false

    The default value is ‘true’.

  • default_schema – Default schema to associate with this user.

  • directory_data_limit – The maximum capacity to apply to the created directory if create_home_directory is true. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.

  • resource_group – Name of an existing resource group to associate with this user.

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. The default value is an empty dict ( ).