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.
- Auk π
- The account unlock key in the shape of a JWK, of which only the key is read. Deliberately not
Debug. - 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. - Cpace
MsgA π - Response from
v3/device/enrollments/{uuid}/cpace/msga. - Cpace
TagA π - Response from
v3/device/enrollments/{uuid}/cpace/taga. - Credential
Bundle π - The credentials the enrolled device hands over, decrypted from the
encCredsofv3/device/enrollments/{uuid}/share/credentials. - 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.
- MsgA π
- The CPace message from the enrolled device, base64 encoded inside the
msgaresponse ofv3/device/enrollments/{uuid}/cpace/msga. - MsgAAd π
- The associated data of a CPace message.
- 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. - Shared
Credentials π - Response from
v3/device/enrollments/{uuid}/share/credentials. - Sign
InToken πDetails - The sign-in token, a bearer credential for the login after the SSO step.
- SshKey
Attributes - The SSH key material carried on a
sshKeyfield. - SsoAuth π
- What the identity provider login earned: a token to sign in with.
- SsoEnroll
Info π - Response from
v3/device/enrollments. - SsoEnroll
Status π - Response from
v3/device/enrollments/status. - SsoLogin
Url π - Response from
v3/auth/sso/oidc/start. - SsoSession π
- Response from
v3/auth/sso/oidc/verify. - SsoUser π
- The user an SSO login authenticated.
- Success
Status π - Response from
v1/device,v1/device/{uuid}/reauthorizeand the CPacemsgbandtagb. - 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 Overview - A decrypted item overview.
- Vault
Item Section - A section of fields. Bitwarden custom fields are a flat list, so only the fields are read.
- 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.