Note

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

/show/credential

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

Shows information about a specified credential or all credentials.

Input Parameter Description

NameTypeDescription
credential_namestringName of the credential on which to retrieve information. The name must refer to a currently existing credential. If '*' is specified, information about all credentials will be returned.
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'show_credential_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

NameTypeDescription
credential_namesarray of stringsA list of all credential names.
credential_typesarray of stringsA list of each credential's type.
credential_identitiesarray of stringsA list of each credential's identity.
credentialsarray of stringsA list of each credential's create_credential_request JSON encoded structure.
additional_infoarray of maps of string to stringsAdditional information about the respective credential in output parameter credential_names.
infomap of string to stringsAdditional information.

Empty string in case of an error.