Create Internal User

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

Input Parameter Description

Name Type Description
name string 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 string Initial password of the user to be created. May be an empty string for no password.
options map of string to strings

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

Supported Parameters (keys) Parameter Description
resource_group Name of an existing resource group to associate with this user
default_schema Default schema to associate with this user
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
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.

Output Parameter Description

Name Type Description
name string Value of input parameter name.
info map of string to strings Additional information. The default value is an empty map ( {} ).Possible keys are: