Note

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

/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

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
credential_admin	Full read/write and administrative access on the credential.
credential_read	Ability to read and use the credential.

credential_name

string

Name 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.

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_credential_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/credential endpoint:

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

Empty string in case of an error.