Importing connections
Import connections into your active environment either by using a connection configuration file or by creating and configuring them directly through the ADK CLI.
Importing Connection using a Connection file
The orchestrate connections import command allows you to import connections into the watsonx Orchestrate platform using a YAML file.
| Argument | Description |
|---|---|
--file (-f) | A path the the yaml connection spec definition |
Importing Connection direct in the CLI
If you don’t have a preconfigured YAML file for your connection, you can create and import it directly using the CLI.
The first step is to assign an App ID to the connection. You can do this with the following command, where <my_app_id> is a unique identifier for your connection:
| Argument | Description |
|---|---|
--app-id (-a) | A unique identifier used to refrence the connection |
This command only imports the connection into your active environment. To configure the connection settings, use the orchestrate connections configure command. For more information, see Configuring the imported connection.
Configuring the imported connection
After you have imported a connection you can configure the draft and live environments. If you are working against the local instance then only draft is supported.
| Argument | Description |
|---|---|
--app-id (-a) | The app id of the connection you want to configure |
--environment (--env) | The environment you want to configure the connection for. Valid options: [live|draft] |
--kind (-k) | The kind of connection used to access the external service. `[basic|bearer|api_key|oauth_auth_on_behalf_of_flow|key_value|kv] |
--type (-t) | The type of credentials. --type team will mean the credentials apply to all users, --type member will mean each user will have to provide their own credentials. [member|team] |
--server-url (--url) | The URL of the external service. This will be used as the server for OpenAPI tools and exposed for use in Python tools. |
--sso | Does OAuth require an identity provider. Required for OAuth connections kinds. |
--idp-token-use | The token use value for the identity provider request. Required for OAuth connections kinds. |
--idp-token-type | The token type value for the identity provider request. Required for OAuth connections kinds. |
--idp-token-header | The headers used in the identity provider request. |
--idp-token-type | The headers used in the app token server request. |