Expand description
serde DTOs for every 1Password endpoint.
These carry only the fields the client reads. serde ignores everything else on the wire, so the structs stay small while remaining forward compatible with the full server responses.
Structs§
- AForB 🔒
- Response from
v2/auth(the SRP A -> B exchange). - Account
Info 🔒 - Response from
v1/account(decrypted). Only the vault list is used. - AesKey
Json 🔒 - The decrypted AES key JSON.
- Auth
Complete 🔒 - Response from
v2/auth/complete(decrypted). - Auth
Method 🔒 - A single auth method offered for an account.
- Basic
Mfa 🔒 - The
{ "enabled": bool }shared by every 2FA method entry. - Encrypted
Envelope 🔒 - The JSON “opdata” envelope as it appears on the wire.
- Error
Response 🔒 - A server error body.
- Failure
Reason 🔒 - A server failure body used by some endpoints instead of
Error. - KeyDerivation
Info 🔒 - An encrypted symmetric key envelope that additionally carries the KDF parameters for the master
keyset (
alg/p2s/p2c). - Keyset
Info 🔒 - A single keyset.
- Keysets
Info 🔒 - The
v1/account/keysetspayload. - Login
Info 🔒 - Response from
v2/auth/methods. - MfaInfo 🔒
- The set of 2FA methods enabled for an account.
- NewSession 🔒
- Response from
v3/auth/start. - RsaKey
Jwk 🔒 - An RSA private key JWK as it appears on the wire.
- Server
Hash 🔒 - Response from
v2/auth/confirm-key. - SshKey
Attributes - The SSH key material carried on a
sshKeyfield. - SshKey
Type - An SSH key’s type and, for RSA, its bit length.
- Success
Status 🔒 - Response from
v1/deviceandv1/device/{uuid}/reauthorize. - User
Auth 🔒 - The SRP parameters carried by a successful
NewSession. - Vault
Access 🔒 - An access-control entry carrying the vault key encrypted for a key we may hold.
- Vault
Attributes 🔒 - Decrypted vault attributes.
- Vault
Info 🔒 - A vault entry in the account info.
- Vault
Item 🔒 - A single encrypted vault item.
- Vault
Item Details - Decrypted item details.
- Vault
Item Field - A designation-based login field (username/password).
- Vault
Item Field Attributes - Extra attributes on a section field.
- Vault
Item Input Traits - How the 1Password UI should present a field’s editor.
- Vault
Item Overview - A decrypted item overview.
- Vault
Item Password History - A superseded password and the unix time it was replaced, oldest first.
- Vault
Item Section - A titled section of fields.
- Vault
Item Section Field - A field inside a section. The value
vcan be any JSON type. - Vault
Item Url - A URL entry in an item overview.
- Vault
Items 🔒Batch - A page of vault items. The last page is marked
batchComplete.