Creates a new external user (a user whose credentials are managed by an
external LDAP).NOTE: This endpoint should be used for on-premise deployments only.
Input Parameter Description
string
Name of the user to be created. Must exactly match the user’s name in the external LDAP, prefixed with a @. Must not be the same name as an existing user.
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_external_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /create/user/external endpoint:
Show data_str
string
Value of input parameter name.
map of string to strings
Additional information.
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.