hasRole - Kinetica Docs

◆ hasRole() [1/2]

HasRoleResponse kinetica.Kinetica.hasRole ( HasRoleRequest request_ )

inline

Checks if the specified user has the specified role.

Parameters

request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

Definition at line 43734 of file KineticaFunctions.cs.

HasRoleResponse kinetica.Kinetica.hasRole	(	string	principal,
		string	role,
		IDictionary< string, string >	options = null )

inline

Checks if the specified user has the specified role.

Parameters

principal	Name of the user for which role membership is being checked. Must be an existing user. If blank, will use the current user. The default value is ”.
role	Name of role to check for membership.
options	Optional parameters. NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided role does not exist or is blank. If TRUE then it will return FALSE for has_role. Supported values: TRUE FALSE The default value is FALSE. ONLY_DIRECT: If FALSE will search recursively if the principal is a member of role . If TRUE then principal must directly be a member of role . Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Returns

Response object containing the result of the operation.

Definition at line 43820 of file KineticaFunctions.cs.

async System.Threading.Tasks.Task< HasRoleResponse > kinetica.Kinetica.HasRoleAsync	(	HasRoleRequest	request_,
		System.Threading.CancellationToken	cancellationToken = default )

inline

Checks if the specified user has the specified role.

(async)

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 43750 of file KineticaFunctions.cs.

async System.Threading.Tasks.Task< HasRoleResponse > kinetica.Kinetica.HasRoleAsync	(	string	principal,
		string	role,
		IDictionary< string, string >	options = null,
		System.Threading.CancellationToken	cancellationToken = default )

inline

Checks if the specified user has the specified role.

(async)

Parameters

principal	Name of the user for which role membership is being checked. Must be an existing user. If blank, will use the current user. The default value is ”.
role	Name of role to check for membership.
options	Optional parameters. NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided role does not exist or is blank. If TRUE then it will return FALSE for has_role. Supported values: TRUE FALSE The default value is FALSE. ONLY_DIRECT: If FALSE will search recursively if the principal is a member of role . If TRUE then principal must directly be a member of role . Supported values: TRUE FALSE The default value is FALSE. 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 43892 of file KineticaFunctions.cs.