Skip to content

docs: add plugin integration credentials to rotation guide - #1170

Open
roh26it wants to merge 2 commits into
mainfrom
docs/rotate-credentials-plugins
Open

roh26it wants to merge 2 commits into
mainfrom
docs/rotate-credentials-plugins

Conversation

@roh26it

@roh26it roh26it commented Nov 12, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds section 6, "Plugin integration credentials", to the rotation guide in both support/ and aigw/support/.
  • Covers rotating guardrail and tool plugin credentials (Lasso, Pangea, Aporia, Pillar, Prisma AIRS, F5, Azure, Bedrock, Tavily, Exa) under Settings > Integrations, and updating workspace-level Override Credentials on guardrails.
  • Renumbers later sections and updates the overview table, anchors, and checklist.

For reviewers

  • The per-plugin credential table covers the plugins whose docs state their credential type; other plugins fall under "API-key plugins".
  • Override Credentials are documented for Prisma AIRS and F5 only; other plugins may support them too.

🤖 Generated with Claude Code

Covers guardrail and tool plugin credentials under Settings > Integrations and workspace override credentials. Renumbers later sections.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings November 12, 2026 11:35
@mintlify

mintlify Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
portkey-docs 🟢 Ready View Preview Nov 12, 2026, 11:41 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The guide omits plugin-specific settings locations and the trust-policy update sequence needed to prevent AssumeRole failures during external ID rotation.

2 open issues
What changed in this PR

Adds plugin credential rotation guidance to the Portkey and AI Gateway documentation, extending the existing rotation workflow to third-party guardrail and tool integrations.

Changes:

  • Documents provider credential replacement, workspace overrides, testing, and revocation.
  • Adds a per-plugin credential reference table.
  • Updates section numbering, anchors, overview tables, and checklists in both guides.
File Description
support/​rotate-credentials.mdx Adds plugin credential rotation guidance for Portkey.
aigw/​support/​rotate-credentials.mdx Mirrors the guidance with AI Gateway wording and links.

Review effort: Balanced

Generate a new API key, token, or client secret in the provider's console.
</Step>
<Step title="Update the plugin integration">
Go to **Settings > Integrations**, click the edit button on the plugin integration, and replace the stored credentials.
Comment thread support/rotate-credentials.mdx Outdated
| Prisma AIRS | API key from Strata Cloud Manager |
| F5 Guardrails | API key |
| [Azure Content Safety and PII Detection](/integrations/guardrails/azure-guardrails) | API key, or the Entra client secret. Managed identity setups store no secret. |
| [Bedrock Guardrails](/integrations/guardrails/bedrock-guardrails) | AWS access keys, or the role's external ID for assumed-role setups |
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The rotation guidance omits plugin-specific navigation routes and coordinated IAM trust-policy updates needed to prevent assumed-role access failures during external ID rotation.

2 open issues
2 previously missed issues

In code that hasn't changed since last review

Medium severity Document plugin-specific credential locations

aigw/​support/​rotate-credentials.mdx:188

The single navigation path does not cover all plugins in this section. aigw/integrations/plugins/tavily.mdx:28 and aigw/integrations/plugins/exa.mdx:28 put their keys under Settings > Plugins, while aigw/integrations/guardrails/f5-guardrails.mdx:12 uses Admin Settings > Plugins. Include those routes or link to the plugin-specific setup instructions so readers can locate and rotate those credentials.

Medium severity Document safe external ID rotation in the trust policy

support/​rotate-credentials.mdx:190

For assumed-role setups, changing the external ID only in the integration makes subsequent AssumeRole requests fail because the role's sts:ExternalId condition still expects the old value. Document adding the new ID to the trust policy while retaining the old ID, updating the integration, then removing the old ID after propagation and successful testing. Apply the same change in aigw/support/rotate-credentials.mdx:204.

Review effort: Balanced

This branch was successfully deployed

1 active deployment
staging — 9b832eb2 Deployed Nov 12, 2026 by mintlify[bot]
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.

2 participants