Class: Aws::Appflow::Types::OAuth2Credentials

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

Overview

The OAuth 2.0 credentials required for OAuth 2.0 authentication.

See Also:

Constant Summary collapse

SENSITIVE = 
[:client_secret, :access_token]

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String

The access token used to access the connector on your behalf.

Returns:

  • (String) 


3336
3337
3338
3339
3340
3341
3342
3343
3344
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3336

class OAuth2Credentials < Struct.new(
  :client_id,
  :client_secret,
  :access_token,
  :refresh_token,
  :o_auth_request)
  SENSITIVE = [:client_secret, :access_token]
  include Aws::Structure
end

#client_id ⇒ String

The identifier for the desired client.

Returns:

  • (String) 


3336
3337
3338
3339
3340
3341
3342
3343
3344
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3336

class OAuth2Credentials < Struct.new(
  :client_id,
  :client_secret,
  :access_token,
  :refresh_token,
  :o_auth_request)
  SENSITIVE = [:client_secret, :access_token]
  include Aws::Structure
end

#client_secret ⇒ String

The client secret used by the OAuth client to authenticate to the authorization server.

Returns:

  • (String) 


3336
3337
3338
3339
3340
3341
3342
3343
3344
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3336

class OAuth2Credentials < Struct.new(
  :client_id,
  :client_secret,
  :access_token,
  :refresh_token,
  :o_auth_request)
  SENSITIVE = [:client_secret, :access_token]
  include Aws::Structure
end

#o_auth_request ⇒ Types::ConnectorOAuthRequest

Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

Returns:



3336
3337
3338
3339
3340
3341
3342
3343
3344
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3336

class OAuth2Credentials < Struct.new(
  :client_id,
  :client_secret,
  :access_token,
  :refresh_token,
  :o_auth_request)
  SENSITIVE = [:client_secret, :access_token]
  include Aws::Structure
end

#refresh_token ⇒ String

The refresh token used to refresh an expired access token.

Returns:

  • (String) 


3336
3337
3338
3339
3340
3341
3342
3343
3344
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3336

class OAuth2Credentials < Struct.new(
  :client_id,
  :client_secret,
  :access_token,
  :refresh_token,
  :o_auth_request)
  SENSITIVE = [:client_secret, :access_token]
  include Aws::Structure
end