/alter/credential

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/alter/credential

Alter the properties of an existing credential.

Input Parameter Description

NameTypeDescription
credential_namestringName of the credential to be altered. Must be an existing credential.
credential_updates_mapmap 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
identityNew user for the credential
secretNew password for the credential
schema_nameUpdates 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.
optionsmap of string to stringsOptional 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:

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

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

NameTypeDescription
credential_namestringValue of input parameter credential_name.
infomap of string to stringsAdditional information.

Empty string in case of an error.