whoisgeni-us Authentication API

openapi: 3.2.0
info:
  title: WhoisGenius Authentication API
  description: 'Domain intelligence platform with AI-powered operator attribution Responses are JSON by default; request the compact, token-efficient TOON format with the `Accept: application/toon` header.'
  version: 0.1.0
tags:
- name: Authentication
paths:
  /auth/verify-token:
    post:
      tags:
      - Authentication
      summary: Verify magic link token (server-side)
      description: 'Verify a magic link token server-side via Cognito admin API.


        Rate-limited to 5 attempts per minute per IP to prevent brute-force.'
      operationId: verify_token_auth_verify_token_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyTokenRequest'
        required: true
      responses:
        '200':
          description: Cognito tokens on success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_VerifyTokenResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: Unauthorized — missing or invalid API key/JWT.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: 'null'
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        example: UNAUTHORIZED
                      message:
                        type: string
                  meta:
                    type: 'null'
  /auth/me:
    get:
      tags:
      - Authentication
      summary: Get current user profile
      description: 'Return the currently authenticated user''s profile.


        Requires a valid Cognito JWT Bearer token.'
      operationId: get_me_auth_me_get
      responses:
        '200':
          description: Current authenticated user's profile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_MeResponse_'
        '401':
          description: Unauthorized — missing or invalid API key/JWT.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: 'null'
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        example: UNAUTHORIZED
                      message:
                        type: string
                  meta:
                    type: 'null'
      security:
      - HTTPBearer: []
  /auth/keys:
    get:
      tags:
      - Authentication
      summary: List active API keys
      description: 'List all active API keys for the authenticated user.


        Raw key values are never included in list responses.'
      operationId: list_api_keys_auth_keys_get
      responses:
        '200':
          description: List of API keys (without raw values)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_ApiKeyListResponse_'
        '401':
          description: Unauthorized — missing or invalid API key/JWT.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: 'null'
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        example: UNAUTHORIZED
                      message:
                        type: string
                  meta:
                    type: 'null'
      security:
      - HTTPBearer: []
    post:
      tags:
      - Authentication
      summary: Create a new API key
      description: 'Create a named API key for the authenticated user.


        The raw key value is returned exactly once in this response.

        It is never stored and cannot be retrieved again.

        Enforces key limits: free accounts get ``api_key_limit_free``; legacy

        subscription tiers keep their caps; any user with at least one completed

        credit-pack purchase is boosted to ``api_key_limit_paid``.'
      operationId: create_api_key_auth_keys_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApiKeyRequest'
        required: true
      responses:
        '200':
          description: API key with raw value (shown once)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_ApiKeyResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: Unauthorized — missing or invalid API key/JWT.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: 'null'
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        example: UNAUTHORIZED
                      message:
                        type: string
                  meta:
                    type: 'null'
      security:
      - HTTPBearer: []
  /auth/session-key:
    post:
      tags:
      - Authentication
      summary: Mint a Try It session key
      description: 'Mint (or rotate) the in-app "Try It" playground key for this user.


        The dashboard/landing Try It panel calls this with the logged-in user''s

        Cognito JWT, so the panel never depends on a copy-once raw key stashed in

        the browser. Each call revokes the prior playground key and returns a fresh

        raw value.


        Abuse controls (the playground adds NO new spend budget):

        * Minting is capped per user (``session_key_mint_per_hour``).

        * The key is excluded from the per-tier key cap and hidden from GET /keys.

        * Analyses made with it consume the user''s normal monthly quota and are

        rate-limited per user_id at ``playground_rate_limit_per_hour`` so

        re-minting cannot reset the hourly window (enforced in deps.py).'
      operationId: create_session_key_auth_session_key_post
      responses:
        '200':
          description: Short-lived playground API key (raw value, shown each call)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_ApiKeyResponse_'
        '401':
          description: Unauthorized — missing or invalid API key/JWT.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: 'null'
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        example: UNAUTHORIZED
                      message:
                        type: string
                  meta:
                    type: 'null'
      security:
      - HTTPBearer: []
  /auth/keys/{key_id}:
    delete:
      tags:
      - Authentication
      summary: Revoke an API key
      description: 'Revoke an API key by ID.


        Only the key owner can revoke their own keys. Sets is_active=False

        and records the revocation timestamp.'
      operationId: revoke_api_key_auth_keys__key_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: key_id
        in: path
        required: true
        schema:
          type: string
          title: Key Id
      responses:
        '200':
          description: Revocation confirmation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_dict_str__Any__'
        '404':
          description: API key not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: Unauthorized — missing or invalid API key/JWT.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: 'null'
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        example: UNAUTHORIZED
                      message:
                        type: string
                  meta:
                    type: 'null'
  /auth/email-preferences:
    get:
      tags:
      - Authentication
      summary: Get email preferences
      description: 'Return the current user''s email notification preferences.


        All default to true (opted-in) when the key is absent.'
      operationId: get_email_preferences_auth_email_preferences_get
      responses:
        '200':
          description: Current email notification preferences
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_EmailPreferencesResponse_'
        '401':
          description: Unauthorized — missing or invalid API key/JWT.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: 'null'
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        example: UNAUTHORIZED
                      message:
                        type: string
                  meta:
                    type: 'null'
      security:
      - HTTPBearer: []
    patch:
      tags:
      - Authentication
      summary: Update email preferences
      description: 'Update email notification preferences (merge semantics).


        Only provided fields are updated; omitted fields keep their current

        value. Use ``{"digest_enabled": false}`` to unsubscribe from digests, or

        ``{"lifecycle_enabled": false}`` to opt out of lifecycle campaigns.'
      operationId: update_email_preferences_auth_email_preferences_patch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailPreferencesUpdate'
        required: true
      responses:
        '200':
          description: Updated email notification preferences
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_EmailPreferencesResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: Unauthorized — missing or invalid API key/JWT.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: 'null'
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        example: UNAUTHORIZED
                      message:
                        type: string
                  meta:
                    type: 'null'
      security:
      - HTTPBearer: []
components:
  schemas:
    ErrorDetail:
      properties:
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
        details:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Details
      type: object
      required:
      - code
      - message
      title: ErrorDetail
      description: "Structured error information for API error responses.\n\nAttributes:\n    code: Machine-readable error code (e.g. \"JOB_NOT_FOUND\").\n    message: Human-readable error description.\n    details: Optional additional context for debugging."
      example:
        code: JOB_NOT_FOUND
        message: No job found with the given ID.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    EmailPreferencesUpdate:
      properties:
        digest_enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Digest Enabled
        changelog_enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Changelog Enabled
        lifecycle_enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Lifecycle Enabled
      type: object
      title: EmailPreferencesUpdate
      description: Request body for PATCH /auth/email-preferences.
    ApiResponse_ApiKeyResponse_:
      properties:
        data:
          anyOf:
          - $ref: '#/components/schemas/ApiKeyResponse'
          - type: 'null'
        error:
          anyOf:
          - $ref: '#/components/schemas/ErrorDetail'
          - type: 'null'
        meta:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Meta
      type: object
      title: ApiResponse[ApiKeyResponse]
    ApiKeyListResponse:
      properties:
        keys:
          items:
            $ref: '#/components/schemas/ApiKeyResponse'
          type: array
          title: Keys
      type: object
      required:
      - keys
      title: ApiKeyListResponse
      description: Response body listing all API keys for a user.
    VerifyTokenRequest:
      properties:
        email:
          type: string
          minLength: 1
          title: Email
        token:
          type: string
          minLength: 1
          title: Token
      type: object
      required:
      - email
      - token
      title: VerifyTokenRequest
      description: Request body for server-side magic link verification.
    MeResponse:
      properties:
        user_id:
          type: string
          format: uuid
          title: User Id
        email:
          type: string
          title: Email
        tier:
          type: string
          title: Tier
        cognito_sub:
          type: string
          title: Cognito Sub
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
      - user_id
      - email
      - tier
      - cognito_sub
      - created_at
      title: MeResponse
      description: Response body for GET /auth/me -- current user profile.
    ApiKeyResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        key_prefix:
          type: string
          title: Key Prefix
        created_at:
          type: string
          format: date-time
          title: Created At
        is_active:
          type: boolean
          title: Is Active
        raw_key:
          anyOf:
          - type: string
          - type: 'null'
          title: Raw Key
      type: object
      required:
      - id
      - name
      - key_prefix
      - created_at
      - is_active
      title: ApiKeyResponse
      description: 'Response body for a single API key.


        ``raw_key`` is only populated on creation (shown once, never stored).'
    ApiResponse_ApiKeyListResponse_:
      properties:
        data:
          anyOf:
          - $ref: '#/components/schemas/ApiKeyListResponse'
          - type: 'null'
        error:
          anyOf:
          - $ref: '#/components/schemas/ErrorDetail'
          - type: 'null'
        meta:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Meta
      type: object
      title: ApiResponse[ApiKeyListResponse]
    CreateApiKeyRequest:
      properties:
        name:
          type: string
          maxLength: 100
          minLength: 1
          title: Name
      type: object
      required:
      - name
      title: CreateApiKeyRequest
      description: Request body for creating a new API key.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ApiResponse_VerifyTokenResponse_:
      properties:
        data:
          anyOf:
          - $ref: '#/components/schemas/VerifyTokenResponse'
          - type: 'null'
        error:
          anyOf:
          - $ref: '#/components/schemas/ErrorDetail'
          - type: 'null'
        meta:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Meta
      type: object
      title: ApiResponse[VerifyTokenResponse]
    ApiResponse_EmailPreferencesResponse_:
      properties:
        data:
          anyOf:
          - $ref: '#/components/schemas/EmailPreferencesResponse'
          - type: 'null'
        error:
          anyOf:
          - $ref: '#/components/schemas/ErrorDetail'
          - type: 'null'
        meta:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Meta
      type: object
      title: ApiResponse[EmailPreferencesResponse]
    EmailPreferencesResponse:
      properties:
        digest_enabled:
          type: boolean
          title: Digest Enabled
        changelog_enabled:
          type: boolean
          title: Changelog Enabled
        lifecycle_enabled:
          type: boolean
          title: Lifecycle Enabled
      type: object
      required:
      - digest_enabled
      - changelog_enabled
      - lifecycle_enabled
      title: EmailPreferencesResponse
      description: Response body showing current email preferences.
    ApiResponse_dict_str__Any__:
      properties:
        data:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Data
        error:
          anyOf:
          - $ref: '#/components/schemas/ErrorDetail'
          - type: 'null'
        meta:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Meta
      type: object
      title: ApiResponse[dict[str, Any]]
    ApiResponse_MeResponse_:
      properties:
        data:
          anyOf:
          - $ref: '#/components/schemas/MeResponse'
          - type: 'null'
        error:
          anyOf:
          - $ref: '#/components/schemas/ErrorDetail'
          - type: 'null'
        meta:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Meta
      type: object
      title: ApiResponse[MeResponse]
    VerifyTokenResponse:
      properties:
        id_token:
          type: string
          title: Id Token
        access_token:
          type: string
          title: Access Token
        refresh_token:
          type: string
          title: Refresh Token
      type: object
      required:
      - id_token
      - access_token
      - refresh_token
      title: VerifyTokenResponse
      description: Cognito tokens returned after successful magic link verification.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer