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

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

Overview

Note:

When making an API call, you may pass OAuth2Credentials data as a hash:

{
  client_id: "ClientId",
  client_secret: "ClientSecret",
  access_token: "AccessToken",
  refresh_token: "RefreshToken",
  o_auth_request: {
    auth_code: "AuthCode",
    redirect_uri: "RedirectUri",
  },
}

The OAuth 2.0 credentials required for OAuth 2.0 authentication.

Constant Summary collapse

SENSITIVE =
[:client_secret, :access_token]

Instance Attribute Summary collapse

Instance Attribute Details

#access_tokenString

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

Returns:

  • (String)


4862
4863
4864
4865
4866
4867
4868
4869
4870
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4862

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_idString

The identifier for the desired client.

Returns:

  • (String)


4862
4863
4864
4865
4866
4867
4868
4869
4870
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4862

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_secretString

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

Returns:

  • (String)


4862
4863
4864
4865
4866
4867
4868
4869
4870
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4862

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_requestTypes::ConnectorOAuthRequest

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



4862
4863
4864
4865
4866
4867
4868
4869
4870
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4862

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_tokenString

The refresh token used to refresh an expired access token.

Returns:

  • (String)


4862
4863
4864
4865
4866
4867
4868
4869
4870
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4862

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