Skip to main content

Create Integration

Use the tcb integration create command to create a new integration configuration.

tcb integration create [options]

Command Parameters

ParameterDescriptionRequired
--name <name>Integration nameYes
--auth-type <authType>Authentication type, valid values: custom, wechatYes
--description <description>Integration descriptionNo
--jsonOutput results in JSON formatNo
--yesSkip interactive confirmationNo

Usage Examples

Interactive Creation

When no parameters are specified, CLI will guide you to enter the required information:

tcb integration create

Command Line Creation

# Create integration with custom auth type
tcb integration create --name my-integration --auth-type custom --description "My integration"

# Create integration with WeChat auth type
tcb integration create --name wechat-integration --auth-type wechat

# Output results in JSON format
tcb integration create --name my-integration --auth-type custom --json

Automation Script

In CI/CD pipelines, it is recommended to use the --yes parameter to skip interactive confirmation:

tcb integration create --name my-integration --auth-type custom --yes

Output Examples

Standard Output

✓ Integration created successfully

Integration info:
Key ID: key-721a6e232e169382d3cbc5faa3dc2cd6
Name: my-integration
Auth type: custom
Description: My integration

Next step:
Use 'tcb integration bind-resource --key-id key-721a6e232e169382d3cbc5faa3dc2cd6 --function <function-name>' to bind to a cloud function

JSON Output

tcb integration create --name my-integration --auth-type custom --json
{
"KeyId": "key-721a6e232e169382d3cbc5faa3dc2cd6",
"Name": "my-integration",
"AuthTypeCode": "custom",
"Description": "",
"CreateTime": "2024-01-01T00:00:00Z"
}

Notes

  • Integration name must be unique within the same environment
  • Authentication type cannot be modified after creation
  • The Key ID will be returned after successful creation; please save it for subsequent operations