@orangecheck/auth-client / OcAuthConfig
Interface: OcAuthConfig
Defined in: src/types.ts:44
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
<a id="property-authorigin"></a> authOrigin? | string | Origin of the auth host — the subdomain that runs the sign-in UI, issues session cookies, and exposes /api/auth/me + /api/auth/logout. Defaults to https://ochk.io. Override in preview/dev. | src/types.ts:51 |
<a id="property-logoutpath"></a> logoutPath? | string | Path on the auth host to hit to clear the session cookie. Defaults to /api/auth/logout. Called with credentials: 'include' so the .ochk.io cookie is sent along. | src/types.ts:75 |
<a id="property-mepath"></a> mePath? | string | Local path (same origin as the current app) that exposes the crypto-verified session. If your app ships one at /api/auth/me, leave as default. Returns 200 { account } or 401. | src/types.ts:69 |
<a id="property-signinpath"></a> signInPath? | string | Path on the auth host that accepts ?return_to=<url> and drives the sign-in flow. The page offers two paths in-place: - email + OTP (default — federation-custodied wallet provisioned for the user; identity is did:email:<sha256(email)>) - BIP-322 wallet sign (paste address → in-page wallet sign; identity is the Bitcoin address itself) Defaults to /signin. | src/types.ts:63 |