/create/credential

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

Create a new credential.

Input Parameter Description

NameTypeDescription
credential_namestringName of the credential to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match an existing credential name.
typestring

Type of the credential to be created. 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
  • jdbc
  • kafka
  • confluent
identitystringUser of the credential to be created.
secretstringPassword of the credential to be created.
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'create_credential_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

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

Empty string in case of an error.