github-starred/better-auth
2
0
Fork 0
mirror of https://github.com/better-auth/better-auth.git synced 2026-05-23 07:18:56 -05:00
Code Issues 2.5k Packages Projects Releases 112 Wiki Activity

[PR #8072] [MERGED] docs: add getUser endpoint documentation for the admin plugin #15973

New Issue
Closed
opened 2026-04-13 10:19:57 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-13 10:19:57 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/better-auth/better-auth/pull/8072
Author: @kebench
Created: 2/19/2026
Status: ✅ Merged
Merged: 2/20/2026
Merged by: @Bekacru

Base: canary ← Head: docs/admin-get-user

📝 Commits (4)

  • cfcd995 docs: add getUser endpoint documentation for the admin plugin
  • f4c6789 docs: fix getUser request parameter name to id
  • ec8936a docs: align getUser return type with User
  • 9d39b62 Merge branch 'canary' into docs/admin-get-user

📊 Changes

1 file changed (+32 additions, -0 deletions)

View changed files

📝 docs/content/docs/plugins/admin.mdx (+32 -0)

📄 Description

Summary

Adds missing documentation for the Admin plugin getUser endpoint (GET /admin/get-user) on the Admin plugin docs page.

What changed

  • Added a new Get User section under Admin plugin docs.
  • Documented the required query parameter (id).
  • Added a Returns section describing the success (data) and failure (error) shapes.

Why

The Admin docs currently cover other admin endpoints but were missing getUser. This PR makes the endpoint discoverable and clarifies expected request/response behavior for developers using the Admin plugin.

Context / background

While integrating the Admin plugin, I noticed getUser is supported by the API/client but not documented on the Admin docs page. This adds the missing reference and aligns the section with existing <APIMethod> documentation patterns.

Breaking changes / deprecations

  • None.

Screenshots (UI changes)

Rendered docs section (Get User + Returns):

image

Related issues / discussions

  • None (please link if there’s an existing issue I missed).

Related

  • Context: #2587 (endpoint implementation; already released)

Summary by cubic

Add missing docs for the Admin plugin getUser endpoint (GET /admin/get-user), documenting the required id query param, requireSession, and a User-aligned success/error response.

Written for commit 9d39b62d0d. Summary will update on new commits.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/better-auth/better-auth/pull/8072 **Author:** [@kebench](https://github.com/kebench) **Created:** 2/19/2026 **Status:** ✅ Merged **Merged:** 2/20/2026 **Merged by:** [@Bekacru](https://github.com/Bekacru) **Base:** `canary` ← **Head:** `docs/admin-get-user` --- ### 📝 Commits (4) - [`cfcd995`](https://github.com/better-auth/better-auth/commit/cfcd9954716d9f9356881d6a06bcf88ac7783981) docs: add getUser endpoint documentation for the admin plugin - [`f4c6789`](https://github.com/better-auth/better-auth/commit/f4c67898d622950b164593c52736086672f65387) docs: fix getUser request parameter name to id - [`ec8936a`](https://github.com/better-auth/better-auth/commit/ec8936aa1f74c271f3acba50126dcf22c04017ad) docs: align getUser return type with User - [`9d39b62`](https://github.com/better-auth/better-auth/commit/9d39b62d0de3a2028710e875642bcfff1af7a95a) Merge branch 'canary' into docs/admin-get-user ### 📊 Changes **1 file changed** (+32 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `docs/content/docs/plugins/admin.mdx` (+32 -0) </details> ### 📄 Description ### Summary Adds missing documentation for the Admin plugin `getUser` endpoint (`GET /admin/get-user`) on the Admin plugin docs page. ### What changed * Added a new **Get User** section under Admin plugin docs. * Documented the required query parameter (`id`). * Added a **Returns** section describing the success (`data`) and failure (`error`) shapes. ### Why The Admin docs currently cover other admin endpoints but were missing `getUser`. This PR makes the endpoint discoverable and clarifies expected request/response behavior for developers using the Admin plugin. ### Context / background While integrating the Admin plugin, I noticed `getUser` is supported by the API/client but not documented on the Admin docs page. This adds the missing reference and aligns the section with existing `<APIMethod>` documentation patterns. ### Breaking changes / deprecations * None. ### Screenshots (UI changes) Rendered docs section (Get User + Returns): <img width="792" height="707" alt="image" src="https://github.com/user-attachments/assets/6e0ccf7d-866a-414d-a6a0-a85c8ba649eb" /> ### Related issues / discussions * None (please link if there’s an existing issue I missed). ### Related - Context: #2587 (endpoint implementation; already released) <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Add missing docs for the Admin plugin getUser endpoint (GET /admin/get-user), documenting the required id query param, requireSession, and a User-aligned success/error response. <sup>Written for commit 9d39b62d0de3a2028710e875642bcfff1af7a95a. Summary will update on new commits.</sup> <!-- End of auto-generated description by cubic. --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-13 10:19:57 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
adapter
astro
awaiting external contributor
blocked
breaking
breaking change
bug
c-devops
core
credentials
database
dependencies
devops
devtools
docs
documentation
duplicate
elysia
enhancement
enterprise
expo
express
fastify
good first issue
help wanted
hono
identity
infra
integration
invalid
javascript
locked
maintenance
need-more-information
needs: info
needs: repro
nextjs
nuxt
oauth
organization
P0
payments
perf
platform
plugin
pull-request
Mirrored from GitHub Pull Request
 question
ready
regression
remix
security
social-provider
solid
stale
svelte
tanstack-start
tracking
version-bump
vue
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/better-auth#15973
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?