/create/user/internal - Kinetica Docs

URL: http://<db.host>:<db.port>/create/user/internal

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

Input Parameter Description

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.

string

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

map of string to strings

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

Show options

Is the user allowed to login.The default value is true.

true: User may login.
false: User may not login.

When true, a home directory in KiFS is created for this user.The default value is true.The supported values are:

true
false

Default schema to associate with this user.

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.

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

Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

String

‘OK’ or ‘ERROR’

String

Empty if success or an error message

String

‘create_user_internal_response’ or ‘none’ in case of an error

String

Empty string

JSON or String

This embedded JSON represents the result of the /create/user/internal endpoint:

Show data_str

string

Value of input parameter name.

map of string to strings

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

Empty string in case of an error.

​Input Parameter Description

​Output Parameter Description

Input Parameter Description

Output Parameter Description