Class: Aws::Appflow::Types::OAuthCredentials

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 OAuthCredentials data as a hash:

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

The OAuth credentials required for OAuth type authentication.

Constant Summary collapse

SENSITIVE =
[:client_secret, :access_token]

Instance Attribute Summary collapse

Instance Attribute Details

#access_tokenString

The access token used to access protected SAPOData resources.

Returns:

  • (String)


3518
3519
3520
3521
3522
3523
3524
3525
3526
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3518

class OAuthCredentials < 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)


3518
3519
3520
3521
3522
3523
3524
3525
3526
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3518

class OAuthCredentials < 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)


3518
3519
3520
3521
3522
3523
3524
3525
3526
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3518

class OAuthCredentials < 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

The OAuth requirement needed to request security tokens from the connector endpoint.



3518
3519
3520
3521
3522
3523
3524
3525
3526
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3518

class OAuthCredentials < 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 expired access token.

Returns:

  • (String)


3518
3519
3520
3521
3522
3523
3524
3525
3526
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3518

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