Struct odoo_api::jsonrpc::types::common::Authenticate

pub struct Authenticate {
    pub db: String,
    pub login: String,
    pub password: String,
    pub user_agent_env: Map<String, Value>,
}

Check the user credentials and return the user ID (web)

Service: common
Method: authenticate
Request: Authenticate
Response: AuthenticateResponse

This method performs a “login” to the Odoo server, and returns the corresponding user ID (uid). It is identical to login, except that it accepts an extra param user_agent_env, which is normally sent by the browser.

This method is inteded for browser-based API implementations. You should use Login or login instead.

Example:

use serde_json::{json, Map, Value};
use odoo_api::types::common;

let request = common::authenticate(
    "my-database",
    "user@example.com",
    "password1",
    json!({
        "base_location": "demo.odoo.com"
    })
);

See: odoo/service/common.py
See also: base/models/res_users.py

Fields

db: String

The database name

login: String

The username (e.g., email)

password: String

The user password

user_agent_env: Map<String, Value>

A mapping of user agent env entries

Trait Implementations

impl Debug for Authenticate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Authenticate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl OdooApiMethod for Authenticate

type Response = AuthenticateResponse

The response type (e.g., the ExecuteResponse for Execute)

fn describe_odoo_api_method(&self) -> (&'static str, &'static str)

Describes the Odoo API method (including the service)

fn parse_json_response(&self, json_data: &str) -> Result<OdooApiResponse<Self>>

Parse some JSON string data into an OdooApiResponse object

impl PartialEq<Authenticate> for Authenticate

fn eq(&self, other: &Authenticate) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Authenticate

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Authenticate