createUserExternal - Kinetica Docs

◆ createUserExternal() [1/2]

CreateUserExternalResponse kinetica.Kinetica.createUserExternal ( CreateUserExternalRequest request_ )

inline

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

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

Parameters

request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

Definition at line 30742 of file KineticaFunctions.cs.

◆ createUserExternal() [2/2]

CreateUserExternalResponse kinetica.Kinetica.createUserExternal	(	string	name,
		IDictionary< string, string >	options = null )

inline

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

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

Parameters

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.

options

Optional parameters.

ACTIVATED: Is the user allowed to login. Supported values:
- TRUE: User may login.
- FALSE: User may not login.
The default value is TRUE.
CREATE_HOME_DIRECTORY: When TRUE, a home directory in KiFS is created for this user. Supported values:
- TRUE
- FALSE
The default value is TRUE.
DEFAULT_SCHEMA: Default schema to associate with this user.
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.
RESOURCE_GROUP: Name of an existing resource group to associate with this user.

The default value is an empty Dictionary.

Returns

Response object containing the result of the operation.

Definition at line 30856 of file KineticaFunctions.cs.

◆ CreateUserExternalAsync() [1/2]

async System.Threading.Tasks.Task< CreateUserExternalResponse > kinetica.Kinetica.CreateUserExternalAsync	(	CreateUserExternalRequest	request_,
		System.Threading.CancellationToken	cancellationToken = default )

inline

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

(async)

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

Parameters

request_	Request object containing the parameters for the operation.
cancellationToken	Cancellation token to cancel the operation.

Returns

Task that returns the response object containing the result of the operation.

Definition at line 30760 of file KineticaFunctions.cs.

◆ CreateUserExternalAsync() [2/2]

async System.Threading.Tasks.Task< CreateUserExternalResponse > kinetica.Kinetica.CreateUserExternalAsync	(	string	name,
		IDictionary< string, string >	options = null,
		System.Threading.CancellationToken	cancellationToken = default )

inline

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

(async)

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

Parameters

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.
options	Optional parameters. ACTIVATED: Is the user allowed to login. Supported values: TRUE: User may login. FALSE: User may not login. The default value is TRUE. CREATE_HOME_DIRECTORY: When TRUE, a home directory in KiFS is created for this user. Supported values: TRUE FALSE The default value is TRUE. DEFAULT_SCHEMA: Default schema to associate with this user. 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. RESOURCE_GROUP: Name of an existing resource group to associate with this user. The default value is an empty Dictionary.
cancellationToken	Cancellation token to cancel the operation.

Returns

Task that returns the response object containing the result of the operation.

Definition at line 30952 of file KineticaFunctions.cs.

​◆ createUserExternal() [1/2]

​◆ createUserExternal() [2/2]

​◆ CreateUserExternalAsync() [1/2]

​◆ CreateUserExternalAsync() [2/2]

◆ createUserExternal() [1/2]

◆ createUserExternal() [2/2]

◆ CreateUserExternalAsync() [1/2]

◆ CreateUserExternalAsync() [2/2]