Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

/create/user/external

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

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

Name

Type

Description

name

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.

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

The GPUdb 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:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'create_user_external_response' or 'none' in case of an error

data

String

Empty string

data_str

JSON or String

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

Name	Type	Description
name	string	Value of input parameter name.
info	map of string to strings	Additional information.

Empty string in case of an error.