oc · docs
documentation

@orangecheck/auth-client


@orangecheck/auth-client / OcSignInProps

Type Alias: OcSignInProps

type OcSignInProps = OcSignInBaseProps & 
  | {
  mode?: "family";
  providerHref?: undefined;
}
  | {
  mode: "first-party";
  onSuccess: (account: OcAccount, token?: string) => void;
  providerHref?: (providerId: string) => string;
};

Defined in: signin.tsx:173

Where the ceremony's session goes.

family (default): a *.ochk.io site. The auth host sets the shared .ochk.io cookie and the component navigates.

first-party: orangecheck's own site on another domain (ochk.app). Every call to the auth host omits credentials, so the family cookie is neither sent nor set; the host answers with a token bound to audience, handed to onSuccess for the site to turn into its own cookie. No add-account or link prompts (there is no family session to add to), and provider buttons appear only when providerHref says where the site starts each one.