Create Internal User

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

Input Parameter Description

NameTypeDescription
namestringName 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.
passwordstringInitial password of the user to be created. May be an empty string for no password.
optionsmap of string to strings

Optional parameters.

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

Supported Parameters (keys)Parameter Description
activated

Is the user allowed to login.

The default value is true.

Supported ValuesDescription
trueUser may login.
falseUser may not login.
create_home_directory

When true, a home directory in KiFS is created for this user.

The default value is true.

The supported values are:

  • true
  • false
default_schemaDefault schema to associate with this user.
directory_data_limitThe 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_groupName of an existing resource group to associate with this user.

Output Parameter Description

NameTypeDescription
namestringValue of input parameter name.
infomap of string to strings

Additional information.

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