Zeroword Docs

Zeroword#

Zeroword は、Email OTP、Passkey、ソーシャルログインを提供するホスト型のパスワードレス認証基盤である。OIDC、Public Authentication API、SDK、Management API を通じてアプリケーションへ統合する。

主な機能#

  • Hosted Login と Email OTP、Passkey、ソーシャルログイン（Google、Apple、GitHub、Microsoft、汎用 OIDC）
  • Authorization Code + PKCE による OIDC / OAuth 2.0
  • Web BFF、Web SPA、React Native 向け SDK
  • ユーザー、Client、Environment、Webhook を管理する Management API と Dashboard
  • 独自 UI 向けの Public Authentication API
  • 認証イベントを通知する顧客 Webhook

統合方式を選ぶ#

アプリケーション 推奨経路 認証フローと注意点
Web サーバーアプリ Hosted Login + BFF @auth-platform/server で Authorization Code + PKCE を処理し、HttpOnly session cookie を発行する。推奨構成である。
ブラウザー SPA Hosted Login + SPA SDK @auth-platform/browser と必要に応じて @auth-platform/react を使い、Authorization Code + PKCE を実行する。Access token はメモリーに保持する。
React Native Hosted Login + React Native SDK @auth-platform/react-native を使う。Expo SDK 55 以降と New Architecture が前提で、Passkey にはアプリとドメインの association 設定が必要である。
独自のログイン UI Public Authentication API Transaction API を使って Email OTP、Passkey、ソーシャルログインを組み立てる。OIDC の Client 登録と callback は引き続き必要である。
Machine-to-machine 未対応 client_credentials grant と machine client type はない。ユーザーなしの顧客 API 用 bearer token として Management API key を流用してはならない。

Hono と Next.js のサーバー連携には、それぞれ @auth-platform/hono と @auth-platform/next を使う。独自の UI を必要としない場合は Hosted Login を使う。

読む順番#

  1. 概念とテナントモデル で Workspace、Project、Environment、Client の関係を把握する。
  2. Quickstart: Web BFF で Management API に Client を登録し、BFF の基本フローを確認する。
  3. アプリの構成に応じて Server SDK (@auth-platform/server)、Hono SDK (@auth-platform/hono)、Next.js SDK (@auth-platform/next)、Browser SDK (@auth-platform/browser)、React SDK (@auth-platform/react)、React Native SDK (@auth-platform/react-native)、または Public Authentication API を読む。

SDK と CLI#

Package 用途
@auth-platform/server Web BFF の OIDC、callback、session cookie、session 解決
@auth-platform/hono Hono の BFF route mounting、session middleware、Bearer token 検証 middleware
@auth-platform/browser ブラウザー SPA の OIDC / Public Authentication API
@auth-platform/react React Provider、hooks、認証 UI の状態管理
@auth-platform/react-native Expo / React Native の認証、secure storage、native adapter
@auth-platform/next Next.js の route handler、middleware、server helper
@auth-platform/management-client Management API の型付き client、pagination
@auth-platform/cli auth-platform CLI によるプロジェクトと認証リソースの操作

配布#

SDK と CLI は npm の @auth-platform/* scope で配布する。現時点では npm registry に未公開であり、公開後に各 SDK ページのコマンドで導入できる。本書のコード例は公開後の API を示す。

ドキュメント#