Add Tier 1 auth setup docs template and process#330
Open
c1-dev-bot[bot] wants to merge 1 commit into
Open
Conversation
Adds a repeatable template for documenting Tier 1 vendor authentication setup (covering API keys, OAuth, JWT/DWD, IAM roles) and a companion process document defining where docs live, who owns them, and how to keep them current.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
developer/tier1-auth-setup-template.mdx) — a repeatable template for documenting vendor authentication when onboarding Tier 1 connectors. Covers vendor overview, supported API auth modes, recommended setup path, required scopes/permissions, credential setup instructions (both simple API-key and complex OAuth/JWT/DWD), rotation/expiration behavior, known caveats, and validation commands.developer/tier1-auth-setup-process.mdx) — defines where docs live, who updates them (connector engineer, docs team, connector owner, security/compliance), and step-by-step processes for onboarding new connectors and updating existing ones.The template is designed to work for both simple API-key vendors (e.g., Datadog, Linear) and complex OAuth/JWT/domain-wide delegation vendors (e.g., Google Workspace, AWS, Okta).
Fixes: AGNT-577
Test plan
Automated PR Notice
This PR was automatically created by c1-dev-bot as a potential documentation update.
This documentation requires: