Struct LoginClient 

pub struct LoginClient {
    pub(crate) client: Client,
}

Client for authenticating Bitwarden users.

Handles unauthenticated operations to obtain access tokens from the Identity API. After successful authentication, use the returned tokens to create an authenticated core client.

Lifecycle

1. Create LoginClient via AuthClient
2. Call login method
3. Use returned tokens with authenticated core client

Password Login Example

// Create auth client
let client = Client::new(None);
let auth_client = AuthClient::new(client);

// Configure client settings and create login client
let settings = ClientSettings {
    identity_url: "https://identity.bitwarden.com".to_string(),
    api_url: "https://api.bitwarden.com".to_string(),
    user_agent: "MyApp/1.0".to_string(),
    device_type: DeviceType::SDK,
    device_identifier: None,
    bitwarden_client_version: None,
    bitwarden_package_type: None,
};
let login_client = auth_client.login(settings);

// Get user's KDF config
let prelogin = login_client.get_password_prelogin(email.clone()).await?;

// Login with credentials
let response = login_client.login_via_password(PasswordLoginRequest {
    login_request: LoginRequest {
        client_id: "connector".to_string(),
        device: LoginDeviceRequest {
            device_type: DeviceType::SDK,
            device_identifier: "device-id".to_string(),
            device_name: "My Device".to_string(),
            device_push_token: None,
        },
    },
    email,
    password,
    prelogin_response: prelogin,
}).await?;

// Use tokens from response for authenticated requests
match response {
    LoginResponse::Authenticated(success) => {
        let access_token = success.access_token;
        // Use access_token for authenticated requests
    }
}

Fields

client: Client

Implementations

impl LoginClient

pub(crate) fn new(settings: ClientSettings) -> Self

Creates a new LoginClient with the given client settings.

Note

This method is pub(crate) because LoginClient instances should be obtained through the AuthClient. Direct instantiation is internal to the crate.

impl LoginClient

pub async fn login_via_password( &self, request: PasswordLoginRequest, ) -> Result<LoginResponse, PasswordLoginError>

Authenticates a user via email and master password.

Derives the master password hash using KDF settings from prelogin, then sends the authentication request to obtain access tokens and vault keys.

impl LoginClient

pub async fn get_password_prelogin( &self, email: String, ) -> Result<PasswordPreloginResponse, PasswordPreloginError>

Retrieves the data required before authenticating with a password. This includes the user’s KDF configuration needed to properly derive the master key.

Trait Implementations

impl From<LoginClient> for JsValue

fn from(value: LoginClient) -> Self

Converts to this type from the input type.

impl FromWasmAbi for LoginClient

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for LoginClient

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for LoginClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<LoginClient>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for LoginClient

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for LoginClient

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for LoginClient

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<LoginClient>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for LoginClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<LoginClient>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for LoginClient

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.

impl VectorFromWasmAbi for LoginClient

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[LoginClient]>

impl VectorIntoWasmAbi for LoginClient

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[LoginClient]>) -> Self::Abi

impl WasmDescribe for LoginClient

fn describe()

impl WasmDescribeVector for LoginClient

fn describe_vector()

impl SupportsConstructor for LoginClient

impl SupportsInstanceProperty for LoginClient

impl SupportsStaticProperty for LoginClient