A set of parameters for Kinetica.createUserExternal. More...

Inheritance diagram for kinetica.CreateUserExternalRequest:

Collaboration diagram for kinetica.CreateUserExternalRequest:

Classes
struct	Options
	A set of string constants for the parameter options. More...

Public Member Functions
	CreateUserExternalRequest ()
	Constructs a CreateUserExternalRequest object with default parameters. More...

	CreateUserExternalRequest (string name, IDictionary< string, string > options=null)
	Constructs a CreateUserExternalRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	name `[get, set]`
	Name of the user to be created. More...

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.createUserExternal.

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

Definition at line 16 of file CreateUserExternal.cs.

Constructor & Destructor Documentation

◆ CreateUserExternalRequest() [1/2]

kinetica.CreateUserExternalRequest.CreateUserExternalRequest ( )

inline

Constructs a CreateUserExternalRequest object with default parameters.

Definition at line 145 of file CreateUserExternal.cs.

◆ CreateUserExternalRequest() [2/2]

kinetica.CreateUserExternalRequest.CreateUserExternalRequest	(	string	name,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a CreateUserExternalRequest object with the specified parameters.

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.

Definition at line 215 of file CreateUserExternal.cs.

Property Documentation

◆ name

string kinetica.CreateUserExternalRequest.name

getset

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.

Definition at line 77 of file CreateUserExternal.cs.

◆ options

IDictionary<string, string> kinetica.CreateUserExternalRequest.options = new Dictionary<string, string>()

getset

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.

Definition at line 141 of file CreateUserExternal.cs.

The documentation for this class was generated from the following file:

Kinetica/Protocol/CreateUserExternal.cs

Classes

Public Member Functions

Properties