@orangecheck/auth-client / RedirectToSudoArgs
Interface: RedirectToSudoArgs
Defined in: sudo.tsx:24
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
<a id="property-config"></a> config? | OcAuthConfig | Optional auth-client config override · same shape as <OcSessionProvider config={…} />. Defaults to authOrigin: 'https://ochk.io'. | sudo.tsx:38 |
<a id="property-purpose"></a> purpose? | string | Free-form tag echoed in the /sudo page UI — e.g. "register a hardware key". The user sees "To <purpose>, confirm with the one-time code…" so the prompt is framed by the action that triggered it. Not security-relevant. | sudo.tsx:34 |
<a id="property-returnto"></a> returnTo? | string | Where to send the browser after the user finishes the sudo ceremony. Defaults to window.location.href at call-time. Must be a family origin (*.ochk.io) or a relative path; the /sudo page coerces unsafe values to /dashboard. | sudo.tsx:29 |