Setting connection credentials
Use the orchestrate connections set-credentials
command to configure credentials for connections in your active environment. These credentials are used to authenticate against the external service associated with the connection.
Each connection type has its own credential requirements, so the arguments you need to pass to the CLI will vary depending on the connection kind.
Basic
The basic
connection kind allows users to pass username
and password
values to connect to a service.
Argument | Description |
---|---|
--app-id (-a ) | App ID of the connection you want to set connections for. |
--environment (--env ) | The environment you want to set the connections for. |
--username (-u ) | The username used to connect to the external service |
--password (-p ) | The password used to connect to the external service |
Bearer token
The bearer
connection kind allows users to pass a token
to connect to a service.
Argument | Description |
---|---|
--app-id (-a ) | App ID of the connection you want to set connections for. |
--environment (--env ) | The environment you want to set the connections for. |
--token | The bearer token used to connect to the external service |
API Key
The api_key
connection kind allows users to pass an api-key
to connect to a service.
Argument | Description |
---|---|
--app-id (-a ) | App ID of the connection you want to set connections for. |
--environment (--env ) | The environment you want to set the connections for. |
--api-key (-k ) | The api key used to connect to the external service |
OAuth On Behalf Of Flow
The oauth_auth_on_behalf_of_flow
connection kind allows users to connect to a service using the ‘On Behalf Of’ auth flow.
Argument | Description |
---|---|
--app-id (-a ) | App ID of the connection you want to set connections for. |
--environment (--env ) | The environment you want to set the connections for. |
--client-id | The client id used to authenticate against the app token server. |
--token-url | The URL of the app token server. |
--grant-type | The grant type of the app token server. |
Setting an identity provider
For OAuth connection types with SSO enabled, you can set the identity provider with the following.
Argument | Description |
---|---|
--app-id (-a ) | App ID of the connection you want to set identity provider for. |
--environment (--env ) | The environment you want to set the identity provider for. |
--url | The URL of the identity provider’s auth service |
--client-id | The client id used to authenticate to the identity provider’s auth service |
--client-secret | The client secret used to authenticate to the identity provider’s auth service |
--scope | The scope of the identity provider’s auth service |
--grant-type | The grant type of the identity provider’s auth service |
Key Value
The key_value
type is a unique type exclusive to Python tools. It allows you to pass in any data in the form of key-value pairs. These pairs are exposed in the Python tool as a dictionary, with the dictionary key mapping to the string on the left of the equals sign and the value mapping to the string on the right of the equals sign.
Argument | Description |
---|---|
--app-id (-a ) | App ID of the connection you want to set connections for. |
--environment (--env ) | The environment you want to set the connections for. |
--entries (-e ) | The key value pair to be added to the dictionary. Specified in the for key=value |
When accessed in the tool, the following will return a dictionary: