Class: Aws::Wickr::Types::OidcConfigInfo

Inherits:

Struct

• Object
• Struct
• Aws::Wickr::Types::OidcConfigInfo

Defined in:

gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:client_secret, :secret]

Instance Attribute Summary

• #application_id ⇒ Integer

  The unique identifier for the registered OIDC application.

• #application_name ⇒ String

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

• #ca_certificate ⇒ String

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

• #client_id ⇒ String

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

• #client_secret ⇒ String

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

• #company_id ⇒ String

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

• #custom_username ⇒ String

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

• #extra_auth_params ⇒ String

  Additional authentication parameters to include in the OIDC authorization request as a query string.

• #issuer ⇒ String

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

• #redirect_url ⇒ String

  The callback URL where the identity provider redirects users after successful authentication.

• #scopes ⇒ String

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

• #secret ⇒ String

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

• #sso_token_buffer_minutes ⇒ Integer

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

• #user_id ⇒ String

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

Instance Attribute Details

#application_id ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 2421

class OidcConfigInfo < Struct.new(
  :application_name,
  :client_id,
  :company_id,
  :scopes,
  :issuer,
  :client_secret,
  :secret,
  :redirect_url,
  :user_id,
  :custom_username,
  :ca_certificate,
  :application_id,
  :sso_token_buffer_minutes,
  :extra_auth_params)
  SENSITIVE = [:client_secret, :secret]
  include Aws::Structure
end

#application_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 2421

class OidcConfigInfo < Struct.new(
  :application_name,
  :client_id,
  :company_id,
  :scopes,
  :issuer,
  :client_secret,
  :secret,
  :redirect_url,
  :user_id,
  :custom_username,
  :ca_certificate,
  :application_id,
  :sso_token_buffer_minutes,
  :extra_auth_params)
  SENSITIVE = [:client_secret, :secret]
  include Aws::Structure
end

#ca_certificate ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 2421

class OidcConfigInfo < Struct.new(
  :application_name,
  :client_id,
  :company_id,
  :scopes,
  :issuer,
  :client_secret,
  :secret,
  :redirect_url,
  :user_id,
  :custom_username,
  :ca_certificate,
  :application_id,
  :sso_token_buffer_minutes,
  :extra_auth_params)
  SENSITIVE = [:client_secret, :secret]
  include Aws::Structure
end

#client_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 2421

class OidcConfigInfo < Struct.new(
  :application_name,
  :client_id,
  :company_id,
  :scopes,
  :issuer,
  :client_secret,
  :secret,
  :redirect_url,
  :user_id,
  :custom_username,
  :ca_certificate,
  :application_id,
  :sso_token_buffer_minutes,
  :extra_auth_params)
  SENSITIVE = [:client_secret, :secret]
  include Aws::Structure
end

#client_secret ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 2421

class OidcConfigInfo < Struct.new(
  :application_name,
  :client_id,
  :company_id,
  :scopes,
  :issuer,
  :client_secret,
  :secret,
  :redirect_url,
  :user_id,
  :custom_username,
  :ca_certificate,
  :application_id,
  :sso_token_buffer_minutes,
  :extra_auth_params)
  SENSITIVE = [:client_secret, :secret]
  include Aws::Structure
end

#company_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 2421

class OidcConfigInfo < Struct.new(
  :application_name,
  :client_id,
  :company_id,
  :scopes,
  :issuer,
  :client_secret,
  :secret,
  :redirect_url,
  :user_id,
  :custom_username,
  :ca_certificate,
  :application_id,
  :sso_token_buffer_minutes,
  :extra_auth_params)
  SENSITIVE = [:client_secret, :secret]
  include Aws::Structure
end

#custom_username ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 2421

class OidcConfigInfo < Struct.new(
  :application_name,
  :client_id,
  :company_id,
  :scopes,
  :issuer,
  :client_secret,
  :secret,
  :redirect_url,
  :user_id,
  :custom_username,
  :ca_certificate,
  :application_id,
  :sso_token_buffer_minutes,
  :extra_auth_params)
  SENSITIVE = [:client_secret, :secret]
  include Aws::Structure
end

#extra_auth_params ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 2421

class OidcConfigInfo < Struct.new(
  :application_name,
  :client_id,
  :company_id,
  :scopes,
  :issuer,
  :client_secret,
  :secret,
  :redirect_url,
  :user_id,
  :custom_username,
  :ca_certificate,
  :application_id,
  :sso_token_buffer_minutes,
  :extra_auth_params)
  SENSITIVE = [:client_secret, :secret]
  include Aws::Structure
end

#issuer ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 2421

class OidcConfigInfo < Struct.new(
  :application_name,
  :client_id,
  :company_id,
  :scopes,
  :issuer,
  :client_secret,
  :secret,
  :redirect_url,
  :user_id,
  :custom_username,
  :ca_certificate,
  :application_id,
  :sso_token_buffer_minutes,
  :extra_auth_params)
  SENSITIVE = [:client_secret, :secret]
  include Aws::Structure
end

#redirect_url ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 2421

class OidcConfigInfo < Struct.new(
  :application_name,
  :client_id,
  :company_id,
  :scopes,
  :issuer,
  :client_secret,
  :secret,
  :redirect_url,
  :user_id,
  :custom_username,
  :ca_certificate,
  :application_id,
  :sso_token_buffer_minutes,
  :extra_auth_params)
  SENSITIVE = [:client_secret, :secret]
  include Aws::Structure
end

#scopes ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 2421

class OidcConfigInfo < Struct.new(
  :application_name,
  :client_id,
  :company_id,
  :scopes,
  :issuer,
  :client_secret,
  :secret,
  :redirect_url,
  :user_id,
  :custom_username,
  :ca_certificate,
  :application_id,
  :sso_token_buffer_minutes,
  :extra_auth_params)
  SENSITIVE = [:client_secret, :secret]
  include Aws::Structure
end

#secret ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 2421

class OidcConfigInfo < Struct.new(
  :application_name,
  :client_id,
  :company_id,
  :scopes,
  :issuer,
  :client_secret,
  :secret,
  :redirect_url,
  :user_id,
  :custom_username,
  :ca_certificate,
  :application_id,
  :sso_token_buffer_minutes,
  :extra_auth_params)
  SENSITIVE = [:client_secret, :secret]
  include Aws::Structure
end

#sso_token_buffer_minutes ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 2421

class OidcConfigInfo < Struct.new(
  :application_name,
  :client_id,
  :company_id,
  :scopes,
  :issuer,
  :client_secret,
  :secret,
  :redirect_url,
  :user_id,
  :custom_username,
  :ca_certificate,
  :application_id,
  :sso_token_buffer_minutes,
  :extra_auth_params)
  SENSITIVE = [:client_secret, :secret]
  include Aws::Structure
end

#user_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 2421

class OidcConfigInfo < Struct.new(
  :application_name,
  :client_id,
  :company_id,
  :scopes,
  :issuer,
  :client_secret,
  :secret,
  :redirect_url,
  :user_id,
  :custom_username,
  :ca_certificate,
  :application_id,
  :sso_token_buffer_minutes,
  :extra_auth_params)
  SENSITIVE = [:client_secret, :secret]
  include Aws::Structure
end