/grant/permission/credential

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

Grants a credential-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
credential_adminFull read/write and administrative access on the credential.
credential_readAbility to read and use the credential.
credential_namestringName of the credential on which the permission will be granted. Must be an existing credential, or an empty string to grant access on all credentials.
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_credential_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

NameTypeDescription
namestringValue of input parameter name.
permissionstringValue of input parameter permission.
credential_namestringValue of input parameter credential_name.
infomap of string to stringsAdditional information.

Empty string in case of an error.