docs(auth): expand auth reference — add CLI + full MCP + Console interactive sections#2717
Draft
DaveHanns wants to merge 1 commit into
Draft
docs(auth): expand auth reference — add CLI + full MCP + Console interactive sections#2717DaveHanns wants to merge 1 commit into
DaveHanns wants to merge 1 commit into
Conversation
The API integration page previously only documented REST-header and query-param auth. This adds three sibling subsections under Authentication so readers can find how their credential surface actually works: the CLI (apify login, the ~/.apify/auth.json credentials file, APIFY_TOKEN, and non-interactive apify login --token), the MCP server (hosted streamable-HTTP transport with OAuth or bearer header, local stdio @apify/actors-mcp-server, scope semantics, and a drop-in mcp.json snippet), and Console interactive login (browser session vs API token, plus where to generate, scope, rotate, and revoke tokens). Existing content is unchanged; the additions slot in between the Authentication section and Expiration section. Cross-references to #expiration, #rotation, #organization-accounts, and #api-tokens-with-limited-permissions link readers into the existing token lifecycle content. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Contributor
|
✅ Preview for this PR (commit |
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
2 participants
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
The current API integration page only describes REST-based authentication (HTTP header vs.
tokenquery param). Users who arrive via the CLI, the Apify MCP server, or the Console interactive login have no single reference explaining how their credential surface actually works.This PR adds three subsections under the existing
## Authenticationheading — CLI, MCP, and Console interactive — without touching existing prose.Draft finding: F13 (auth reference gap) from an internal docs sweep. Related upstream conversations: apify-cli #1246 (APIFY_TOKEN interaction with
~/.apify/auth.json).What changes
Single file:
sources/platform/integrations/programming/api.md.curlexample after the existing Authentication paragraph so the HTTP header form is concrete.### Apify CLI—apify loginOAuth flow,~/.apify/auth.jsoncredentials file (macOS/Linux and Windows paths), non-interactiveapify login --token,APIFY_TOKENenv var precedence.### Apify MCP server— hostedmcp.apify.com(streamable HTTP + OAuth or bearer header), local stdio via@apify/actors-mcp-server, drop-inmcp.jsonsnippets for Claude Code / Cursor / VS Code / Codex and for stdio-only clients (Claude Desktop), plus a note that scoped tokens transparently constrain MCP access.### Apify Console (interactive login)— clarifies that browser sign-in yields a Console session cookie, not an API token, and walks through generating / scoping / rotating tokens on the Integrations settings page.The new subsections cross-link to the existing
#expiration,#rotation,#organization-accounts, and#api-tokens-with-limited-permissionssections so lifecycle information isn't duplicated.Test plan
markdownlint --config .markdownlint.json sources/platform/integrations/programming/api.mdpasses (verified locally, exit 0).pnpm startrenders the page and the three new anchors show up in the TOC.