Skip to content

Document the 2FA Challenge/Session Endpoints #128

Description

@maugauwi-hash

Labels: documentation, api-contract
Priority: Medium
Estimated Time: 30 minutes

Description:
Both APIClient.challenge2FA/clear2FASession (iOS, APIClient.swift:120-126) and
ApiClient.challenge2FA (Android, ApiClient.kt:80-81) are implemented against
/vaults/{id}/2fa/challenge and /vaults/{id}/2fa/session/clear, but neither endpoint appears
anywhere in shared/api-contract.md's 2FA-adjacent sections (which currently only covers status/
enable/verify/disable implicitly via the client code, not even fully documented there either).

Tasks:

  • Add the full 2FA endpoint set to shared/api-contract.md, including challenge and session/clear
  • Document why these two methods currently have no UI call sites on either platform (dead code — see also a potential follow-up issue if they're confirmed unused and should be removed)
  • Add request/response model documentation matching TwoFactorStatus/Enable2FAResponse

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions