Struct ory_hydra_client::models::accept_o_auth2_login_request::AcceptOAuth2LoginRequest

pub struct AcceptOAuth2LoginRequest {
    pub acr: Option<String>,
    pub amr: Option<Vec<String>>,
    pub context: Option<Value>,
    pub extend_session_lifespan: Option<bool>,
    pub force_subject_identifier: Option<String>,
    pub identity_provider_session_id: 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.

amr: Option<Vec<String>>

context: Option<Value>

extend_session_lifespan: Option<bool>

Extend OAuth2 authentication session lifespan If set to true, the OAuth2 authentication cookie lifespan is extended. This is for example useful if you want the user to be able to use prompt=none continuously. This value can only be set to true if the user has an authentication, which is the case if the skip value is true.

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.

identity_provider_session_id: Option<String>

IdentityProviderSessionID is the session ID of the end-user that authenticated. If specified, we will use this value to propagate the logout.

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 AcceptOAuth2LoginRequest

pub fn new(subject: String) -> AcceptOAuth2LoginRequest

Trait Implementations

impl Clone for AcceptOAuth2LoginRequest

fn clone(&self) -> AcceptOAuth2LoginRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AcceptOAuth2LoginRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AcceptOAuth2LoginRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AcceptOAuth2LoginRequest

fn eq(&self, other: &AcceptOAuth2LoginRequest) -> 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 AcceptOAuth2LoginRequest

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 AcceptOAuth2LoginRequest