aws_sdk_wickr/client/
register_oidc_config.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`RegisterOidcConfig`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`network_id(impl Into<String>)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network for which OIDC will be configured.</p><br>
7    ///   - [`company_id(impl Into<String>)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::company_id) / [`set_company_id(Option<String>)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::set_company_id):<br>required: **true**<br><p>Custom identifier your end users will use to sign in with SSO.</p><br>
8    ///   - [`custom_username(impl Into<String>)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::custom_username) / [`set_custom_username(Option<String>)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::set_custom_username):<br>required: **false**<br><p>A custom field mapping to extract the username from the OIDC token (optional).</p><note>  <p>The customUsername is only required if you use something other than email as the username field.</p> </note><br>
9    ///   - [`extra_auth_params(impl Into<String>)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::extra_auth_params) / [`set_extra_auth_params(Option<String>)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::set_extra_auth_params):<br>required: **false**<br><p>Additional authentication parameters to include in the OIDC flow (optional).</p><br>
10    ///   - [`issuer(impl Into<String>)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::issuer) / [`set_issuer(Option<String>)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::set_issuer):<br>required: **true**<br><p>The issuer URL of the OIDC provider (e.g., 'https://login.example.com').</p><br>
11    ///   - [`scopes(impl Into<String>)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::scopes) / [`set_scopes(Option<String>)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::set_scopes):<br>required: **true**<br><p>The OAuth scopes to request from the OIDC provider (e.g., 'openid profile email').</p><br>
12    ///   - [`secret(impl Into<String>)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::secret) / [`set_secret(Option<String>)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::set_secret):<br>required: **false**<br><p>The client secret for authenticating with the OIDC provider (optional).</p><br>
13    ///   - [`sso_token_buffer_minutes(i32)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::sso_token_buffer_minutes) / [`set_sso_token_buffer_minutes(Option<i32>)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::set_sso_token_buffer_minutes):<br>required: **false**<br><p>The buffer time in minutes before the SSO token expires to refresh it (optional).</p><br>
14    ///   - [`user_id(impl Into<String>)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::set_user_id):<br>required: **false**<br><p>Unique identifier provided by your identity provider to authenticate the access request. Also referred to as clientID.</p><br>
15    /// - On success, responds with [`RegisterOidcConfigOutput`](crate::operation::register_oidc_config::RegisterOidcConfigOutput) with field(s):
16    ///   - [`application_name(Option<String>)`](crate::operation::register_oidc_config::RegisterOidcConfigOutput::application_name): <p>The name of the registered OIDC application.</p>
17    ///   - [`client_id(Option<String>)`](crate::operation::register_oidc_config::RegisterOidcConfigOutput::client_id): <p>The OAuth client ID assigned to the application.</p>
18    ///   - [`company_id(String)`](crate::operation::register_oidc_config::RegisterOidcConfigOutput::company_id): <p>Custom identifier your end users will use to sign in with SSO.</p>
19    ///   - [`scopes(String)`](crate::operation::register_oidc_config::RegisterOidcConfigOutput::scopes): <p>The OAuth scopes configured for the application.</p>
20    ///   - [`issuer(String)`](crate::operation::register_oidc_config::RegisterOidcConfigOutput::issuer): <p>The issuer URL of the OIDC provider.</p>
21    ///   - [`client_secret(Option<String>)`](crate::operation::register_oidc_config::RegisterOidcConfigOutput::client_secret): <p>The OAuth client secret for the application.</p>
22    ///   - [`secret(Option<String>)`](crate::operation::register_oidc_config::RegisterOidcConfigOutput::secret): <p>The client secret for authenticating with the OIDC provider.</p>
23    ///   - [`redirect_url(Option<String>)`](crate::operation::register_oidc_config::RegisterOidcConfigOutput::redirect_url): <p>The redirect URL configured for the OAuth flow.</p>
24    ///   - [`user_id(Option<String>)`](crate::operation::register_oidc_config::RegisterOidcConfigOutput::user_id): <p>The claim field being used as the user identifier.</p>
25    ///   - [`custom_username(Option<String>)`](crate::operation::register_oidc_config::RegisterOidcConfigOutput::custom_username): <p>The custom field mapping used for extracting the username.</p>
26    ///   - [`ca_certificate(Option<String>)`](crate::operation::register_oidc_config::RegisterOidcConfigOutput::ca_certificate): <p>The CA certificate used for secure communication with the OIDC provider.</p>
27    ///   - [`application_id(Option<i32>)`](crate::operation::register_oidc_config::RegisterOidcConfigOutput::application_id): <p>The unique identifier for the registered OIDC application.</p>
28    ///   - [`sso_token_buffer_minutes(Option<i32>)`](crate::operation::register_oidc_config::RegisterOidcConfigOutput::sso_token_buffer_minutes): <p>The buffer time in minutes before the SSO token expires.</p>
29    ///   - [`extra_auth_params(Option<String>)`](crate::operation::register_oidc_config::RegisterOidcConfigOutput::extra_auth_params): <p>The additional authentication parameters configured for the OIDC flow.</p>
30    /// - On failure, responds with [`SdkError<RegisterOidcConfigError>`](crate::operation::register_oidc_config::RegisterOidcConfigError)
31    pub fn register_oidc_config(&self) -> crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder {
32        crate::operation::register_oidc_config::builders::RegisterOidcConfigFluentBuilder::new(self.handle.clone())
33    }
34}
aws_sdk_wickr/client/register_oidc_config.rs

aws_sdk_wickr/client/
register_oidc_config.rs
