Class: Aws::BedrockAgentCoreControl::Types::OAuthCredentialProvider

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

Overview

An OAuth credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using OAuth.

See Also:

Constant Summary collapse

SENSITIVE = 
[:custom_parameters]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_parameters ⇒ Hash<String,String>

The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.

Returns:

  • (Hash<String,String>) 


7108
7109
7110
7111
7112
7113
7114
7115
7116
 
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 7108

class OAuthCredentialProvider < Struct.new(
  :provider_arn,
  :scopes,
  :custom_parameters,
  :grant_type,
  :default_return_url)
  SENSITIVE = [:custom_parameters]
  include Aws::Structure
end

#default_return_url ⇒ String

The URL where the end user's browser is redirected after obtaining the authorization code. Generally points to the customer's application.

Returns:

  • (String) 


7108
7109
7110
7111
7112
7113
7114
7115
7116
 
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 7108

class OAuthCredentialProvider < Struct.new(
  :provider_arn,
  :scopes,
  :custom_parameters,
  :grant_type,
  :default_return_url)
  SENSITIVE = [:custom_parameters]
  include Aws::Structure
end

#grant_type ⇒ String

Specifies the kind of credentials to use for authorization:

  • CLIENT_CREDENTIALS - Authorization with a client ID and secret.

  • AUTHORIZATION_CODE - Authorization with a token that is specific to an individual end user.

Returns:

  • (String) 


7108
7109
7110
7111
7112
7113
7114
7115
7116
 
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 7108

class OAuthCredentialProvider < Struct.new(
  :provider_arn,
  :scopes,
  :custom_parameters,
  :grant_type,
  :default_return_url)
  SENSITIVE = [:custom_parameters]
  include Aws::Structure
end

#provider_arn ⇒ String

The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.

Returns:

  • (String) 


7108
7109
7110
7111
7112
7113
7114
7115
7116
 
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 7108

class OAuthCredentialProvider < Struct.new(
  :provider_arn,
  :scopes,
  :custom_parameters,
  :grant_type,
  :default_return_url)
  SENSITIVE = [:custom_parameters]
  include Aws::Structure
end

#scopes ⇒ Array<String>

The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.

Returns:

  • (Array<String>) 


7108
7109
7110
7111
7112
7113
7114
7115
7116
 
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 7108

class OAuthCredentialProvider < Struct.new(
  :provider_arn,
  :scopes,
  :custom_parameters,
  :grant_type,
  :default_return_url)
  SENSITIVE = [:custom_parameters]
  include Aws::Structure
end