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.

ArgumentDescription
--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
[BASH]
orchestrate connections set-credentials --app-id <my_app_id> --env [draft|live] --username <username> --password <password>

​
Bearer token

The bearer connection kind allows users to pass a token to connect to a service.

ArgumentDescription
--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.
--tokenThe bearer token used to connect to the external service
[BASH]
orchestrate connections set-credentials --app-id <my_app_id> --env [draft|live] --token <token>

​
API Key

The api_key connection kind allows users to pass an api-key to connect to a service.

ArgumentDescription
--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
[BASH]
orchestrate connections set-credentials --app-id <my_app_id> --env [draft|live] --api-key <api_key>

​
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.

ArgumentDescription
--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-idThe client id used to authenticate against the app token server.
--token-urlThe URL of the app token server.
--grant-typeThe grant type of the app token server.
[BASH]
orchestrate connections set-credentials --app-id <my_app_id> --env [draft|live] --client-id <client_id> --token-url <token_url> --grant-type <grant_type>

​
Setting an identity provider

For OAuth connection types with SSO enabled, you can set the identity provider with the following.

ArgumentDescription
--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.
--urlThe URL of the identity provider’s auth service
--client-idThe client id used to authenticate to the identity provider’s auth service
--client-secretThe client secret used to authenticate to the identity provider’s auth service
--scopeThe scope of the identity provider’s auth service
--grant-typeThe grant type of the identity provider’s auth service
[BASH]
orchestrate set-identity-provider --app-id <my_app_id> --env [draft|live] --url <idp_url> --client-id <idp_client_id> --client_secret <idp_client_secret> --scope <idp_scope> --grant-type <idp_grant_type>

​
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.

ArgumentDescription
--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
[BASH]
orchestrate connections add -a my_key_value
orchestrate connections configure -a my_key_value --env draft --kind key_value --type team
orchestrate connections set-credentials create -a my_key_value --env draft -e key1=value1 -e key2=value2

When accessed in the tool, the following will return a dictionary:

{
    'key1': 'value1',
    'key2': 'value2'
}