/grant/permission/directory

URL: http://<db.host>:<db.port>/grant/permission/directory

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

Input Parameter Description

NameTypeDescription
namestringName of the user or role to which the permission will be granted. Must be an existing user or role.
permissionstring

Permission to grant to the user or role.

Supported ValuesDescription
directory_readFor files in the directory, access to list files, download files, or use files in server side functions
directory_writeAccess to upload files to, or delete files from, the directory. A user or role with write access automatically has read access
directory_namestringName of the KiFS directory to which the permission grants access. An empty directory name grants access to all KiFS directories
optionsmap of string to stringsOptional 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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'grant_permission_directory_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

NameTypeDescription
namestringValue of input parameter name.
permissionstringValue of input parameter permission.
directory_namestringValue of input parameter directory_name.
infomap of string to stringsAdditional information.

Empty string in case of an error.