Class: Aws::IoTManagedIntegrations::Types::OAuthConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb

Overview

Configuration details for OAuth authentication with a third-party service.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auth_url ⇒ String

The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.

Returns:

  • (String) 


3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 3717

class OAuthConfig < Struct.new(
  :auth_url,
  :token_url,
  :scope,
  :token_endpoint_authentication_scheme,
  :o_auth_complete_redirect_url,
  :proactive_refresh_token_renewal)
  SENSITIVE = []
  include Aws::Structure
end

#o_auth_complete_redirect_url ⇒ String

The URL where users are redirected after completing the OAuth authorization process.

Returns:

  • (String) 


3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 3717

class OAuthConfig < Struct.new(
  :auth_url,
  :token_url,
  :scope,
  :token_endpoint_authentication_scheme,
  :o_auth_complete_redirect_url,
  :proactive_refresh_token_renewal)
  SENSITIVE = []
  include Aws::Structure
end

#proactive_refresh_token_renewal ⇒ Types::ProactiveRefreshTokenRenewal

Configuration for proactively refreshing OAuth tokens before they expire.

Returns:



3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 3717

class OAuthConfig < Struct.new(
  :auth_url,
  :token_url,
  :scope,
  :token_endpoint_authentication_scheme,
  :o_auth_complete_redirect_url,
  :proactive_refresh_token_renewal)
  SENSITIVE = []
  include Aws::Structure
end

#scope ⇒ String

The OAuth scopes requested during authorization, which define the permissions granted to the application.

Returns:

  • (String) 


3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 3717

class OAuthConfig < Struct.new(
  :auth_url,
  :token_url,
  :scope,
  :token_endpoint_authentication_scheme,
  :o_auth_complete_redirect_url,
  :proactive_refresh_token_renewal)
  SENSITIVE = []
  include Aws::Structure
end

#token_endpoint_authentication_scheme ⇒ String

The authentication scheme used when requesting tokens from the token endpoint.

Returns:

  • (String) 


3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 3717

class OAuthConfig < Struct.new(
  :auth_url,
  :token_url,
  :scope,
  :token_endpoint_authentication_scheme,
  :o_auth_complete_redirect_url,
  :proactive_refresh_token_renewal)
  SENSITIVE = []
  include Aws::Structure
end

#token_url ⇒ String

The token URL for the OAuth service, where authorization codes are exchanged for access tokens.

Returns:

  • (String) 


3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 3717

class OAuthConfig < Struct.new(
  :auth_url,
  :token_url,
  :scope,
  :token_endpoint_authentication_scheme,
  :o_auth_complete_redirect_url,
  :proactive_refresh_token_renewal)
  SENSITIVE = []
  include Aws::Structure
end