Skip to main content

Module wire

Module wire 

Source
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).
AccountInfo πŸ”’
Response from v1/account (decrypted). Only the vault list is used.
AesKeyJson πŸ”’
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.
AuthComplete πŸ”’
Response from v2/auth/complete (decrypted).
AuthMethod πŸ”’
A single auth method offered for an account.
BasicMfa πŸ”’
The { "enabled": bool } shared by every 2FA method entry.
CpaceMsgA πŸ”’
Response from v3/device/enrollments/{uuid}/cpace/msga.
CpaceTagA πŸ”’
Response from v3/device/enrollments/{uuid}/cpace/taga.
CredentialBundle πŸ”’
The credentials the enrolled device hands over, decrypted from the encCreds of v3/device/enrollments/{uuid}/share/credentials.
EncryptedEnvelope πŸ”’
The JSON β€œopdata” envelope as it appears on the wire.
ErrorResponse πŸ”’
A server error body.
FailureReason πŸ”’
A server failure body used by some endpoints instead of Error.
KeyDerivationInfo πŸ”’
An encrypted symmetric key envelope that additionally carries the KDF parameters for the master keyset (alg/p2s/p2c).
KeysetInfo πŸ”’
A single keyset.
KeysetsInfo πŸ”’
The v1/account/keysets payload.
LoginInfo πŸ”’
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 msga response of v3/device/enrollments/{uuid}/cpace/msga.
MsgAAd πŸ”’
The associated data of a CPace message.
NewSession πŸ”’
Response from v3/auth/start.
RsaKeyJwk πŸ”’
An RSA private key JWK as it appears on the wire.
ServerHash πŸ”’
Response from v2/auth/confirm-key.
SharedCredentials πŸ”’
Response from v3/device/enrollments/{uuid}/share/credentials.
SignInTokenDetails πŸ”’
The sign-in token, a bearer credential for the login after the SSO step.
SshKeyAttributes
The SSH key material carried on a sshKey field.
SsoAuth πŸ”’
What the identity provider login earned: a token to sign in with.
SsoEnrollInfo πŸ”’
Response from v3/device/enrollments.
SsoEnrollStatus πŸ”’
Response from v3/device/enrollments/status.
SsoLoginUrl πŸ”’
Response from v3/auth/sso/oidc/start.
SsoSession πŸ”’
Response from v3/auth/sso/oidc/verify.
SsoUser πŸ”’
The user an SSO login authenticated.
SuccessStatus πŸ”’
Response from v1/device, v1/device/{uuid}/reauthorize and the CPace msgb and tagb.
UserAuth πŸ”’
The SRP parameters carried by a successful NewSession.
VaultAccess πŸ”’
An access-control entry carrying the vault key encrypted for a key we may hold.
VaultAttributes πŸ”’
Decrypted vault attributes.
VaultInfo πŸ”’
A vault entry in the account info.
VaultItem πŸ”’
A single encrypted vault item.
VaultItemDetails
Decrypted item details.
VaultItemField
A designation-based login field (username/password).
VaultItemFieldAttributes
Extra attributes on a section field.
VaultItemOverview
A decrypted item overview.
VaultItemSection
A section of fields. Bitwarden custom fields are a flat list, so only the fields are read.
VaultItemSectionField
A field inside a section. The value v can be any JSON type.
VaultItemUrl
A URL entry in an item overview.
VaultItemsBatch πŸ”’
A page of vault items. The last page is marked batchComplete.