docs: verify identities endpoints

[chronark]

What does this PR do?

Updates the identity endpoints documentation to reflect the changes between v1 and v2 APIs. The documentation now focuses on the specific API changes rather than the conceptual shift from key-based identity patterns to dedicated identity management.

Key improvements:

• Clarifies that both v1 and v2 provide full identity management capabilities
• Documents the consistent API patterns in v2 (all POST methods with request bodies)
• Highlights the structured response format with {meta, data} wrapper in v2
• Shows the enhanced parameter flexibility in v2 (accepting both identityId and externalId)
• Provides detailed request/response comparisons for all identity endpoints

Fixes # (issue)

Type of change

• Bug fix (non-breaking change which fixes an issue)
• Chore (refactoring code, technical debt, workflow improvements)
• Enhancement (small improvements)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How should this be tested?

• Review the updated documentation for accuracy and clarity
• Verify that all endpoint changes between v1 and v2 are correctly documented
• Check that the examples match the actual API behavior

Checklist

Required

• Filled out the "How to test" section in this PR
• Read Contributing Guide
• Self-reviewed my own code
• Commented on my code in hard-to-understand areas
• Ran pnpm build
• Ran pnpm fmt
• Checked for warnings, there are none
• Removed all console.logs
• Merged the latest changes from main onto my branch with git pull origin main
• My changes don't cause any responsiveness issues

Appreciated

• If a UI change was made: Added a screen recording or screenshots to this PR
• Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

• Documentation
  • Updated identity API documentation to provide clear side-by-side comparisons between v1 and v2 endpoints.
  • Revised descriptions to highlight changes in HTTP methods, request/response formats, parameter flexibility, and error handling.
  • Improved code examples and cURL snippets for clarity and consistency.
  • Removed outdated migration-focused content and emphasized explicit identity management with dedicated endpoints.

[changeset-bot]

⚠️ No Changeset found

Latest commit: b490acc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
dashboard	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 4, 2025 0:52am
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 4, 2025 0:52am

[chronark]

• docs: verify identities endpoints #3727 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[coderabbitai]

📝 Walkthrough

Walkthrough

The documentation for the identity-related API endpoints was thoroughly rewritten to provide a direct comparison between v1 and v2 APIs. The new structure highlights changes in HTTP methods, request and response formats, parameter handling, and error management, with updated examples and side-by-side endpoint comparisons replacing the previous migration-focused narrative.

Changes

Cohort / File(s)	Change Summary
Identity API Documentation Overhaul apps/docs/api-reference/v1/migration/identities.mdx	Major rewrite of documentation: shifted from migration guide to direct v1/v2 comparison, restructured sections, updated examples, clarified request/response formats, parameter handling, and endpoint capabilities.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch 08-04-docs_verify_identities_endpoints

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Thank you for following the naming conventions for pull request titles! 🙏

[coderabbitai]

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 27e2638 and b490acc.

📒 Files selected for processing (1)

• apps/docs/api-reference/v1/migration/identities.mdx (3 hunks)

🧰 Additional context used

🪛 LanguageTool

apps/docs/api-reference/v1/migration/identities.mdx

[grammar] ~6-~6: Use correct spacing
Context: ...agement capabilities with different API patterns. ## Overview ### What Changed in v2: - **HT...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~11-~11: There might be a mistake here.
Context: ...ds**: GET endpoints changed to POST for consistency - Request format: Query parameters moved...

(QB_NEW_EN_OTHER)

---

[grammar] ~12-~12: There might be a mistake here.
Context: ...at**: Query parameters moved to request body - Response format: Direct response wrapp...

(QB_NEW_EN_OTHER)

---

[grammar] ~13-~13: There might be a mistake here.
Context: ...se wrapped in structured {meta, data} format - Parameter flexibility: Enhanced parame...

(QB_NEW_EN_OTHER)

---

[grammar] ~14-~14: There might be a mistake here.
Context: ...r handling (accepts both identityId and externalId) - Error handling: Improved error respons...

(QB_NEW_EN_OTHER)

---

[grammar] ~15-~15: There might be a mistake here.
Context: ...ror handling**: Improved error response structure ### Migration Impact: - v1: Mixed GET/PO...

(QB_NEW_EN_OTHER)

---

[grammar] ~20-~20: Use correct spacing
Context: ...tterns, better error tracking, enhanced flexibility --- ## POST /v1/identities.createIdentity → POS...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~24-~24: Use correct spacing
Context: ...ST /v1/identities.createIdentity → POST /v2/identities.createIdentity Purpose: Create a new identity with me...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~26-~26: Use correct spacing
Context: ...e a new identity with metadata and rate limits. Changes: Request format unchanged, res...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~28-~28: Use correct spacing
Context: ...changed, response wrapped in structured format. ```json title="v1 vs v2: Create Identity Request" expandable // v1: POST /v1/identities.createIdentity { "externalId": "user_123", "meta": { "email": "user@example.com", "plan": "pro" }, "ratelimits": [ { "name": "requests", "limit": 1000, "duration": 3600000 } ] } // v2: POST /v2/identities.createIdentit...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~62-~62: Use correct spacing
Context: ...00, "duration": 3600000 } ] } </Tab> <Tab title="Response Comparison" icon="database">json title="v1 vs v2: Create Identity Response" expandable // v1: Direct response { "identityId": "id_abc123def456" } // v2: Structured response with meta wrapper { "meta": { "requestId": "req_createidentity123" }, "data": { "identityId": "id_abc123def456" } } </Tab> <Tab title="cURL Examples" icon="terminal">bash title="Migration Examples" # v1: Create identity curl -X POST https://api.unkey.dev/v1/identities.createIdentity \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{"externalId": "user_123", "meta": {"email": "user@example.com"}, "ratelimits": [{"name": "requests", "limit": 1000, "duration": 3600000}]}' # v2: Create identity (same request, struc...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~96-~96: Use correct spacing
Context: ... "requests", "limit": 1000, "duration": 3600000}]}' </Tab> </Tabs> --- ## GET /v1/identities.getIdentity → POST /v2/identities.getIdentity **Purpose:** Retrieve identity data by ID or external ID. **Key Changes:** GET with query parameters → POST with request body, response format enhanced. <Tabs> <Tab title="Request Migration" icon="user">bash title="v1 vs v2: Get Identity Request" # v1: GET with query parameters curl -X GET "https://api.unkey.dev/v1/identities.getIdentity?externalId=user_123" \ -H "Authorization: Bearer " # Alternative v1: Using identityId curl -X GET "https://api.unkey.dev/v1/identities.getIdentity?identityId=identity_123" \ -H "Authorization: Bearer " # v2: POST with request body (accepts both ID types) curl -X POST https://api.unkey.com/v2/identities.getIdentity \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{"identity": "user_123"}' </Tab> <Tab title="Response Comparison" icon="database">json title="v1 vs v2: Get Identity Response" expandable // v1: Direct response { "id": "id_abc123def456", "externalId": "user_123", "meta": { "email": "user@example.com", "plan": "pro" }, "ratelimits": [ { "name": "requests", "limit": 1000, "duration": 3600000 } ] } // v2: Structured response with meta wra...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~329-~329: Use correct spacing
Context: ... "duration": 3600000 } ] } } </Tab> <Tab title="cURL Examples" icon="terminal">bash title="Migration Examples" # v1: Update identity curl -X POST https://api.unkey.dev/v1/identities.updateIdentity \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{"externalId": "user_123", "meta": {"plan": "enterprise"}, "ratelimits": [{"name": "requests", "limit": 5000, "duration": 3600000}]}' # v2: Update identity (enhanced flexibility) curl -X POST https://api.unkey.com/v2/identities.updateIdentity \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{"identity": "user_123", "meta": {"plan": "enterprise"}, "ratelimits": [{"name": "requests", "limit": 5000, "duration": 3600000}]}' ``` --- ## POST /v1/identities.deleteIdentity → POS...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~352-~352: Use correct spacing
Context: ...ST /v1/identities.deleteIdentity → POST /v2/identities.deleteIdentity Purpose: Permanently delete an identit...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~354-~354: Use correct spacing
Context: ...ity Purpose: Permanently delete an identity. Changes: Enhanced parameter flexibilit...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~356-~356: Use correct spacing
Context: ... (v2 accepts both ID types), structured response. ```json title="v1 vs v2: Delete Identity Request" expandable // v1: Requires identityId specifically { "identityId": "id_abc123def456" } // v2: Flexible identity parameter { "...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~368-~368: Use correct spacing
Context: .../ accepts both identityId or externalId } </Tab> <Tab title="Response Comparison" icon="check-circle">json title="v1 vs v2: Delete Identity Response" expandable // v1: Empty object response {} // v2: Structured response with meta wrapper { "meta": { "requestId": "req_deleteidentity999" } } </Tab> <Tab title="cURL Examples" icon="terminal">bash title="Migration Examples" # v1: Delete identity (requires identityId) curl -X POST https://api.unkey.dev/v1/identities.deleteIdentity \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{"identityId": "id_abc123def456"}' # v2: Delete identity (accepts externalId ...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~397-~397: Use correct spacing
Context: ... application/json" \ -d '{"identity": "user_123"}' ```

(QB_NEW_EN_OTHER_ERROR_IDS_5)

🔇 Additional comments (2)

apps/docs/api-reference/v1/migration/identities.mdx (2)

87-97: Be consistent about the base domain (api.unkey.dev vs api.unkey.com)

The cURL examples mix api.unkey.dev (v1) and api.unkey.com (v2).
Unless the difference is intentional (e.g. staging vs. production), pick a single canonical host or add a note explaining the environment split; otherwise users may think the hostname change is part of the version upgrade.

Also applies to: 112-119, 187-191

---

40-46: Double-check the ratelimits payload key casing

The examples use the lower-case key ratelimits. Prior specs and SDKs exposed rateLimits (camel-case). Please verify the authoritative schema and adjust everywhere to prevent integration mismatches.

Also applies to: 56-62, 264-270, 280-286, 229-236

[graphite-app]

[Flo4604]

@chronark can you force merge (ci) requires go test

[graphite-app]

Graphite Automations

"Post a GIF when PR approved" took an action on this PR • (08/04/25)

1 gif was posted to this PR based on Andreas Thomas's automation.