Struct LoginApiRequest 

pub(crate) struct LoginApiRequest<T: Serialize + DeserializeOwned + Debug> {
    pub client_id: String,
    pub grant_type: GrantType,
    pub scope: String,
    pub device_type: DeviceType,
    pub device_identifier: String,
    pub device_name: String,
    pub device_push_token: Option<String>,
    pub two_factor_token: Option<String>,
    pub two_factor_provider: Option<TwoFactorProvider>,
    pub two_factor_remember: Option<bool>,
    pub login_mechanism_fields: T,
}

The common payload properties to send to the /connect/token endpoint to obtain tokens for a BW user.

Fields

client_id: String

The client ID for the SDK consuming client. Note: snake_case is intentional to match the API expectations.

grant_type: GrantType

The grant type for the token request. Note: snake_case is intentional to match the API expectations.

scope: String

The space-separated scopes for the token request (e.g., “api offline_access”).

device_type: DeviceType

The device type making the request.

device_identifier: String

The identifier of the device.

device_name: String

The name of the device.

device_push_token: Option<String>

The push notification registration token for mobile devices.

two_factor_token: Option<String>

The two-factor authentication token.

two_factor_provider: Option<TwoFactorProvider>

The two-factor authentication provider.

two_factor_remember: Option<bool>

Whether to remember two-factor authentication on this device.

login_mechanism_fields: T

Implementations

impl<T: Serialize + DeserializeOwned + Debug> LoginApiRequest<T>

pub(crate) fn new( client_id: String, grant_type: GrantType, device_type: DeviceType, device_identifier: String, device_name: String, device_push_token: Option<String>, login_mechanism_fields: T, ) -> Self

Creates a new UserLoginApiRequest with standard scopes (“api offline_access”). The scope can be overridden after construction if needed for specific auth flows.

Trait Implementations

impl<T: Debug + Serialize + DeserializeOwned + Debug> Debug for LoginApiRequest<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for LoginApiRequest<T>

where T: Serialize + DeserializeOwned + Debug,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<(PasswordLoginRequest, MasterPasswordAuthenticationData)> for LoginApiRequest<PasswordLoginApiRequest>

Converts a PasswordLoginRequest and MasterPasswordAuthenticationData into a PasswordLoginApiRequest for making the API call.

fn from( (request, master_password_authentication): (PasswordLoginRequest, MasterPasswordAuthenticationData), ) -> Self

Converts to this type from the input type.

impl<T> Serialize for LoginApiRequest<T>

where T: Serialize + DeserializeOwned + Debug,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.