Skip to content

docs(integration): document masked secrets in integration responses - #1066

Merged
ysyneu merged 1 commit into
feat/integration-secrets-maskedfrom
fix/integration-secrets-masked
Oct 16, 2026
Merged

ysyneu merged 1 commit into
feat/integration-secrets-maskedfrom
fix/integration-secrets-masked

Conversation

@ysyneu

@ysyneu ysyneu commented Oct 16, 2026

Copy link
Copy Markdown
Contributor

What

Integration API responses no longer carry secret values:

  • /integration/list, /integration/info and /integration/update return each saved secret in settings (passwords, app secrets, tokens, encryption keys, webhook endpoints, HTTP pull URL and body, headers, custom bodies) as ******; unset values stay empty. integration_key is unchanged.
  • /integration/update: keeping a stored secret while changing where it is sent (endpoint, url, database host/port, IM API base URL) is rejected, and ****** on a field with no stored value is rejected.
  • DingTalk guide (zh/en): the event subscription aes_key and token are shown once when generated (scan-create dialog, or the form before saving); after saving they can only be generated again from the edit page, and the group bot message callback token must be updated with them.

Updated in both the per-module and combined specs (on-call.openapi.*, openapi.*) and the API catalog.

Release

Merge when the matching integration service and console changes are live.

Integration list, detail and update responses return each saved secret
in settings as ******. Updates keep a stored secret only while its
destination is unchanged. The DingTalk event subscription aes_key and
token are shown once when generated and can be generated again from the
edit page.
@ysyneu
ysyneu merged commit cd4d828 into feat/integration-secrets-masked Oct 16, 2026
2 checks passed
@ysyneu
ysyneu deleted the fix/integration-secrets-masked branch October 16, 2026 20:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant