ory_client/models/o_auth2_client.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.2
7 * Contact: support@ory.sh
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// OAuth2Client : OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct OAuth2Client {
17 /// OAuth 2.0 Access Token Strategy AccessTokenStrategy is the strategy used to generate access tokens. Valid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/oauth2-oidc/jwt-access-token Setting the strategy here overrides the global setting in `strategies.access_token`.
18 #[serde(rename = "access_token_strategy", skip_serializing_if = "Option::is_none")]
19 pub access_token_strategy: Option<String>,
20 #[serde(rename = "allowed_cors_origins", skip_serializing_if = "Option::is_none")]
21 pub allowed_cors_origins: Option<Vec<String>>,
22 #[serde(rename = "audience", skip_serializing_if = "Option::is_none")]
23 pub audience: Option<Vec<String>>,
24 #[serde(rename = "authorization_code_grant_access_token_lifespan", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
25 pub authorization_code_grant_access_token_lifespan: Option<Option<String>>,
26 #[serde(rename = "authorization_code_grant_id_token_lifespan", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
27 pub authorization_code_grant_id_token_lifespan: Option<Option<String>>,
28 #[serde(rename = "authorization_code_grant_refresh_token_lifespan", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
29 pub authorization_code_grant_refresh_token_lifespan: Option<Option<String>>,
30 /// OpenID Connect Back-Channel Logout Session Required Boolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout Token to identify the RP session with the OP when the backchannel_logout_uri is used. If omitted, the default value is false.
31 #[serde(rename = "backchannel_logout_session_required", skip_serializing_if = "Option::is_none")]
32 pub backchannel_logout_session_required: Option<bool>,
33 /// OpenID Connect Back-Channel Logout URI RP URL that will cause the RP to log itself out when sent a Logout Token by the OP.
34 #[serde(rename = "backchannel_logout_uri", skip_serializing_if = "Option::is_none")]
35 pub backchannel_logout_uri: Option<String>,
36 #[serde(rename = "client_credentials_grant_access_token_lifespan", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
37 pub client_credentials_grant_access_token_lifespan: Option<Option<String>>,
38 /// OAuth 2.0 Client ID The ID is immutable. If no ID is provided, a UUID4 will be generated.
39 #[serde(rename = "client_id", skip_serializing_if = "Option::is_none")]
40 pub client_id: Option<String>,
41 /// OAuth 2.0 Client Name The human-readable name of the client to be presented to the end-user during authorization.
42 #[serde(rename = "client_name", skip_serializing_if = "Option::is_none")]
43 pub client_name: Option<String>,
44 /// OAuth 2.0 Client Secret The secret will be included in the create request as cleartext, and then never again. The secret is kept in hashed format and is not recoverable once lost.
45 #[serde(rename = "client_secret", skip_serializing_if = "Option::is_none")]
46 pub client_secret: Option<String>,
47 /// OAuth 2.0 Client Secret Expires At The field is currently not supported and its value is always 0.
48 #[serde(rename = "client_secret_expires_at", skip_serializing_if = "Option::is_none")]
49 pub client_secret_expires_at: Option<i64>,
50 /// OAuth 2.0 Client URI ClientURI is a URL string of a web page providing information about the client. If present, the server SHOULD display this URL to the end-user in a clickable fashion.
51 #[serde(rename = "client_uri", skip_serializing_if = "Option::is_none")]
52 pub client_uri: Option<String>,
53 #[serde(rename = "contacts", skip_serializing_if = "Option::is_none")]
54 pub contacts: Option<Vec<String>>,
55 /// OAuth 2.0 Client Creation Date CreatedAt returns the timestamp of the client's creation.
56 #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")]
57 pub created_at: Option<String>,
58 #[serde(rename = "device_authorization_grant_access_token_lifespan", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
59 pub device_authorization_grant_access_token_lifespan: Option<Option<String>>,
60 #[serde(rename = "device_authorization_grant_id_token_lifespan", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
61 pub device_authorization_grant_id_token_lifespan: Option<Option<String>>,
62 #[serde(rename = "device_authorization_grant_refresh_token_lifespan", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
63 pub device_authorization_grant_refresh_token_lifespan: Option<Option<String>>,
64 /// OpenID Connect Front-Channel Logout Session Required Boolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be included to identify the RP session with the OP when the frontchannel_logout_uri is used. If omitted, the default value is false.
65 #[serde(rename = "frontchannel_logout_session_required", skip_serializing_if = "Option::is_none")]
66 pub frontchannel_logout_session_required: Option<bool>,
67 /// OpenID Connect Front-Channel Logout URI RP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query parameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the request and to determine which of the potentially multiple sessions is to be logged out; if either is included, both MUST be.
68 #[serde(rename = "frontchannel_logout_uri", skip_serializing_if = "Option::is_none")]
69 pub frontchannel_logout_uri: Option<String>,
70 #[serde(rename = "grant_types", skip_serializing_if = "Option::is_none")]
71 pub grant_types: Option<Vec<String>>,
72 #[serde(rename = "implicit_grant_access_token_lifespan", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
73 pub implicit_grant_access_token_lifespan: Option<Option<String>>,
74 #[serde(rename = "implicit_grant_id_token_lifespan", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
75 pub implicit_grant_id_token_lifespan: Option<Option<String>>,
76 #[serde(rename = "jwks", skip_serializing_if = "Option::is_none")]
77 pub jwks: Option<Box<models::JsonWebKeySet>>,
78 /// OAuth 2.0 Client JSON Web Key Set URL URL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains the signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the Client's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.
79 #[serde(rename = "jwks_uri", skip_serializing_if = "Option::is_none")]
80 pub jwks_uri: Option<String>,
81 #[serde(rename = "jwt_bearer_grant_access_token_lifespan", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
82 pub jwt_bearer_grant_access_token_lifespan: Option<Option<String>>,
83 /// OAuth 2.0 Client Logo URI A URL string referencing the client's logo.
84 #[serde(rename = "logo_uri", skip_serializing_if = "Option::is_none")]
85 pub logo_uri: Option<String>,
86 #[serde(rename = "metadata", skip_serializing_if = "Option::is_none")]
87 pub metadata: Option<serde_json::Value>,
88 /// OAuth 2.0 Client Owner Owner is a string identifying the owner of the OAuth 2.0 Client.
89 #[serde(rename = "owner", skip_serializing_if = "Option::is_none")]
90 pub owner: Option<String>,
91 /// OAuth 2.0 Client Policy URI PolicyURI is a URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data.
92 #[serde(rename = "policy_uri", skip_serializing_if = "Option::is_none")]
93 pub policy_uri: Option<String>,
94 #[serde(rename = "post_logout_redirect_uris", skip_serializing_if = "Option::is_none")]
95 pub post_logout_redirect_uris: Option<Vec<String>>,
96 #[serde(rename = "redirect_uris", skip_serializing_if = "Option::is_none")]
97 pub redirect_uris: Option<Vec<String>>,
98 #[serde(rename = "refresh_token_grant_access_token_lifespan", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
99 pub refresh_token_grant_access_token_lifespan: Option<Option<String>>,
100 #[serde(rename = "refresh_token_grant_id_token_lifespan", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
101 pub refresh_token_grant_id_token_lifespan: Option<Option<String>>,
102 #[serde(rename = "refresh_token_grant_refresh_token_lifespan", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
103 pub refresh_token_grant_refresh_token_lifespan: Option<Option<String>>,
104 /// OpenID Connect Dynamic Client Registration Access Token RegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client using Dynamic Client Registration.
105 #[serde(rename = "registration_access_token", skip_serializing_if = "Option::is_none")]
106 pub registration_access_token: Option<String>,
107 /// OpenID Connect Dynamic Client Registration URL RegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.
108 #[serde(rename = "registration_client_uri", skip_serializing_if = "Option::is_none")]
109 pub registration_client_uri: Option<String>,
110 /// OpenID Connect Request Object Signing Algorithm JWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects from this Client MUST be rejected, if not signed with this algorithm.
111 #[serde(rename = "request_object_signing_alg", skip_serializing_if = "Option::is_none")]
112 pub request_object_signing_alg: Option<String>,
113 #[serde(rename = "request_uris", skip_serializing_if = "Option::is_none")]
114 pub request_uris: Option<Vec<String>>,
115 #[serde(rename = "response_types", skip_serializing_if = "Option::is_none")]
116 pub response_types: Option<Vec<String>>,
117 /// OAuth 2.0 Client Scope Scope is a string containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens.
118 #[serde(rename = "scope", skip_serializing_if = "Option::is_none")]
119 pub scope: Option<String>,
120 /// OpenID Connect Sector Identifier URI URL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of redirect_uri values.
121 #[serde(rename = "sector_identifier_uri", skip_serializing_if = "Option::is_none")]
122 pub sector_identifier_uri: Option<String>,
123 /// SkipConsent skips the consent screen for this client. This field can only be set from the admin API.
124 #[serde(rename = "skip_consent", skip_serializing_if = "Option::is_none")]
125 pub skip_consent: Option<bool>,
126 /// SkipLogoutConsent skips the logout consent screen for this client. This field can only be set from the admin API.
127 #[serde(rename = "skip_logout_consent", skip_serializing_if = "Option::is_none")]
128 pub skip_logout_consent: Option<bool>,
129 /// OpenID Connect Subject Type The `subject_types_supported` Discovery parameter contains a list of the supported subject_type values for this server. Valid types include `pairwise` and `public`.
130 #[serde(rename = "subject_type", skip_serializing_if = "Option::is_none")]
131 pub subject_type: Option<String>,
132 /// OAuth 2.0 Token Endpoint Authentication Method Requested Client Authentication method for the Token Endpoint. The options are: `client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header. `client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body. `private_key_jwt`: Use JSON Web Tokens to authenticate the client. `none`: Used for public clients (native apps, mobile apps) which can not have secrets.
133 #[serde(rename = "token_endpoint_auth_method", skip_serializing_if = "Option::is_none")]
134 pub token_endpoint_auth_method: Option<String>,
135 /// OAuth 2.0 Token Endpoint Signing Algorithm Requested Client Authentication signing algorithm for the Token Endpoint.
136 #[serde(rename = "token_endpoint_auth_signing_alg", skip_serializing_if = "Option::is_none")]
137 pub token_endpoint_auth_signing_alg: Option<String>,
138 /// OAuth 2.0 Client Terms of Service URI A URL string pointing to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client.
139 #[serde(rename = "tos_uri", skip_serializing_if = "Option::is_none")]
140 pub tos_uri: Option<String>,
141 /// OAuth 2.0 Client Last Update Date UpdatedAt returns the timestamp of the last update.
142 #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")]
143 pub updated_at: Option<String>,
144 /// OpenID Connect Request Userinfo Signed Response Algorithm JWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT [JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims as a UTF-8 encoded JSON object using the application/json content-type.
145 #[serde(rename = "userinfo_signed_response_alg", skip_serializing_if = "Option::is_none")]
146 pub userinfo_signed_response_alg: Option<String>,
147}
148
149impl OAuth2Client {
150 /// OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.
151 pub fn new() -> OAuth2Client {
152 OAuth2Client {
153 access_token_strategy: None,
154 allowed_cors_origins: None,
155 audience: None,
156 authorization_code_grant_access_token_lifespan: None,
157 authorization_code_grant_id_token_lifespan: None,
158 authorization_code_grant_refresh_token_lifespan: None,
159 backchannel_logout_session_required: None,
160 backchannel_logout_uri: None,
161 client_credentials_grant_access_token_lifespan: None,
162 client_id: None,
163 client_name: None,
164 client_secret: None,
165 client_secret_expires_at: None,
166 client_uri: None,
167 contacts: None,
168 created_at: None,
169 device_authorization_grant_access_token_lifespan: None,
170 device_authorization_grant_id_token_lifespan: None,
171 device_authorization_grant_refresh_token_lifespan: None,
172 frontchannel_logout_session_required: None,
173 frontchannel_logout_uri: None,
174 grant_types: None,
175 implicit_grant_access_token_lifespan: None,
176 implicit_grant_id_token_lifespan: None,
177 jwks: None,
178 jwks_uri: None,
179 jwt_bearer_grant_access_token_lifespan: None,
180 logo_uri: None,
181 metadata: None,
182 owner: None,
183 policy_uri: None,
184 post_logout_redirect_uris: None,
185 redirect_uris: None,
186 refresh_token_grant_access_token_lifespan: None,
187 refresh_token_grant_id_token_lifespan: None,
188 refresh_token_grant_refresh_token_lifespan: None,
189 registration_access_token: None,
190 registration_client_uri: None,
191 request_object_signing_alg: None,
192 request_uris: None,
193 response_types: None,
194 scope: None,
195 sector_identifier_uri: None,
196 skip_consent: None,
197 skip_logout_consent: None,
198 subject_type: None,
199 token_endpoint_auth_method: None,
200 token_endpoint_auth_signing_alg: None,
201 tos_uri: None,
202 updated_at: None,
203 userinfo_signed_response_alg: None,
204 }
205 }
206}
207