/create/credential

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

Create a new credential.

Input Parameter Description

Name Type Description
credential_name string Name 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.
type string

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
identity string User of the credential to be created.
secret string Password of the credential to be created.
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 'create_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 /create/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.