open_api_hydra/models/o_auth2_client.rs
1/*
2 * ORY Hydra
3 *
4 * Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
5 *
6 * The version of the OpenAPI document: latest
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11
12
13
14#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
15pub struct OAuth2Client {
16 /// AllowedCORSOrigins are one or more URLs (scheme://host[:port]) which are allowed to make CORS requests to the /oauth/token endpoint. If this array is empty, the sever's CORS origin configuration (`CORS_ALLOWED_ORIGINS`) will be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration. Be aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.
17 #[serde(rename = "allowed_cors_origins", skip_serializing_if = "Option::is_none")]
18 pub allowed_cors_origins: Option<Vec<String>>,
19 /// Audience is a whitelist defining the audiences this client is allowed to request tokens for. An audience limits the applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list of URLs. URLs MUST NOT contain whitespaces.
20 #[serde(rename = "audience", skip_serializing_if = "Option::is_none")]
21 pub audience: Option<Vec<String>>,
22 /// 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.
23 #[serde(rename = "backchannel_logout_session_required", skip_serializing_if = "Option::is_none")]
24 pub backchannel_logout_session_required: Option<bool>,
25 /// RP URL that will cause the RP to log itself out when sent a Logout Token by the OP.
26 #[serde(rename = "backchannel_logout_uri", skip_serializing_if = "Option::is_none")]
27 pub backchannel_logout_uri: Option<String>,
28 /// ClientID is the id for this client.
29 #[serde(rename = "client_id", skip_serializing_if = "Option::is_none")]
30 pub client_id: Option<String>,
31 /// Name is the human-readable string name of the client to be presented to the end-user during authorization.
32 #[serde(rename = "client_name", skip_serializing_if = "Option::is_none")]
33 pub client_name: Option<String>,
34 /// Secret is the client's secret. The secret will be included in the create request as cleartext, and then never again. The secret is stored using BCrypt so it is impossible to recover it. Tell your users that they need to write the secret down as it will not be made available again.
35 #[serde(rename = "client_secret", skip_serializing_if = "Option::is_none")]
36 pub client_secret: Option<String>,
37 /// SecretExpiresAt is an integer holding the time at which the client secret will expire or 0 if it will not expire. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of expiration. This feature is currently not supported and it's value will always be set to 0.
38 #[serde(rename = "client_secret_expires_at", skip_serializing_if = "Option::is_none")]
39 pub client_secret_expires_at: Option<i64>,
40 /// ClientURI is an 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.
41 #[serde(rename = "client_uri", skip_serializing_if = "Option::is_none")]
42 pub client_uri: Option<String>,
43 /// Contacts is a array of strings representing ways to contact people responsible for this client, typically email addresses.
44 #[serde(rename = "contacts", skip_serializing_if = "Option::is_none")]
45 pub contacts: Option<Vec<String>>,
46 /// CreatedAt returns the timestamp of the client's creation.
47 #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")]
48 pub created_at: Option<String>,
49 /// 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.
50 #[serde(rename = "frontchannel_logout_session_required", skip_serializing_if = "Option::is_none")]
51 pub frontchannel_logout_session_required: Option<bool>,
52 /// 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.
53 #[serde(rename = "frontchannel_logout_uri", skip_serializing_if = "Option::is_none")]
54 pub frontchannel_logout_uri: Option<String>,
55 /// GrantTypes is an array of grant types the client is allowed to use.
56 #[serde(rename = "grant_types", skip_serializing_if = "Option::is_none")]
57 pub grant_types: Option<Vec<String>>,
58 #[serde(rename = "jwks", skip_serializing_if = "Option::is_none")]
59 pub jwks: Option<crate::models::JsonWebKeySet>,
60 /// 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.
61 #[serde(rename = "jwks_uri", skip_serializing_if = "Option::is_none")]
62 pub jwks_uri: Option<String>,
63 /// LogoURI is an URL string that references a logo for the client.
64 #[serde(rename = "logo_uri", skip_serializing_if = "Option::is_none")]
65 pub logo_uri: Option<String>,
66 /// Metadata is arbitrary data.
67 #[serde(rename = "metadata", skip_serializing_if = "Option::is_none")]
68 pub metadata: Option<::std::collections::HashMap<String, serde_json::Value>>,
69 /// Owner is a string identifying the owner of the OAuth 2.0 Client.
70 #[serde(rename = "owner", skip_serializing_if = "Option::is_none")]
71 pub owner: Option<String>,
72 /// 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.
73 #[serde(rename = "policy_uri", skip_serializing_if = "Option::is_none")]
74 pub policy_uri: Option<String>,
75 /// Array of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the post_logout_redirect_uri parameter after a logout has been performed.
76 #[serde(rename = "post_logout_redirect_uris", skip_serializing_if = "Option::is_none")]
77 pub post_logout_redirect_uris: Option<Vec<String>>,
78 /// RedirectURIs is an array of allowed redirect urls for the client, for example http://mydomain/oauth/callback .
79 #[serde(rename = "redirect_uris", skip_serializing_if = "Option::is_none")]
80 pub redirect_uris: Option<Vec<String>>,
81 /// 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.
82 #[serde(rename = "request_object_signing_alg", skip_serializing_if = "Option::is_none")]
83 pub request_object_signing_alg: Option<String>,
84 /// Array of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the contents of the files referenced by these URIs and not retrieve them at the time they are used in a request. OPs can require that request_uri values used be pre-registered with the require_request_uri_registration discovery parameter.
85 #[serde(rename = "request_uris", skip_serializing_if = "Option::is_none")]
86 pub request_uris: Option<Vec<String>>,
87 /// ResponseTypes is an array of the OAuth 2.0 response type strings that the client can use at the authorization endpoint.
88 #[serde(rename = "response_types", skip_serializing_if = "Option::is_none")]
89 pub response_types: Option<Vec<String>>,
90 /// 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.
91 #[serde(rename = "scope", skip_serializing_if = "Option::is_none")]
92 pub scope: Option<String>,
93 /// 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.
94 #[serde(rename = "sector_identifier_uri", skip_serializing_if = "Option::is_none")]
95 pub sector_identifier_uri: Option<String>,
96 /// SubjectType requested for responses to this Client. The subject_types_supported Discovery parameter contains a list of the supported subject_type values for this server. Valid types include `pairwise` and `public`.
97 #[serde(rename = "subject_type", skip_serializing_if = "Option::is_none")]
98 pub subject_type: Option<String>,
99 /// Requested Client Authentication method for the Token Endpoint. The options are client_secret_post, client_secret_basic, private_key_jwt, and none.
100 #[serde(rename = "token_endpoint_auth_method", skip_serializing_if = "Option::is_none")]
101 pub token_endpoint_auth_method: Option<String>,
102 /// TermsOfServiceURI is a URL string that points 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.
103 #[serde(rename = "tos_uri", skip_serializing_if = "Option::is_none")]
104 pub tos_uri: Option<String>,
105 /// UpdatedAt returns the timestamp of the last update.
106 #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")]
107 pub updated_at: Option<String>,
108 /// 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.
109 #[serde(rename = "userinfo_signed_response_alg", skip_serializing_if = "Option::is_none")]
110 pub userinfo_signed_response_alg: Option<String>,
111}
112
113impl OAuth2Client {
114 pub fn new() -> OAuth2Client {
115 OAuth2Client {
116 allowed_cors_origins: None,
117 audience: None,
118 backchannel_logout_session_required: None,
119 backchannel_logout_uri: None,
120 client_id: None,
121 client_name: None,
122 client_secret: None,
123 client_secret_expires_at: None,
124 client_uri: None,
125 contacts: None,
126 created_at: None,
127 frontchannel_logout_session_required: None,
128 frontchannel_logout_uri: None,
129 grant_types: None,
130 jwks: None,
131 jwks_uri: None,
132 logo_uri: None,
133 metadata: None,
134 owner: None,
135 policy_uri: None,
136 post_logout_redirect_uris: None,
137 redirect_uris: None,
138 request_object_signing_alg: None,
139 request_uris: None,
140 response_types: None,
141 scope: None,
142 sector_identifier_uri: None,
143 subject_type: None,
144 token_endpoint_auth_method: None,
145 tos_uri: None,
146 updated_at: None,
147 userinfo_signed_response_alg: None,
148 }
149 }
150}
151
152