Struct ory_client::models::o_auth2_consent_request::OAuth2ConsentRequest

pub struct OAuth2ConsentRequest {

    pub acr: Option<String>,
    pub amr: Option<Vec<String>>,
    pub challenge: String,
    pub client: Option<Box<OAuth2Client>>,
    pub context: Option<Value>,
    pub login_challenge: Option<String>,
    pub login_session_id: Option<String>,
    pub oidc_context: Option<Box<OAuth2ConsentRequestOpenIdConnectContext>>,
    pub request_url: Option<String>,
    pub requested_access_token_audience: Option<Vec<String>>,
    pub requested_scope: Option<Vec<String>>,
    pub skip: Option<bool>,
    pub subject: Option<String>,
}

Fields

acr: Option<String>

ACR represents 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>>

challenge: String

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

client: Option<Box<OAuth2Client>>

context: Option<Value>

login_challenge: Option<String>

LoginChallenge is the login challenge this consent challenge belongs to. It can be used to associate a login and consent request in the login & consent app.

login_session_id: Option<String>

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

oidc_context: Option<Box<OAuth2ConsentRequestOpenIdConnectContext>>

request_url: Option<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: Option<Vec<String>>

requested_scope: Option<Vec<String>>

skip: Option<bool>

Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you must not ask the user to grant the requested scopes. You must however either allow or deny the consent request using the usual API call.

subject: Option<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.

Implementations

impl OAuth2ConsentRequest

pub fn new(challenge: String) -> OAuth2ConsentRequest

Trait Implementations

impl Clone for OAuth2ConsentRequest

fn clone(&self) -> OAuth2ConsentRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OAuth2ConsentRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OAuth2ConsentRequest

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<OAuth2ConsentRequest> for OAuth2ConsentRequest

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

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 OAuth2ConsentRequest