Enum Command

pub enum Command {
    PasswordLogin(PasswordLoginRequest),
    ApiKeyLogin(ApiKeyLoginRequest),
    LoginAccessToken(AccessTokenLoginRequest),
    GetUserApiKey(SecretVerificationRequest),
    Fingerprint(FingerprintRequest),
    Sync(SyncRequest),
    Secrets(SecretsCommand),
    Projects(ProjectsCommand),
    Generators(GeneratorsCommand),
}

Variants

PasswordLogin(PasswordLoginRequest)

Login with username and password

This command is for initiating an authentication handshake with Bitwarden. Authorization may fail due to requiring 2fa or captcha challenge completion despite accurate credentials.

This command is not capable of handling authentication requiring 2fa or captcha.

Returns: PasswordLoginResponse

ApiKeyLogin(ApiKeyLoginRequest)

Login with API Key

This command is for initiating an authentication handshake with Bitwarden.

Returns: ApiKeyLoginResponse

LoginAccessToken(AccessTokenLoginRequest)

Login with Secrets Manager Access Token

This command is for initiating an authentication handshake with Bitwarden.

Returns: ApiKeyLoginResponse

GetUserApiKey(SecretVerificationRequest)

Requires Authentication Get the API key of the currently authenticated user

Returns: UserApiKeyResponse

Fingerprint(FingerprintRequest)

Get the user’s passphrase

Returns: String

Sync(SyncRequest)

Requires Authentication Retrieve all user data, ciphers and organizations the user is a part of

Returns: SyncResponse

Secrets(SecretsCommand)

Projects(ProjectsCommand)

Generators(GeneratorsCommand)

Trait Implementations

impl Debug for Command

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Command

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Command

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for Command

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.