Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

/grant/permission/directory

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/grant/permission/directory

Grants a KiFS directory-level permission to a user or role.

Input Parameter Description

Name

Type

Description

name

string

Name of the user or role to which the permission will be granted. Must be an existing user or role.

permission

string

Permission to grant to the user or role.

Supported Values	Description
directory_read	For files in the directory, access to list files, download files, or use files in server side functions
directory_write	Access to upload files to, or delete files from, the directory. A user or role with write access automatically has read access

directory_name

string

Name of the KiFS directory to which the permission grants access. An empty directory name grants access to all KiFS directories

options

map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'grant_permission_directory_response' or 'none' in case of an error

data

String

Empty string

data_str

JSON or String

This embedded JSON represents the result of the /grant/permission/directory endpoint:

Name	Type	Description
name	string	Value of input parameter name.
permission	string	Value of input parameter permission.
directory_name	string	Value of input parameter directory_name.
info	map of string to strings	Additional information.

Empty string in case of an error.