Skip to main content

​
◆ alterUser() [1/2]

AlterUserResponse kinetica.Kinetica.alterUser (AlterUserRequestrequest_)
 inline

Alters a user.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 14718 of file KineticaFunctions.cs.

​
◆ alterUser() [2/2]

AlterUserResponse kinetica.Kinetica.alterUser (stringname,
stringaction,
string_value,
IDictionary< string, string >options = null )
 inline

Alters a user.

Parameters
nameName of the user to be altered. Must be an existing user.
actionModification operation to be applied to the user. Supported values:
  • SET_ACTIVATED: Is the user allowed to login.
  • TRUE: User may login.
  • FALSE: User may not login.
  • SET_COMMENT: Sets the comment for an internal user.
  • SET_DEFAULT_SCHEMA: Set the default_schema for an internal user. An empty string means the user will have no default schema.
  • SET_PASSWORD: Sets the password of the user. The user must be an internal user.
  • SET_RESOURCE_GROUP: Sets the resource group for an internal user. The resource group must exist, otherwise, an empty string assigns the user to the default resource group.
_valueThe value of the modification, depending on action .
optionsOptional parameters. The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 14801 of file KineticaFunctions.cs.

​
◆ AlterUserAsync() [1/2]

async System.Threading.Tasks.Task< AlterUserResponse > kinetica.Kinetica.AlterUserAsync (AlterUserRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Alters a user.

(async)

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 14733 of file KineticaFunctions.cs.

​
◆ AlterUserAsync() [2/2]

async System.Threading.Tasks.Task< AlterUserResponse > kinetica.Kinetica.AlterUserAsync (stringname,
stringaction,
string_value,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Alters a user.

(async)

Parameters
nameName of the user to be altered. Must be an existing user.
actionModification operation to be applied to the user. Supported values:
  • SET_ACTIVATED: Is the user allowed to login.
  • TRUE: User may login.
  • FALSE: User may not login.
  • SET_COMMENT: Sets the comment for an internal user.
  • SET_DEFAULT_SCHEMA: Set the default_schema for an internal user. An empty string means the user will have no default schema.
  • SET_PASSWORD: Sets the password of the user. The user must be an internal user.
  • SET_RESOURCE_GROUP: Sets the resource group for an internal user. The resource group must exist, otherwise, an empty string assigns the user to the default resource group.
_valueThe value of the modification, depending on action .
optionsOptional parameters. The default value is an empty Dictionary.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 14871 of file KineticaFunctions.cs.