specs/models/M_CONN_ENV
Connector Environment
A connector environment is a named configuration for how to connect to a datasource. Connector environments define the information needed to authenticate to the HTTP or SQL data source.
Fields for all connectors environments:
| Field | Description |
|---|---|
| Name | Either production, staging or development |
| Connector Host | A cloud or local computer that actually runs the connector function code. |
| Port | The communication endpoint. More info |
Additional fields for SQL connector environments:
| Field | Description |
|---|---|
| SSL | Whether to use Secure Sockets Layer. see more. Within TLS settings, Mutual TLS can be optionally configured |
| Type | The type of database. Tulip supports: Microsoft SQL Server MySQL PostgreSQL OracleDB |
| Server | The address of the server |
| Database | The name of the database |
| User | The name of the user to authenticate the request |
| Password | The password used to authenticate the request |
Additional fields for HTTP connector environments:
| Field | Description |
|---|---|
| TLS | Whether to use Transport Layer Security. See More |
| Headers | Optional key/value pairs to include in the request header. See More |
| Authentication Type | One of 4 authentication types: No Auth: No authentication specified Basic Auth: Authenticate via username and password OAuth 2 (bearer token): Authenticate via prefix and token OAuth 2 (admin) If a connector function is called, the call will be authenticated with a Tulip user's credentials. The Authorization Code OAuth2.0 flow will be executed. OAuth 2 (operator): If a connector function is called, the call will be authenticated with an operator's credentials that they enter after starting an app in the Tulip Player. The Authorization Code OAuth2.0 flow will be executed. OAuth1.0: If a connector function is called, the call will be authenticated with a Consumer Key, Secret, Access Token obtained from the third party service the connector is authenticating to. Preferred signature being HMAC-SHA256, while more signature methods are available as well. If the environment uses "Basic Auth" or any "Oauth 2" method, the appropriate credentials must also be saved for that environment. |
| Custom Certificate Authority | Optional if using TLS. Supports PEM formatted keys or upload a .pem file |
| Custom Certificate | Required for mTLS. Supports the upload a .pfx file |
| Username | Required if using "Basic Auth" |
| Password | Required if using "Basic Auth" |
| Prefix | Required if using "Oauth 2 (Bearer token)" |
| Token | Required if using "Oauth 2 (Bearer token)" |
| Redirect URL | Required if using "Oauth 2 (Admin)" or "Oauth 2 (Operator) |
| Authorization Code URL | Required if using "Oauth 2 (Admin)" or "Oauth 2 (Operator) |
| Access Token URL | Required if using "Oauth 2 (Admin)" or "Oauth 2 (Operator) |
| Client ID | Required if using "Oauth 2 (Admin)" or "Oauth 2 (Operator) |
| Client Secret | Required if using "Oauth 2 (Admin)" or "Oauth 2 (Operator) |
| Signature Method | Required if using "OAuth1.0". It is a hashing algorithm used to generate the signature for the request |
| Consumer Key | Required if using "OAuth1.0". Value used by the consumer or client to identify itself to the service provider |
| Consumer Secret | Required if using "OAuth1.0". A secret used by the consumer or client to establish ownership of the consumer key |
| Access Token | Required if using "OAuth1.0". A token used for accessing the protected resource from the service provider |
| Token Secret | Required if using "OAuth1.0". A secret used by the consumer to establish ownership of the access token |
| Realm | Required if using "OAuth1.0". This is a string specified by the server in the WWW-Authenticate response header |
| Scope | Required if using "Oauth 2 (Admin)" or "Oauth 2 (Operator) |
| Send token request data as JSON | A boolean value that determines whether request data will be sent as query params or in the request body |
| Send Authentication Header for refresh request | A boolean value that determines behavior of refresh requests. A true value will send Authentication Header on refresh. |
| Custom Prompt Header | An optional string value that determines behavior of refresh requests. This header can be disabled, or set to none, login, consent or select_account |
Tests
| ID | Name |
|---|---|
| QA-T580 | Dev Mode Settings - Dev Mode Configuration |
| QA-T581 | Connectors : 02 - Environment Configuration |
| QA-T793 | Connectors : 03 - Filtering and searching connectors |
| QA-T794 | Connectors : 04 - "Where Used" app links |
| QA-T795 | Connectors : 05 - "Where Used" app links on different workspaces |
| QA-T796 | Connectors : 06 - Connector functions search and "Where Used" app links |
| QA-T802 | Connectors versioning : 01 - Connectors in published apps |
Requirements
No requirements