/alter/credential - Kinetica Docs

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

Alter the properties of an existing credential.

Input Parameter Description

string

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

map of string to strings

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

Show credential_updates_map

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

New user for the credential.

New password for the credential.

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.

map of string to strings

Optional parameters.

Output Parameter Description

The Kinetica 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:

String

‘OK’ or ‘ERROR’

String

Empty if success or an error message

String

‘alter_credential_response’ or ‘none’ in case of an error

String

Empty string

JSON or String

This embedded JSON represents the result of the /alter/credential endpoint:

Show data_str

string

Value of input parameter credential_name.

map of string to strings

Additional information.

Empty string in case of an error.

​Input Parameter Description

​Output Parameter Description

Input Parameter Description

Output Parameter Description