Class OidcConfigInfo

java.lang.Object
software.amazon.awssdk.services.wickr.model.OidcConfigInfo
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OidcConfigInfo.Builder,OidcConfigInfo>
@Generated("software.amazon.awssdk:codegen") public final class OidcConfigInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OidcConfigInfo.Builder,OidcConfigInfo>

Contains the OpenID Connect (OIDC) configuration information for Single Sign-On (SSO) authentication, including identity provider settings and client credentials.

See Also:

  • Method Details

    • applicationName

      public final String applicationName()

      The name of the OIDC application as registered with the identity provider.

      Returns:
      The name of the OIDC application as registered with the identity provider.

    • clientId

      public final String clientId()

      The OAuth client ID assigned by the identity provider for authentication requests.

      Returns:
      The OAuth client ID assigned by the identity provider for authentication requests.

    • companyId

      public final String companyId()

      Custom identifier your end users will use to sign in with SSO.

      Returns:
      Custom identifier your end users will use to sign in with SSO.

    • scopes

      public final String scopes()

      The OAuth scopes requested from the identity provider, which determine what user information is accessible (e.g., 'openid profile email').

      Returns:
      The OAuth scopes requested from the identity provider, which determine what user information is accessible (e.g., 'openid profile email').

    • issuer

      public final String issuer()

      The issuer URL of the identity provider, which serves as the base URL for OIDC endpoints and configuration discovery.

      Returns:
      The issuer URL of the identity provider, which serves as the base URL for OIDC endpoints and configuration discovery.

    • clientSecret

      public final String clientSecret()

      The OAuth client secret used to authenticate the application with the identity provider.

      Returns:
      The OAuth client secret used to authenticate the application with the identity provider.

    • secret

      public final String secret()

      An additional secret credential used by the identity provider for authentication.

      Returns:
      An additional secret credential used by the identity provider for authentication.

    • redirectUrl

      public final String redirectUrl()

      The callback URL where the identity provider redirects users after successful authentication. This URL must be registered with the identity provider.

      Returns:
      The callback URL where the identity provider redirects users after successful authentication. This URL must be registered with the identity provider.

    • userId

      public final String userId()

      The claim field from the OIDC token to use as the unique user identifier (e.g., 'email', 'sub', or a custom claim).

      Returns:
      The claim field from the OIDC token to use as the unique user identifier (e.g., 'email', 'sub', or a custom claim).

    • customUsername

      public final String customUsername()

      A custom field mapping to extract the username from the OIDC token when the standard username claim is insufficient.

      Returns:
      A custom field mapping to extract the username from the OIDC token when the standard username claim is insufficient.

    • caCertificate

      public final String caCertificate()

      The X.509 CA certificate for validating SSL/TLS connections to the identity provider when using self-signed or enterprise certificates.

      Returns:
      The X.509 CA certificate for validating SSL/TLS connections to the identity provider when using self-signed or enterprise certificates.

    • applicationId

      public final Integer applicationId()

      The unique identifier for the registered OIDC application. Valid range is 1-10.

      Returns:
      The unique identifier for the registered OIDC application. Valid range is 1-10.

    • ssoTokenBufferMinutes

      public final Integer ssoTokenBufferMinutes()

      The grace period in minutes before the SSO token expires when the system should proactively refresh the token to maintain seamless user access.

      Returns:
      The grace period in minutes before the SSO token expires when the system should proactively refresh the token to maintain seamless user access.

    • extraAuthParams

      public final String extraAuthParams()

      Additional authentication parameters to include in the OIDC authorization request as a query string. Useful for provider-specific extensions.

      Returns:
      Additional authentication parameters to include in the OIDC authorization request as a query string. Useful for provider-specific extensions.

    • toBuilder

      public OidcConfigInfo.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<OidcConfigInfo.Builder,OidcConfigInfo>
      Returns:
      a builder for type T

    • builder

      public static OidcConfigInfo.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OidcConfigInfo.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.