Struct 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)

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 instead.

Example

use odoo_api::jmap;

// note that auth fields (db, login, password) are auto-filled
// for you by the client
let resp = client.common_authenticate(
    jmap!{
        "base_location": "https://demo.odoo.com"
    }
).send()?;

println!("UID: {}", resp.uid);

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 JsonRpcParams for Authenticate

type Container<T> = OdooApiContainer<Authenticate>

type Response = AuthenticateResponse

fn build(self, id: JsonRpcId) -> JsonRpcRequest<Self>

impl OdooApiMethod for Authenticate

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

Describe the JSON-RPC service and method for this type

fn endpoint(&self) -> &'static str

Describe method endpoint (e.g., “/web/session/authenticate”)

fn _build(self, id: JsonRpcId) -> JsonRpcRequest<Self>

Build self into a full JsonRpcRequest

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.