Class: Aws::BedrockAgentCore::Types::OAuthCredentialProvider

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

Overview

Configuration for an OAuth 2.0 credential provider used to authenticate tool calls.

See Also:

Constant Summary collapse

SENSITIVE = 
[:custom_parameters]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_parameters ⇒ Hash<String,String>

Additional custom parameters to include in the OAuth 2.0 token request.

Returns:

  • (Hash<String,String>) 


8086
8087
8088
8089
8090
8091
8092
8093
8094
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 8086

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 default return URL for the OAuth 2.0 authorization flow.

Returns:

  • (String) 


8086
8087
8088
8089
8090
8091
8092
8093
8094
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 8086

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

#grant_type ⇒ String

The OAuth 2.0 grant type to use for authentication.

Returns:

  • (String) 


8086
8087
8088
8089
8090
8091
8092
8093
8094
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 8086

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 ARN of the OAuth 2.0 credential provider in AgentCore Identity.

Returns:

  • (String) 


8086
8087
8088
8089
8090
8091
8092
8093
8094
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 8086

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 2.0 scopes to request when obtaining an access token.

Returns:

  • (Array<String>) 


8086
8087
8088
8089
8090
8091
8092
8093
8094
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 8086

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