aws-sdk-wickr 1.6.0

AWS SDK for AWS Wickr Admin API
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq)]
pub struct RegisterOidcConfigOutput {
    /// <p>The name of the registered OIDC application.</p>
    pub application_name: ::std::option::Option<::std::string::String>,
    /// <p>The OAuth client ID assigned to the application.</p>
    pub client_id: ::std::option::Option<::std::string::String>,
    /// <p>Custom identifier your end users will use to sign in with SSO.</p>
    pub company_id: ::std::string::String,
    /// <p>The OAuth scopes configured for the application.</p>
    pub scopes: ::std::string::String,
    /// <p>The issuer URL of the OIDC provider.</p>
    pub issuer: ::std::string::String,
    /// <p>The OAuth client secret for the application.</p>
    pub client_secret: ::std::option::Option<::std::string::String>,
    /// <p>The client secret for authenticating with the OIDC provider.</p>
    pub secret: ::std::option::Option<::std::string::String>,
    /// <p>The redirect URL configured for the OAuth flow.</p>
    pub redirect_url: ::std::option::Option<::std::string::String>,
    /// <p>The claim field being used as the user identifier.</p>
    pub user_id: ::std::option::Option<::std::string::String>,
    /// <p>The custom field mapping used for extracting the username.</p>
    pub custom_username: ::std::option::Option<::std::string::String>,
    /// <p>The CA certificate used for secure communication with the OIDC provider.</p>
    pub ca_certificate: ::std::option::Option<::std::string::String>,
    /// <p>The unique identifier for the registered OIDC application.</p>
    pub application_id: ::std::option::Option<i32>,
    /// <p>The buffer time in minutes before the SSO token expires.</p>
    pub sso_token_buffer_minutes: ::std::option::Option<i32>,
    /// <p>The additional authentication parameters configured for the OIDC flow.</p>
    pub extra_auth_params: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl RegisterOidcConfigOutput {
    /// <p>The name of the registered OIDC application.</p>
    pub fn application_name(&self) -> ::std::option::Option<&str> {
        self.application_name.as_deref()
    }
    /// <p>The OAuth client ID assigned to the application.</p>
    pub fn client_id(&self) -> ::std::option::Option<&str> {
        self.client_id.as_deref()
    }
    /// <p>Custom identifier your end users will use to sign in with SSO.</p>
    pub fn company_id(&self) -> &str {
        use std::ops::Deref;
        self.company_id.deref()
    }
    /// <p>The OAuth scopes configured for the application.</p>
    pub fn scopes(&self) -> &str {
        use std::ops::Deref;
        self.scopes.deref()
    }
    /// <p>The issuer URL of the OIDC provider.</p>
    pub fn issuer(&self) -> &str {
        use std::ops::Deref;
        self.issuer.deref()
    }
    /// <p>The OAuth client secret for the application.</p>
    pub fn client_secret(&self) -> ::std::option::Option<&str> {
        self.client_secret.as_deref()
    }
    /// <p>The client secret for authenticating with the OIDC provider.</p>
    pub fn secret(&self) -> ::std::option::Option<&str> {
        self.secret.as_deref()
    }
    /// <p>The redirect URL configured for the OAuth flow.</p>
    pub fn redirect_url(&self) -> ::std::option::Option<&str> {
        self.redirect_url.as_deref()
    }
    /// <p>The claim field being used as the user identifier.</p>
    pub fn user_id(&self) -> ::std::option::Option<&str> {
        self.user_id.as_deref()
    }
    /// <p>The custom field mapping used for extracting the username.</p>
    pub fn custom_username(&self) -> ::std::option::Option<&str> {
        self.custom_username.as_deref()
    }
    /// <p>The CA certificate used for secure communication with the OIDC provider.</p>
    pub fn ca_certificate(&self) -> ::std::option::Option<&str> {
        self.ca_certificate.as_deref()
    }
    /// <p>The unique identifier for the registered OIDC application.</p>
    pub fn application_id(&self) -> ::std::option::Option<i32> {
        self.application_id
    }
    /// <p>The buffer time in minutes before the SSO token expires.</p>
    pub fn sso_token_buffer_minutes(&self) -> ::std::option::Option<i32> {
        self.sso_token_buffer_minutes
    }
    /// <p>The additional authentication parameters configured for the OIDC flow.</p>
    pub fn extra_auth_params(&self) -> ::std::option::Option<&str> {
        self.extra_auth_params.as_deref()
    }
}
impl ::std::fmt::Debug for RegisterOidcConfigOutput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("RegisterOidcConfigOutput");
        formatter.field("application_name", &self.application_name);
        formatter.field("client_id", &self.client_id);
        formatter.field("company_id", &self.company_id);
        formatter.field("scopes", &self.scopes);
        formatter.field("issuer", &self.issuer);
        formatter.field("client_secret", &"*** Sensitive Data Redacted ***");
        formatter.field("secret", &"*** Sensitive Data Redacted ***");
        formatter.field("redirect_url", &self.redirect_url);
        formatter.field("user_id", &self.user_id);
        formatter.field("custom_username", &self.custom_username);
        formatter.field("ca_certificate", &self.ca_certificate);
        formatter.field("application_id", &self.application_id);
        formatter.field("sso_token_buffer_minutes", &self.sso_token_buffer_minutes);
        formatter.field("extra_auth_params", &self.extra_auth_params);
        formatter.field("_request_id", &self._request_id);
        formatter.finish()
    }
}
impl ::aws_types::request_id::RequestId for RegisterOidcConfigOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl RegisterOidcConfigOutput {
    /// Creates a new builder-style object to manufacture [`RegisterOidcConfigOutput`](crate::operation::register_oidc_config::RegisterOidcConfigOutput).
    pub fn builder() -> crate::operation::register_oidc_config::builders::RegisterOidcConfigOutputBuilder {
        crate::operation::register_oidc_config::builders::RegisterOidcConfigOutputBuilder::default()
    }
}

/// A builder for [`RegisterOidcConfigOutput`](crate::operation::register_oidc_config::RegisterOidcConfigOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct RegisterOidcConfigOutputBuilder {
    pub(crate) application_name: ::std::option::Option<::std::string::String>,
    pub(crate) client_id: ::std::option::Option<::std::string::String>,
    pub(crate) company_id: ::std::option::Option<::std::string::String>,
    pub(crate) scopes: ::std::option::Option<::std::string::String>,
    pub(crate) issuer: ::std::option::Option<::std::string::String>,
    pub(crate) client_secret: ::std::option::Option<::std::string::String>,
    pub(crate) secret: ::std::option::Option<::std::string::String>,
    pub(crate) redirect_url: ::std::option::Option<::std::string::String>,
    pub(crate) user_id: ::std::option::Option<::std::string::String>,
    pub(crate) custom_username: ::std::option::Option<::std::string::String>,
    pub(crate) ca_certificate: ::std::option::Option<::std::string::String>,
    pub(crate) application_id: ::std::option::Option<i32>,
    pub(crate) sso_token_buffer_minutes: ::std::option::Option<i32>,
    pub(crate) extra_auth_params: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl RegisterOidcConfigOutputBuilder {
    /// <p>The name of the registered OIDC application.</p>
    pub fn application_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.application_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the registered OIDC application.</p>
    pub fn set_application_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.application_name = input;
        self
    }
    /// <p>The name of the registered OIDC application.</p>
    pub fn get_application_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.application_name
    }
    /// <p>The OAuth client ID assigned to the application.</p>
    pub fn client_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.client_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The OAuth client ID assigned to the application.</p>
    pub fn set_client_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.client_id = input;
        self
    }
    /// <p>The OAuth client ID assigned to the application.</p>
    pub fn get_client_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.client_id
    }
    /// <p>Custom identifier your end users will use to sign in with SSO.</p>
    /// This field is required.
    pub fn company_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.company_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Custom identifier your end users will use to sign in with SSO.</p>
    pub fn set_company_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.company_id = input;
        self
    }
    /// <p>Custom identifier your end users will use to sign in with SSO.</p>
    pub fn get_company_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.company_id
    }
    /// <p>The OAuth scopes configured for the application.</p>
    /// This field is required.
    pub fn scopes(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.scopes = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The OAuth scopes configured for the application.</p>
    pub fn set_scopes(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.scopes = input;
        self
    }
    /// <p>The OAuth scopes configured for the application.</p>
    pub fn get_scopes(&self) -> &::std::option::Option<::std::string::String> {
        &self.scopes
    }
    /// <p>The issuer URL of the OIDC provider.</p>
    /// This field is required.
    pub fn issuer(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.issuer = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The issuer URL of the OIDC provider.</p>
    pub fn set_issuer(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.issuer = input;
        self
    }
    /// <p>The issuer URL of the OIDC provider.</p>
    pub fn get_issuer(&self) -> &::std::option::Option<::std::string::String> {
        &self.issuer
    }
    /// <p>The OAuth client secret for the application.</p>
    pub fn client_secret(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.client_secret = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The OAuth client secret for the application.</p>
    pub fn set_client_secret(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.client_secret = input;
        self
    }
    /// <p>The OAuth client secret for the application.</p>
    pub fn get_client_secret(&self) -> &::std::option::Option<::std::string::String> {
        &self.client_secret
    }
    /// <p>The client secret for authenticating with the OIDC provider.</p>
    pub fn secret(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.secret = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The client secret for authenticating with the OIDC provider.</p>
    pub fn set_secret(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.secret = input;
        self
    }
    /// <p>The client secret for authenticating with the OIDC provider.</p>
    pub fn get_secret(&self) -> &::std::option::Option<::std::string::String> {
        &self.secret
    }
    /// <p>The redirect URL configured for the OAuth flow.</p>
    pub fn redirect_url(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.redirect_url = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The redirect URL configured for the OAuth flow.</p>
    pub fn set_redirect_url(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.redirect_url = input;
        self
    }
    /// <p>The redirect URL configured for the OAuth flow.</p>
    pub fn get_redirect_url(&self) -> &::std::option::Option<::std::string::String> {
        &self.redirect_url
    }
    /// <p>The claim field being used as the user identifier.</p>
    pub fn user_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.user_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The claim field being used as the user identifier.</p>
    pub fn set_user_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.user_id = input;
        self
    }
    /// <p>The claim field being used as the user identifier.</p>
    pub fn get_user_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.user_id
    }
    /// <p>The custom field mapping used for extracting the username.</p>
    pub fn custom_username(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.custom_username = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The custom field mapping used for extracting the username.</p>
    pub fn set_custom_username(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.custom_username = input;
        self
    }
    /// <p>The custom field mapping used for extracting the username.</p>
    pub fn get_custom_username(&self) -> &::std::option::Option<::std::string::String> {
        &self.custom_username
    }
    /// <p>The CA certificate used for secure communication with the OIDC provider.</p>
    pub fn ca_certificate(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.ca_certificate = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The CA certificate used for secure communication with the OIDC provider.</p>
    pub fn set_ca_certificate(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.ca_certificate = input;
        self
    }
    /// <p>The CA certificate used for secure communication with the OIDC provider.</p>
    pub fn get_ca_certificate(&self) -> &::std::option::Option<::std::string::String> {
        &self.ca_certificate
    }
    /// <p>The unique identifier for the registered OIDC application.</p>
    pub fn application_id(mut self, input: i32) -> Self {
        self.application_id = ::std::option::Option::Some(input);
        self
    }
    /// <p>The unique identifier for the registered OIDC application.</p>
    pub fn set_application_id(mut self, input: ::std::option::Option<i32>) -> Self {
        self.application_id = input;
        self
    }
    /// <p>The unique identifier for the registered OIDC application.</p>
    pub fn get_application_id(&self) -> &::std::option::Option<i32> {
        &self.application_id
    }
    /// <p>The buffer time in minutes before the SSO token expires.</p>
    pub fn sso_token_buffer_minutes(mut self, input: i32) -> Self {
        self.sso_token_buffer_minutes = ::std::option::Option::Some(input);
        self
    }
    /// <p>The buffer time in minutes before the SSO token expires.</p>
    pub fn set_sso_token_buffer_minutes(mut self, input: ::std::option::Option<i32>) -> Self {
        self.sso_token_buffer_minutes = input;
        self
    }
    /// <p>The buffer time in minutes before the SSO token expires.</p>
    pub fn get_sso_token_buffer_minutes(&self) -> &::std::option::Option<i32> {
        &self.sso_token_buffer_minutes
    }
    /// <p>The additional authentication parameters configured for the OIDC flow.</p>
    pub fn extra_auth_params(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.extra_auth_params = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The additional authentication parameters configured for the OIDC flow.</p>
    pub fn set_extra_auth_params(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.extra_auth_params = input;
        self
    }
    /// <p>The additional authentication parameters configured for the OIDC flow.</p>
    pub fn get_extra_auth_params(&self) -> &::std::option::Option<::std::string::String> {
        &self.extra_auth_params
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`RegisterOidcConfigOutput`](crate::operation::register_oidc_config::RegisterOidcConfigOutput).
    /// This method will fail if any of the following fields are not set:
    /// - [`company_id`](crate::operation::register_oidc_config::builders::RegisterOidcConfigOutputBuilder::company_id)
    /// - [`scopes`](crate::operation::register_oidc_config::builders::RegisterOidcConfigOutputBuilder::scopes)
    /// - [`issuer`](crate::operation::register_oidc_config::builders::RegisterOidcConfigOutputBuilder::issuer)
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::register_oidc_config::RegisterOidcConfigOutput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::register_oidc_config::RegisterOidcConfigOutput {
            application_name: self.application_name,
            client_id: self.client_id,
            company_id: self.company_id.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "company_id",
                    "company_id was not specified but it is required when building RegisterOidcConfigOutput",
                )
            })?,
            scopes: self.scopes.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "scopes",
                    "scopes was not specified but it is required when building RegisterOidcConfigOutput",
                )
            })?,
            issuer: self.issuer.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "issuer",
                    "issuer was not specified but it is required when building RegisterOidcConfigOutput",
                )
            })?,
            client_secret: self.client_secret,
            secret: self.secret,
            redirect_url: self.redirect_url,
            user_id: self.user_id,
            custom_username: self.custom_username,
            ca_certificate: self.ca_certificate,
            application_id: self.application_id,
            sso_token_buffer_minutes: self.sso_token_buffer_minutes,
            extra_auth_params: self.extra_auth_params,
            _request_id: self._request_id,
        })
    }
}
impl ::std::fmt::Debug for RegisterOidcConfigOutputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("RegisterOidcConfigOutputBuilder");
        formatter.field("application_name", &self.application_name);
        formatter.field("client_id", &self.client_id);
        formatter.field("company_id", &self.company_id);
        formatter.field("scopes", &self.scopes);
        formatter.field("issuer", &self.issuer);
        formatter.field("client_secret", &"*** Sensitive Data Redacted ***");
        formatter.field("secret", &"*** Sensitive Data Redacted ***");
        formatter.field("redirect_url", &self.redirect_url);
        formatter.field("user_id", &self.user_id);
        formatter.field("custom_username", &self.custom_username);
        formatter.field("ca_certificate", &self.ca_certificate);
        formatter.field("application_id", &self.application_id);
        formatter.field("sso_token_buffer_minutes", &self.sso_token_buffer_minutes);
        formatter.field("extra_auth_params", &self.extra_auth_params);
        formatter.field("_request_id", &self._request_id);
        formatter.finish()
    }
}