Repository navigation
Add OAuth for apps guide for the REST API - #1712
Open
erikengervall wants to merge 2 commits into
Open
erikengervall wants to merge 2 commits into
erikengervall wants to merge 2 commits into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
capy-ai
Bot
changed the title
Only a refresh token revokes the whole connection; an access token sent to /revoke ends that access token alone. A refresh token used twice revokes the connection outright, including the tokens the first refresh returned. Both match the grant RPCs that back REST connections. Co-Authored-By: Claude <noreply@anthropic.com>
This branch was successfully deployed
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.
Adds an English guide, "OAuth for apps", under API Reference. It covers how a third-party app lets a user sign in with Firecrawl and call the REST API on that user's account without the user pasting an API key.
The page covers discovery metadata, client registration (Dynamic Client Registration or a Client ID Metadata Document), the authorize request with PKCE, code exchange, calling the API with an
fco_bearer token, refresh token rotation, revocation, and the error codes from both the authorization server and the REST API. It states thatfirecrawl:globalis full access to the chosen team, and points users to Settings to see and revoke connections.Localized pages are left to the translation pipeline.
Merge after firecrawl/firecrawl#5154 and https://github.com/firecrawl/firecrawl-web/pull/4135 are deployed, because the page describes revoking REST connections in Settings.