Struct ory_client::models::o_auth2_login_request::OAuth2LoginRequest

pub struct OAuth2LoginRequest {
    pub challenge: String,
    pub client: Box<OAuth2Client>,
    pub oidc_context: Option<Box<OAuth2ConsentRequestOpenIdConnectContext>>,
    pub request_url: String,
    pub requested_access_token_audience: Vec<String>,
    pub requested_scope: Vec<String>,
    pub session_id: Option<String>,
    pub skip: bool,
    pub subject: String,
}

Fields

challenge: String

ID is the identifier ("login challenge") of the login request. It is used to identify the session.

client: Box<OAuth2Client>

oidc_context: Option<Box<OAuth2ConsentRequestOpenIdConnectContext>>

request_url: String

RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.

requested_access_token_audience: Vec<String>

requested_scope: Vec<String>

session_id: Option<String>

SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the "sid" parameter in the ID Token and in OIDC Front-/Back- channel logout. It’s value can generally be used to associate consecutive login requests by a certain user.

skip: bool

Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL. This feature allows you to update / set session information.

subject: String

Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client. If this value is set and skip is true, you MUST include this subject type when accepting the login request, or the request will fail.

Implementations

impl OAuth2LoginRequest

pub fn new(
    challenge: String,
    client: OAuth2Client,
    request_url: String,
    requested_access_token_audience: Vec<String>,
    requested_scope: Vec<String>,
    skip: bool,
    subject: String
) -> OAuth2LoginRequest

Trait Implementations

impl Clone for OAuth2LoginRequest

fn clone(&self) -> OAuth2LoginRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OAuth2LoginRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OAuth2LoginRequest

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<OAuth2LoginRequest> for OAuth2LoginRequest

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

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 OAuth2LoginRequest