ory_client/models/
o_auth2_login_request.rs

1/*
2 * Ory APIs
3 *
4 * # Introduction Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.  ## SDKs This document describes the APIs available in the Ory Network. The APIs are available as SDKs for the following languages:  | Language       | Download SDK                                                     | Documentation                                                                        | | -------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | Dart           | [pub.dev](https://pub.dev/packages/ory_client)                   | [README](https://github.com/ory/sdk/blob/master/clients/client/dart/README.md)       | | .NET           | [nuget.org](https://www.nuget.org/packages/Ory.Client/)          | [README](https://github.com/ory/sdk/blob/master/clients/client/dotnet/README.md)     | | Elixir         | [hex.pm](https://hex.pm/packages/ory_client)                     | [README](https://github.com/ory/sdk/blob/master/clients/client/elixir/README.md)     | | Go             | [github.com](https://github.com/ory/client-go)                   | [README](https://github.com/ory/sdk/blob/master/clients/client/go/README.md)         | | Java           | [maven.org](https://search.maven.org/artifact/sh.ory/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/java/README.md)       | | JavaScript     | [npmjs.com](https://www.npmjs.com/package/@ory/client)           | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript/README.md) | | JavaScript (With fetch) | [npmjs.com](https://www.npmjs.com/package/@ory/client-fetch)           | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript-fetch/README.md) |  | PHP            | [packagist.org](https://packagist.org/packages/ory/client)       | [README](https://github.com/ory/sdk/blob/master/clients/client/php/README.md)        | | Python         | [pypi.org](https://pypi.org/project/ory-client/)                 | [README](https://github.com/ory/sdk/blob/master/clients/client/python/README.md)     | | Ruby           | [rubygems.org](https://rubygems.org/gems/ory-client)             | [README](https://github.com/ory/sdk/blob/master/clients/client/ruby/README.md)       | | Rust           | [crates.io](https://crates.io/crates/ory-client)                 | [README](https://github.com/ory/sdk/blob/master/clients/client/rust/README.md)       | 
5 *
6 * The version of the OpenAPI document: v1.22.21
7 * Contact: support@ory.sh
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct OAuth2LoginRequest {
16    /// ID is the identifier of the login request.
17    #[serde(rename = "challenge")]
18    pub challenge: String,
19    #[serde(rename = "client")]
20    pub client: Box<models::OAuth2Client>,
21    #[serde(rename = "oidc_context", skip_serializing_if = "Option::is_none")]
22    pub oidc_context: Option<Box<models::OAuth2ConsentRequestOpenIdConnectContext>>,
23    /// 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.
24    #[serde(rename = "request_url")]
25    pub request_url: String,
26    #[serde(rename = "requested_access_token_audience", skip_serializing_if = "Option::is_none")]
27    pub requested_access_token_audience: Option<Vec<String>>,
28    #[serde(rename = "requested_scope", skip_serializing_if = "Option::is_none")]
29    pub requested_scope: Option<Vec<String>>,
30    /// 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.
31    #[serde(rename = "session_id", skip_serializing_if = "Option::is_none")]
32    pub session_id: Option<String>,
33    /// 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.
34    #[serde(rename = "skip")]
35    pub skip: bool,
36    /// 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.
37    #[serde(rename = "subject")]
38    pub subject: String,
39}
40
41impl OAuth2LoginRequest {
42    pub fn new(challenge: String, client: models::OAuth2Client, request_url: String, skip: bool, subject: String) -> OAuth2LoginRequest {
43        OAuth2LoginRequest {
44            challenge,
45            client: Box::new(client),
46            oidc_context: None,
47            request_url,
48            requested_access_token_audience: None,
49            requested_scope: None,
50            session_id: None,
51            skip,
52            subject,
53        }
54    }
55}
56
ory_client/models/o_auth2_login_request.rs

ory_client/models/
o_auth2_login_request.rs
