Class: Aws::SecurityAgent::Types::GitHubIntegrationInput

Inherits:

Struct

• Object
• Struct
• Aws::SecurityAgent::Types::GitHubIntegrationInput

Defined in:

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

Overview

The input required to create a GitHub integration, including the OAuth authorization code and CSRF state.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #code ⇒ String

  The OAuth authorization code received from GitHub.

• #installation_id ⇒ String

  The installation identifier provided by GitHub Enterprise Server on the install callback.

• #organization_name ⇒ String

  The name of the GitHub organization to integrate with.

• #state ⇒ String

  The CSRF state token for validating the OAuth flow.

• #target_url ⇒ String

  The HTTPS URL of a self-hosted GitHub Enterprise Server instance.

Instance Attribute Details

#code ⇒ String

The OAuth authorization code received from GitHub.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 4336

class GitHubIntegrationInput < Struct.new(
  :code,
  :state,
  :organization_name,
  :target_url,
  :installation_id)
  SENSITIVE = []
  include Aws::Structure
end

#installation_id ⇒ String

The installation identifier provided by GitHub Enterprise Server on the install callback. Required for GitHub Enterprise Server integrations and ignored for GitHub.com.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 4336

class GitHubIntegrationInput < Struct.new(
  :code,
  :state,
  :organization_name,
  :target_url,
  :installation_id)
  SENSITIVE = []
  include Aws::Structure
end

#organization_name ⇒ String

The name of the GitHub organization to integrate with.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 4336

class GitHubIntegrationInput < Struct.new(
  :code,
  :state,
  :organization_name,
  :target_url,
  :installation_id)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The CSRF state token for validating the OAuth flow.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 4336

class GitHubIntegrationInput < Struct.new(
  :code,
  :state,
  :organization_name,
  :target_url,
  :installation_id)
  SENSITIVE = []
  include Aws::Structure
end

#target_url ⇒ String

The HTTPS URL of a self-hosted GitHub Enterprise Server instance. Omit this value for GitHub.com.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 4336

class GitHubIntegrationInput < Struct.new(
  :code,
  :state,
  :organization_name,
  :target_url,
  :installation_id)
  SENSITIVE = []
  include Aws::Structure
end