Class: Aws::BedrockAgentCore::Types::GetResourceOauth2TokenRequest

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentCore::Types::GetResourceOauth2TokenRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:workload_identity_token, :custom_parameters, :custom_state]

Instance Attribute Summary

• #custom_parameters ⇒ Hash<String,String>

  A map of custom parameters to include in the authorization request to the resource credential provider.

• #custom_state ⇒ String

  An opaque string that will be sent back to the callback URL provided in resourceOauth2ReturnUrl.

• #force_authentication ⇒ Boolean

  Indicates whether to always initiate a new three-legged OAuth (3LO) flow, regardless of any existing session.

• #oauth2_flow ⇒ String

  The type of flow to be performed.

• #resource_credential_provider_name ⇒ String

  The name of the resource's credential provider.

• #resource_oauth_2_return_url ⇒ String

  The callback URL to redirect to after the OAuth 2.0 token retrieval is complete.

• #scopes ⇒ Array<String>

  The OAuth scopes being requested.

• #session_uri ⇒ String

  Unique identifier for the user's authentication session for retrieving OAuth2 tokens.

• #workload_identity_token ⇒ String

  The identity token of the workload from which you want to retrieve the OAuth2 token.

Instance Attribute Details

#custom_parameters ⇒ Hash<String,String>

A map of custom parameters to include in the authorization request to the resource credential provider. These parameters are in addition to the standard OAuth 2.0 flow parameters, and will not override them.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2050

class GetResourceOauth2TokenRequest < Struct.new(
  :workload_identity_token,
  :resource_credential_provider_name,
  :scopes,
  :oauth2_flow,
  :session_uri,
  :resource_oauth_2_return_url,
  :force_authentication,
  :custom_parameters,
  :custom_state)
  SENSITIVE = [:workload_identity_token, :custom_parameters, :custom_state]
  include Aws::Structure
end

#custom_state ⇒ String

An opaque string that will be sent back to the callback URL provided in resourceOauth2ReturnUrl. This state should be used to protect the callback URL of your application against CSRF attacks by ensuring the response corresponds to the original request.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2050

class GetResourceOauth2TokenRequest < Struct.new(
  :workload_identity_token,
  :resource_credential_provider_name,
  :scopes,
  :oauth2_flow,
  :session_uri,
  :resource_oauth_2_return_url,
  :force_authentication,
  :custom_parameters,
  :custom_state)
  SENSITIVE = [:workload_identity_token, :custom_parameters, :custom_state]
  include Aws::Structure
end

#force_authentication ⇒ Boolean

Indicates whether to always initiate a new three-legged OAuth (3LO) flow, regardless of any existing session.

Returns:

• (Boolean)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2050

class GetResourceOauth2TokenRequest < Struct.new(
  :workload_identity_token,
  :resource_credential_provider_name,
  :scopes,
  :oauth2_flow,
  :session_uri,
  :resource_oauth_2_return_url,
  :force_authentication,
  :custom_parameters,
  :custom_state)
  SENSITIVE = [:workload_identity_token, :custom_parameters, :custom_state]
  include Aws::Structure
end

#oauth2_flow ⇒ String

The type of flow to be performed.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2050

class GetResourceOauth2TokenRequest < Struct.new(
  :workload_identity_token,
  :resource_credential_provider_name,
  :scopes,
  :oauth2_flow,
  :session_uri,
  :resource_oauth_2_return_url,
  :force_authentication,
  :custom_parameters,
  :custom_state)
  SENSITIVE = [:workload_identity_token, :custom_parameters, :custom_state]
  include Aws::Structure
end

#resource_credential_provider_name ⇒ String

The name of the resource's credential provider.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2050

class GetResourceOauth2TokenRequest < Struct.new(
  :workload_identity_token,
  :resource_credential_provider_name,
  :scopes,
  :oauth2_flow,
  :session_uri,
  :resource_oauth_2_return_url,
  :force_authentication,
  :custom_parameters,
  :custom_state)
  SENSITIVE = [:workload_identity_token, :custom_parameters, :custom_state]
  include Aws::Structure
end

#resource_oauth_2_return_url ⇒ String

The callback URL to redirect to after the OAuth 2.0 token retrieval is complete. This URL must be one of the provided URLs configured for the workload identity.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2050

class GetResourceOauth2TokenRequest < Struct.new(
  :workload_identity_token,
  :resource_credential_provider_name,
  :scopes,
  :oauth2_flow,
  :session_uri,
  :resource_oauth_2_return_url,
  :force_authentication,
  :custom_parameters,
  :custom_state)
  SENSITIVE = [:workload_identity_token, :custom_parameters, :custom_state]
  include Aws::Structure
end

#scopes ⇒ Array<String>

The OAuth scopes being requested.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2050

class GetResourceOauth2TokenRequest < Struct.new(
  :workload_identity_token,
  :resource_credential_provider_name,
  :scopes,
  :oauth2_flow,
  :session_uri,
  :resource_oauth_2_return_url,
  :force_authentication,
  :custom_parameters,
  :custom_state)
  SENSITIVE = [:workload_identity_token, :custom_parameters, :custom_state]
  include Aws::Structure
end

#session_uri ⇒ String

Unique identifier for the user's authentication session for retrieving OAuth2 tokens. This ID tracks the authorization flow state across multiple requests and responses during the OAuth2 authentication process.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2050

class GetResourceOauth2TokenRequest < Struct.new(
  :workload_identity_token,
  :resource_credential_provider_name,
  :scopes,
  :oauth2_flow,
  :session_uri,
  :resource_oauth_2_return_url,
  :force_authentication,
  :custom_parameters,
  :custom_state)
  SENSITIVE = [:workload_identity_token, :custom_parameters, :custom_state]
  include Aws::Structure
end

#workload_identity_token ⇒ String

The identity token of the workload from which you want to retrieve the OAuth2 token.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 2050

class GetResourceOauth2TokenRequest < Struct.new(
  :workload_identity_token,
  :resource_credential_provider_name,
  :scopes,
  :oauth2_flow,
  :session_uri,
  :resource_oauth_2_return_url,
  :force_authentication,
  :custom_parameters,
  :custom_state)
  SENSITIVE = [:workload_identity_token, :custom_parameters, :custom_state]
  include Aws::Structure
end