This section contains general reference information on the credential types that are supported for use in connections from the |
NOTE: Some credential types may not be available in your product edition. |
This credential type requires generation of an API key within the target application. This key must be inserted as part of the connection definition in the .
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["apiKey"] |
This credential type requires an API key generated by the target application, as well as an access token tied to the API key.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["apiKeyWithToken"] |
Connect to Azure-hosted resources using the Azure Single Sign On (SSO) token for the authenticating user.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["azureTokenSso"] |
AWS-specific credentials. Used for Redshift connections.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["aws"] |
These AWS-specific credentials use a key/secret combination to authenticate to AWS systems, such as Amazon Dynamo DB and Amazon Athena.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["awsKeySecret"] |
A simple username/password can be provided to the authenticating application.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["basic"] |
The basic app credential type requires that a private app be created in the target application. Access through this app needs an AppId and Password combination.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["basicApp"] |
This basic authentication mechanism requires three pieces of information: Username , Password and Application Token . All of these are available in through the target application.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["basicWithAppToken"] |
For this credential type, the connection credentials are stored in , a JSON configuration file stored on the node hosting the product.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["conf"] |
Used for REST API connections, these credentials are submitted as key/value pairs in the HTTP request.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["httpHeaderBasedAuth"] |
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["httpQueryBasedAuth"] |
This credential type leverages an IAM role to access Amazon Redshift databases. The IAM role must be specified as part of the connection definition.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["iamDbUser"] |
This credential type uses an IAM role to access external S3 buckets, which are not defined as part of the base storage layer.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["iamRoleArn"] |
Connection uses the Kerberos-delegated principal to connect to a relational database. No credentials are submitted as part of the connection definition. This method requires additional configuration.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["kerberosDelegate"] |
Connection uses the Kerberos impersonation principal for the user to connect to the database. No credentials are submitted as part of the connection definition.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["kerberosImpersonation"] |
When accessing an external S3 bucket, you can apply key-secret combinations as part of your connection definition. This authentication mechanism consists of an AWS Access Key ID and an AWS Access Secret ID.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["keySecret"] |
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["noAuth"] |
OAuth 2.0 credentials can be used to connect a client in the to the client app created in the target system.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["oauth2"] |
NOTE: Additional configuration may be required to enable this credential type for a specific connection type. |
A single password value is required for authentication.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["password"] |
This credential type requires the insertion of a single security token as part of the connection definition. This security token must be generated from the targeted application.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["securityToken"] |
Used for SFTP connections, this credential type requires that you insert an SSH key generated from the host server of the FTP site.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["sshKey"] |
For SSH tunneling connectivity, you can use a simple username and password set of credentials. This credential type can be applied to various connection types.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["sshTunnelingBasic"] |
For SSH tunneling connectivity, you can use a username and SSH key as a set of credentials. This credential type can be applied to various connection types.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["sshTunnelingSshKey"] |
This credential type uses a Login ID and Transaction Key to authenticate.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["transactionKey"] |
This credential type requires a user identifier and an API token associated with that user to authenticate to the server.
:
When creating a connection via API, the following attribute and value must be inserted as part of the connection definition:
"credentialType": ["userWithApiToken"] |
|
In the request and response for actual connections, the attribute credentialTypes is used as a String value:
{
"id": 37,
"host": "postgres.example.com",
"port": 5432,
"vendor": "postgres",
"params": {
"connectStrOpts": "",
"database": "mydb"
},
"ssl": false,
"vendorName": "postgres",
"name": "Postgres20200417182437287",
"description": "",
"type": "jdbc",
"isGlobal": false,
"credentialType": "basic",
"credentialsShared": false,
"uuid": "myUniqueId",
"disableTypeInference": false,
"createdAt": "2020-04-17T18:25:04.518Z",
"updatedAt": "2020-04-17T18:25:04.530Z",
...
} |