feat: api v2 identities.createIdentity

[Flo4604]

What does this PR do?

Fixes #2952

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?

Tests

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

• New Features

  • Introduced a new API endpoint for creating identities that accepts external IDs, metadata, and rate-limits.
  • Enhanced error handling to return clear conflict responses (HTTP 409) when duplicate identities are submitted.
  • Integrated audit logging for key identity and rate limit operations.
  • Expanded request metrics to capture additional client details such as user agent and IP address.

• Tests

  • Added comprehensive automated tests for identity creation and rate limit operations, covering success, validation errors, unauthorized access, and permission enforcement.

[changeset-bot]

⚠️ No Changeset found

Latest commit: c3196cd

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.

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)
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 9, 2025 1:41pm

[vercel]

@Flo4604 is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

[github-actions]

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

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request implements the new V2 identity creation endpoint and its supporting infrastructure in the Go API. It introduces a new route and handler for /v2/identities.createIdentity, along with additional OpenAPI schema definitions and types. Comprehensive test suites have been added covering successful creation, validation errors, unauthorized access, forbidden permissions, and duplicate identity scenarios. The changes also integrate audit logging across several routes, update SQL query generation and type mappings, and enhance middleware and session functions with additional metadata.

Changes

File(s)	Change Summary
go/.gitignore	Added new unkey entry to ignore specific files/directories.
go/apps/api/openapi/{gen.go, openapi.json}	Added new constant, types (e.g., ConflictError, V2IdentitiesCreateIdentityRequestBody/ResponseBody, V2Ratelimit), and a POST endpoint /v2/identities.createIdentity in the OpenAPI spec.
go/apps/api/routes/{register.go, services.go}	Registered new /v2/identities.createIdentity route and updated Services struct to include an Auditlogs field.
go/apps/api/routes/v2_identities_create_identity/*	Introduced new handler for identity creation with DB transaction and audit logs; added comprehensive tests for 200, 400, 401, 403, and 409 scenarios.
go/apps/api/routes/v2_ratelimit_{delete_override, get_override, set_override}/*	Integrated Auditlogs into handlers and improved workspace ID retrieval for permission checks.
go/apps/api/run.go	Integrated the audit logging service into the run flow.
go/cmd/api/main.go	Minor formatting change (removed a blank line).
go/internal/services/auditlogs/*, go/pkg/auditlog/*	Introduced audit log insertion functions, new service implementation, and added required types and interfaces.
go/pkg/db/*, go/pkg/db/queries/*	Added new SQL queries (e.g., for audit log buckets, identity, identity ratelimit, key operations), updated generated files with sqlc v1.28.0, and changed JSON type mappings (from json.RawMessage to []byte).
go/pkg/testutil/{http.go, seed/seed.go}	Enhanced test harness with an Auditlogs field and added a DifferentWorkspace resource for permission testing.
go/pkg/zen/{middleware_errors.go, middleware_metrics.go, session.go}	Added conflict error handling (HTTP 409), captured UserAgent and IPAddress in metrics, and provided new session methods to retrieve client metadata.
go/pkg/db/sqlc.json	Added an "overrides" configuration mapping database “json” type to Go’s []byte.
go/pkg/fault/tag.go	Added a new CONFLICT constant for error tagging.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant A as API Handler
    participant K as Keys Service
    participant P as Permissions Service
    participant DB as Database
    participant AL as Audit Log Service

    C->>A: HTTP POST /v2/identities.createIdentity
    A->>K: VerifyRootKey
    K-->>A: Key Validated / Error
    A->>P: Check Permissions
    P-->>A: Authorized / Unauthorized
    A->>DB: Begin Transaction & Insert Identity
    alt Duplicate Identity
        DB-->>A: Conflict Error
        A-->>C: 409 Conflict Response (via CONFLICT fault)
    else Successful Creation
        A->>AL: Insert Audit Log Entry
        DB-->>A: Commit Transaction
        A-->>C: 200 Success (with IdentityId)
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Implement /v2/identities.createIdentity endpoint with parameters (externalId, meta, ratelimits) (#2952)	✅
Create comprehensive tests covering successful creation, validation errors, and security scenarios (#2952)	✅

Suggested Reviewers

• mcstepp
• chronark
• ogzhanolguncu
• perkinsjr

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @coderabbitai modularize this function.
• 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 generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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