You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit c0303d1
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: auth/credentials.mdx
+20-4Lines changed: 20 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -167,7 +167,7 @@ _ = login
167
167
168
168
### 2FA with TOTP
169
169
170
-
For sites with authenticator app 2FA, include `totp_secret` so Kernel can generate a fresh code during automatic login and reauthentication:
170
+
For sites with authenticator app 2FA, include `totp_secret` so KERNEL can generate a fresh code during automatic login and reauthentication. Supply a base32 secret of 16–128 characters or an `otpauth://totp/` provisioning URI. The default is SHA1, 6 digits, and a 30-second period. If the authenticator uses different settings, provide `totp_algorithm` (`SHA1`, `SHA256`, or `SHA512`), `totp_digits` (6–9), and `totp_period` (15–300 seconds):
The examples use typed fields available in TypeScript, Python, and Go SDK v0.116.0 or later. You can also pass an `otpauth://totp/` provisioning URI as `totp_secret`.
226
+
227
+
- URI parameters override explicit settings. If a parameter is missing, the API uses its explicit field, then the default.
228
+
- Replacing a URI resets omitted settings to defaults. Rotating a raw secret preserves stored settings unless you send new values.
229
+
- The API stores only the normalized seed, never the URI label or issuer.
230
+
- A code's length follows `totp_digits`; don't assume six digits when reading `totp_code` or calling `totpCode()`.
231
+
216
232
### SSO / OAuth
217
233
218
234
For sites with "Sign in with Google/GitHub/Microsoft", set `sso_provider` so Kernel can select the matching SSO route. Automatic completion depends on the provider's login requirements.
Copy file name to clipboardExpand all lines: integrations/1password.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -142,7 +142,7 @@ If multiple items match a domain, the first match is used. Organize your vaults
142
142
143
143
## TOTP Support
144
144
145
-
If your 1Password item has a one-time password (TOTP) field configured, Kernel can generate fresh codes for automatic login and reauthentication. No additional setup is needed.
145
+
If your 1Password item has a one-time password (TOTP) field configured, KERNEL uses its `otpauth://` secret, algorithm (SHA1, SHA256, or SHA512), digit count (6–9), and period (15–300 seconds) to generate fresh codes for automatic login and reauthentication. Missing settings default to SHA1, 6 digits, and 30 seconds. An unsupported setting makes the field unavailable instead of generating an incorrect fallback code.
|`--output json`, `-o json`| Output raw JSON object. |
148
151
@@ -170,7 +173,10 @@ Update a credential.
170
173
|------|-------------|
171
174
|`--name <name>`| New name for the credential. |
172
175
|`--value <name=value>`| Field name/value pair to update (repeatable). |
173
-
|`--totp-secret <secret>`| Base32-encoded TOTP secret (set to an empty string to remove). |
176
+
|`--totp-secret <secret>`| Replacement base32 secret (16–128 characters) or `otpauth://` URI. Raw secret rotation retains stored settings when flags are omitted; a URI uses its own settings or defaults. |
177
+
|`--totp-algorithm <name>`|`SHA1`, `SHA256`, or `SHA512`; requires `--totp-secret`. |
Copy file name to clipboardExpand all lines: vaults/credentials.mdx
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -103,6 +103,8 @@ set `provider: "kernel"` so KERNEL stores the values and hosts collection. the a
103
103
104
104
password and totp fields must be sensitive. usernames and email addresses can also remain sensitive; `fill` works either way. fields marked `sensitive: false` return their stored values in item responses.
105
105
106
+
Vault `totp` fields currently generate SHA1, six-digit codes every 30 seconds. Configurable TOTP settings on stored managed-auth credentials do **not** apply to vault items. For a non-default algorithm, digit count, or period, don't use a vault `totp` field for fill until that API supports those settings.
107
+
106
108
`fields` is an ordered array. define fields in the same top-to-bottom order as the website; collection forms preserve it exactly. `name` remains authoritative for `state.fields`, updates, and `fill`. `label` only changes display text and is returned as non-secret metadata. labels must be nonempty, trimmed, single-line display text of at most 128 utf-8 bytes.
107
109
108
110
an item accepts 1–32 named fields. field names must start with an ascii letter, contain only ascii letters, numbers, and underscores, and be at most 64 characters. `email` values must be bare valid addresses such as `user@example.com`; use `text` for usernames that aren't valid email addresses. initial values must be nonempty strings and fit within 16 kib of utf-8 data each; `null` and empty strings aren't accepted on creation.
0 commit comments