Note

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

/alter/credential

URL: http://<db.host>:<db.port>/alter/credential

Alter the properties of an existing credential.

Input Parameter Description

Name

Type

Description

credential_name

string

Name of the credential to be altered. Must be an existing credential.

credential_updates_map

map of string to strings

Map containing the properties of the credential to be updated. Error if empty.

Supported Parameters (keys)	Parameter Description
type	New type for the credential. The supported values are: aws_access_key aws_iam_role azure_ad azure_oauth azure_sas azure_storage_key docker gcs_service_account_id gcs_service_account_keys hdfs kafka
identity	New user for the credential
secret	New password for the credential
schema_name	Updates the schema name. If schema_name doesn't exist, an error will be thrown. If schema_name is empty, then the user's default schema will be used.

options

map of string to strings

Optional parameters.

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

'alter_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 /alter/credential endpoint:

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

Empty string in case of an error.