Skip to content

update: Kinde Account API doc - #762

Open
tamalchowdhury wants to merge 4 commits into
mainfrom
tamal/new/update-kinde-account-api
Open

update: Kinde Account API doc#762
tamalchowdhury wants to merge 4 commits into
mainfrom
tamal/new/update-kinde-account-api

Conversation

@tamalchowdhury

@tamalchowdhury tamalchowdhury commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

This PR makes an update to the Kinde Account API doc. It adds code examples for how to use the API. It also explains the practical use cases and limitations.

Summary by CodeRabbit

  • Documentation
    • Updated the Account API guide with refreshed metadata, keywords, and an overview of browser-scoped access.
    • Clarified read-only data limitations, access-token acquisition, Bearer authentication, and domain selection.
    • Reorganized the guide with setup instructions and JavaScript and Next.js examples.
    • Added practical use cases, including entitlements, claims offloading, self-serve portal access, and session management.

@tamalchowdhury
tamalchowdhury requested a review from a team as a code owner July 2, 2026 10:07
@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@tamalchowdhury, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 8 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 59b1036e-f6e5-4f70-8cfc-f21e7ae542d3

📥 Commits

Reviewing files that changed from the base of the PR and between 004bdd3 and cd43e54.

📒 Files selected for processing (1)
  • src/content/docs/developer-tools/account-api/about-account-api.mdx

Walkthrough

The Account API documentation page now explains browser-scoped access tokens, token acquisition through SDK or manual OAuth, Bearer-authenticated endpoint calls, domain selection, read-only limits, and common Account API use cases.

Changes

Account API Documentation Update

Layer / File(s) Summary
Metadata and access constraints
src/content/docs/developer-tools/account-api/about-account-api.mdx
Page metadata, keywords, publication date, introduction, and read-only data guidance are updated. The content clarifies browser-scoped user access tokens and Management API boundaries.
Token workflow and Account API use cases
src/content/docs/developer-tools/account-api/about-account-api.mdx
The page adds SDK and manual token-acquisition steps, an entitlements request with Bearer authentication, domain configuration guidance, and use cases for entitlements, JWT claims, portal links, and session management.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Poem

A rabbit updates the guide today,
Tokens find a safer way,
Bearer calls and domains align,
Use cases follow in a tidy line,
Hop, hop — the Account API shines! 🐰📘

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the main change: an update to the Kinde Account API documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch tamal/new/update-kinde-account-api

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@tamalchowdhury tamalchowdhury changed the title Update: Kinde Account API doc update: Kinde Account API doc Jul 2, 2026

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/content/docs/developer-tools/account-api/about-account-api.mdx`:
- Line 50: The “using Kinde without an SDK” link in the account API docs points
to the wrong URL prefix and will 404. Update the markdown link in the relevant
access token step so it uses the same
/developer-tools/about/using-kinde-without-an-sdk/ path already used elsewhere
in this document, and verify the surrounding SDK link text remains unchanged.
- Around line 40-44: The Management API link in the Account API aside points to
the wrong destination, so update the href used in the markdown content to the
Kinde Management API docs path. Locate the link in the Account API documentation
content around the Aside block and change the existing Kinde Management API
reference to /kinde-apis/management/ so the anchor text matches its target.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: af995163-c373-49f3-b3b4-6769446e575b

📥 Commits

Reviewing files that changed from the base of the PR and between a919491 and 8817613.

📒 Files selected for processing (1)
  • src/content/docs/developer-tools/account-api/about-account-api.mdx

Comment thread src/content/docs/developer-tools/account-api/about-account-api.mdx
Comment thread src/content/docs/developer-tools/account-api/about-account-api.mdx Outdated
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 2, 2026

Copy link
Copy Markdown

Deploying kinde-docs-preview with  Cloudflare Pages  Cloudflare Pages

Latest commit: cd43e54
Status: ✅  Deploy successful!
Preview URL: https://1b40939f.kinde-docs-preview.pages.dev
Branch Preview URL: https://tamal-new-update-kinde-accou.kinde-docs-preview.pages.dev

View logs

- account-api
sdk: []
languages: []
- access-tokens

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@tamalchowdhury why is this restricted to just JS languages?

@dtoxvanilla1991 dtoxvanilla1991 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.

Few things to look at. 🔬

Comment thread src/content/docs/developer-tools/account-api/about-account-api.mdx Outdated
Comment thread src/content/docs/developer-tools/account-api/about-account-api.mdx Outdated
Comment thread src/content/docs/developer-tools/account-api/about-account-api.mdx Outdated

@dtoxvanilla1991 dtoxvanilla1991 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.

Second pass, please look at 2 comments below:

Comment thread src/content/docs/developer-tools/account-api/about-account-api.mdx Outdated
Comment thread src/content/docs/developer-tools/account-api/about-account-api.mdx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants