Struct open_api_hydra::models::accept_login_request::AcceptLoginRequest

pub struct AcceptLoginRequest {
    pub acr: Option<String>,
    pub context: Option<HashMap<String, Value>>,
    pub force_subject_identifier: Option<String>,
    pub remember: Option<bool>,
    pub remember_for: Option<i64>,
    pub subject: String,
}

Fields

acr: Option<String>

ACR sets the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it to express that, for example, a user authenticated using two factor authentication.

context: Option<HashMap<String, Value>>

Context is an optional object which can hold arbitrary data. The data will be made available when fetching the consent request under the "context" field. This is useful in scenarios where login and consent endpoints share data.

force_subject_identifier: Option<String>

ForceSubjectIdentifier forces the "pairwise" user ID of the end-user that authenticated. The "pairwise" user ID refers to the (Pairwise Identifier Algorithm)[http://openid.net/specs/openid-connect-core-1_0.html#PairwiseAlg] of the OpenID Connect specification. It allows you to set an obfuscated subject ("user") identifier that is unique to the client. Please note that this changes the user ID on endpoint /userinfo and sub claim of the ID Token. It does not change the sub claim in the OAuth 2.0 Introspection. Per default, ORY Hydra handles this value with its own algorithm. In case you want to set this yourself you can use this field. Please note that setting this field has no effect if pairwise is not configured in ORY Hydra or the OAuth 2.0 Client does not expect a pairwise identifier (set via subject_type key in the client's configuration). Please also be aware that ORY Hydra is unable to properly compute this value during authentication. This implies that you have to compute this value on every authentication process (probably depending on the client ID or some other unique value). If you fail to compute the proper value, then authentication processes which have id_token_hint set might fail.

remember: Option<bool>

Remember, if set to true, tells ORY Hydra to remember this user by telling the user agent (browser) to store a cookie with authentication data. If the same user performs another OAuth 2.0 Authorization Request, he/she will not be asked to log in again.

remember_for: Option<i64>

RememberFor sets how long the authentication should be remembered for in seconds. If set to 0, the authorization will be remembered for the duration of the browser session (using a session cookie).

subject: String

Subject is the user ID of the end-user that authenticated.

Implementations

impl AcceptLoginRequest

pub fn new(subject: String) -> AcceptLoginRequest

Trait Implementations

impl Clone for AcceptLoginRequest

pub fn clone(&self) -> AcceptLoginRequest

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AcceptLoginRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AcceptLoginRequest

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<AcceptLoginRequest> for AcceptLoginRequest

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

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

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

This method tests for !=.

impl Serialize for AcceptLoginRequest

pub 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 AcceptLoginRequest