createUserExternal - Kinetica Docs

◆ createUserExternal() [1/4]

CreateUserExternalResponse gpudb::GPUdb::createUserExternal ( const CreateUserExternalRequest & request_ ) const

Creates a new external user (a user whose credentials are managed by an external LDAP).

Attention

This method should be used for on-premise deployments only.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

CreateUserExternalResponse & gpudb::GPUdb::createUserExternal	(	const CreateUserExternalRequest &	request_,
		CreateUserExternalResponse &	response_ ) const

Creates a new external user (a user whose credentials are managed by an external LDAP).

Attention

This method should be used for on-premise deployments only.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).

CreateUserExternalResponse gpudb::GPUdb::createUserExternal	(	const std::string &	name,
		const std::map< std::string, std::string > &	options ) const

Creates a new external user (a user whose credentials are managed by an external LDAP).

Attention

This method should be used for on-premise deployments only.

Parameters

[in]	name	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.
[in]	options	Optional parameters. create_user_external_activated: Is the user allowed to login. Supported values: create_user_external_true: User may login. create_user_external_false: User may not login. The default value is create_user_external_true. create_user_external_create_home_directory: When true, a home directory in KiFS is created for this user. Supported values: create_user_external_true create_user_external_false The default value is create_user_external_true. create_user_external_default_schema: Default schema to associate with this user. create_user_external_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. create_user_external_resource_group: Name of an existing resource group to associate with this user. The default value is an empty map.

Returns

Response object containing the result of the operation.

CreateUserExternalResponse & gpudb::GPUdb::createUserExternal	(	const std::string &	name,
		const std::map< std::string, std::string > &	options,
		CreateUserExternalResponse &	response_ ) const

Creates a new external user (a user whose credentials are managed by an external LDAP).

Attention

This method should be used for on-premise deployments only.

Parameters

[in]	name	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.
[in]	options	Optional parameters. create_user_external_activated: Is the user allowed to login. Supported values: create_user_external_true: User may login. create_user_external_false: User may not login. The default value is create_user_external_true. create_user_external_create_home_directory: When true, a home directory in KiFS is created for this user. Supported values: create_user_external_true create_user_external_false The default value is create_user_external_true. create_user_external_default_schema: Default schema to associate with this user. create_user_external_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. create_user_external_resource_group: Name of an existing resource group to associate with this user. The default value is an empty map.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).