You can create and configure connections using YAML specification files. In these YAML specification files configure:
ConfigurationDescription
spec_versionSpecifies the version of the specification.
kindDefines the type of specification. This must be set toconnection.
app_idThe unique identifier for the connection.
environmentsConfiguration for supported environments. You can define settings for draft and live environments. For each environment, configure the following fields:
  • kind: The kind of connection used to access the external service. [basic|bearer|api_key|oauth_auth_on_behalf_of_flow|key_value|kv]
  • type: 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]
  • sso: Does OAuth require an identity provider. Required for OAuth connections kinds.
  • server-url: The URL of the external service. This will be used as the server for OpenAPI tools and exposed for use in Python tools.
  • idp_config and app_config: Define request configurations. Within the header and body sections, you can specify parameters such as content-type, requested_token_use, and requested_token_type .
YAML
spec_version: v1
kind: connection
app_id: my_app
environments:
    draft:
        kind: basic
        type: team
        sso: false
        server_url: https://example.com/
    live:
        kind: oauth_auth_on_behalf_of_flow
        type: member
        sso: true
        server_url: https://example.com/
        idp_config:
          header:
            content-type: application/x-www-form-urlencoded
          body:
            requested_token_use: on_behalf_of
            requested_token_type: urn:ietf:params:oauth:token-type:saml2
        app_config:
          header:
            content-type: application/x-www-form-urlencoded