Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harness Provider
  3. API Docs
  4. platform
  5. GithubConnector
Harness v0.5.7 published on Saturday, Mar 8, 2025 by Pulumi
pulumi/pulumi-harness

harness.platform.GithubConnector

Explore with Pulumi AI

harness logo
Harness v0.5.7 published on Saturday, Mar 8, 2025 by Pulumi
pulumi/pulumi-harness

    Resource for creating a Github connector.

    Create GithubConnector Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GithubConnector(name: string, args: GithubConnectorArgs, opts?: CustomResourceOptions);
    @overload
def GithubConnector(resource_name: str,
                    args: GithubConnectorArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def GithubConnector(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    identifier: Optional[str] = None,
                    connection_type: Optional[str] = None,
                    credentials: Optional[GithubConnectorCredentialsArgs] = None,
                    url: Optional[str] = None,
                    force_delete: Optional[bool] = None,
                    execute_on_delegate: Optional[bool] = None,
                    api_authentication: Optional[GithubConnectorApiAuthenticationArgs] = None,
                    description: Optional[str] = None,
                    name: Optional[str] = None,
                    org_id: Optional[str] = None,
                    project_id: Optional[str] = None,
                    tags: Optional[Sequence[str]] = None,
                    delegate_selectors: Optional[Sequence[str]] = None,
                    validation_repo: Optional[str] = None)
    func NewGithubConnector(ctx *Context, name string, args GithubConnectorArgs, opts ...ResourceOption) (*GithubConnector, error)
    public GithubConnector(string name, GithubConnectorArgs args, CustomResourceOptions? opts = null)
    public GithubConnector(String name, GithubConnectorArgs args)
public GithubConnector(String name, GithubConnectorArgs args, CustomResourceOptions options)

    type: harness:platform:GithubConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GithubConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GithubConnectorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GithubConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GithubConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GithubConnectorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var githubConnectorResource = new Harness.Platform.GithubConnector("githubConnectorResource", new()
{
    Identifier = "string",
    ConnectionType = "string",
    Credentials = new Harness.Platform.Inputs.GithubConnectorCredentialsArgs
    {
        Http = new Harness.Platform.Inputs.GithubConnectorCredentialsHttpArgs
        {
            Anonymouses = new[]
            {
                null,
            },
            GithubApp = new Harness.Platform.Inputs.GithubConnectorCredentialsHttpGithubAppArgs
            {
                PrivateKeyRef = "string",
                ApplicationId = "string",
                ApplicationIdRef = "string",
                InstallationId = "string",
                InstallationIdRef = "string",
            },
            TokenRef = "string",
            Username = "string",
            UsernameRef = "string",
        },
        Ssh = new Harness.Platform.Inputs.GithubConnectorCredentialsSshArgs
        {
            SshKeyRef = "string",
        },
    },
    Url = "string",
    ForceDelete = false,
    ExecuteOnDelegate = false,
    ApiAuthentication = new Harness.Platform.Inputs.GithubConnectorApiAuthenticationArgs
    {
        GithubApp = new Harness.Platform.Inputs.GithubConnectorApiAuthenticationGithubAppArgs
        {
            PrivateKeyRef = "string",
            ApplicationId = "string",
            ApplicationIdRef = "string",
            InstallationId = "string",
            InstallationIdRef = "string",
        },
        TokenRef = "string",
    },
    Description = "string",
    Name = "string",
    OrgId = "string",
    ProjectId = "string",
    Tags = new[]
    {
        "string",
    },
    DelegateSelectors = new[]
    {
        "string",
    },
    ValidationRepo = "string",
});

    example, err := platform.NewGithubConnector(ctx, "githubConnectorResource", &platform.GithubConnectorArgs{
	Identifier:     pulumi.String("string"),
	ConnectionType: pulumi.String("string"),
	Credentials: &platform.GithubConnectorCredentialsArgs{
		Http: &platform.GithubConnectorCredentialsHttpArgs{
			Anonymouses: platform.GithubConnectorCredentialsHttpAnonymouseArray{
				&platform.GithubConnectorCredentialsHttpAnonymouseArgs{},
			},
			GithubApp: &platform.GithubConnectorCredentialsHttpGithubAppArgs{
				PrivateKeyRef:     pulumi.String("string"),
				ApplicationId:     pulumi.String("string"),
				ApplicationIdRef:  pulumi.String("string"),
				InstallationId:    pulumi.String("string"),
				InstallationIdRef: pulumi.String("string"),
			},
			TokenRef:    pulumi.String("string"),
			Username:    pulumi.String("string"),
			UsernameRef: pulumi.String("string"),
		},
		Ssh: &platform.GithubConnectorCredentialsSshArgs{
			SshKeyRef: pulumi.String("string"),
		},
	},
	Url:               pulumi.String("string"),
	ForceDelete:       pulumi.Bool(false),
	ExecuteOnDelegate: pulumi.Bool(false),
	ApiAuthentication: &platform.GithubConnectorApiAuthenticationArgs{
		GithubApp: &platform.GithubConnectorApiAuthenticationGithubAppArgs{
			PrivateKeyRef:     pulumi.String("string"),
			ApplicationId:     pulumi.String("string"),
			ApplicationIdRef:  pulumi.String("string"),
			InstallationId:    pulumi.String("string"),
			InstallationIdRef: pulumi.String("string"),
		},
		TokenRef: pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	OrgId:       pulumi.String("string"),
	ProjectId:   pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	DelegateSelectors: pulumi.StringArray{
		pulumi.String("string"),
	},
	ValidationRepo: pulumi.String("string"),
})

    var githubConnectorResource = new GithubConnector("githubConnectorResource", GithubConnectorArgs.builder()
    .identifier("string")
    .connectionType("string")
    .credentials(GithubConnectorCredentialsArgs.builder()
        .http(GithubConnectorCredentialsHttpArgs.builder()
            .anonymouses()
            .githubApp(GithubConnectorCredentialsHttpGithubAppArgs.builder()
                .privateKeyRef("string")
                .applicationId("string")
                .applicationIdRef("string")
                .installationId("string")
                .installationIdRef("string")
                .build())
            .tokenRef("string")
            .username("string")
            .usernameRef("string")
            .build())
        .ssh(GithubConnectorCredentialsSshArgs.builder()
            .sshKeyRef("string")
            .build())
        .build())
    .url("string")
    .forceDelete(false)
    .executeOnDelegate(false)
    .apiAuthentication(GithubConnectorApiAuthenticationArgs.builder()
        .githubApp(GithubConnectorApiAuthenticationGithubAppArgs.builder()
            .privateKeyRef("string")
            .applicationId("string")
            .applicationIdRef("string")
            .installationId("string")
            .installationIdRef("string")
            .build())
        .tokenRef("string")
        .build())
    .description("string")
    .name("string")
    .orgId("string")
    .projectId("string")
    .tags("string")
    .delegateSelectors("string")
    .validationRepo("string")
    .build());

    github_connector_resource = harness.platform.GithubConnector("githubConnectorResource",
    identifier="string",
    connection_type="string",
    credentials={
        "http": {
            "anonymouses": [{}],
            "github_app": {
                "private_key_ref": "string",
                "application_id": "string",
                "application_id_ref": "string",
                "installation_id": "string",
                "installation_id_ref": "string",
            },
            "token_ref": "string",
            "username": "string",
            "username_ref": "string",
        },
        "ssh": {
            "ssh_key_ref": "string",
        },
    },
    url="string",
    force_delete=False,
    execute_on_delegate=False,
    api_authentication={
        "github_app": {
            "private_key_ref": "string",
            "application_id": "string",
            "application_id_ref": "string",
            "installation_id": "string",
            "installation_id_ref": "string",
        },
        "token_ref": "string",
    },
    description="string",
    name="string",
    org_id="string",
    project_id="string",
    tags=["string"],
    delegate_selectors=["string"],
    validation_repo="string")

    const githubConnectorResource = new harness.platform.GithubConnector("githubConnectorResource", {
    identifier: "string",
    connectionType: "string",
    credentials: {
        http: {
            anonymouses: [{}],
            githubApp: {
                privateKeyRef: "string",
                applicationId: "string",
                applicationIdRef: "string",
                installationId: "string",
                installationIdRef: "string",
            },
            tokenRef: "string",
            username: "string",
            usernameRef: "string",
        },
        ssh: {
            sshKeyRef: "string",
        },
    },
    url: "string",
    forceDelete: false,
    executeOnDelegate: false,
    apiAuthentication: {
        githubApp: {
            privateKeyRef: "string",
            applicationId: "string",
            applicationIdRef: "string",
            installationId: "string",
            installationIdRef: "string",
        },
        tokenRef: "string",
    },
    description: "string",
    name: "string",
    orgId: "string",
    projectId: "string",
    tags: ["string"],
    delegateSelectors: ["string"],
    validationRepo: "string",
});

    type: harness:platform:GithubConnector
properties:
    apiAuthentication:
        githubApp:
            applicationId: string
            applicationIdRef: string
            installationId: string
            installationIdRef: string
            privateKeyRef: string
        tokenRef: string
    connectionType: string
    credentials:
        http:
            anonymouses:
                - {}
            githubApp:
                applicationId: string
                applicationIdRef: string
                installationId: string
                installationIdRef: string
                privateKeyRef: string
            tokenRef: string
            username: string
            usernameRef: string
        ssh:
            sshKeyRef: string
    delegateSelectors:
        - string
    description: string
    executeOnDelegate: false
    forceDelete: false
    identifier: string
    name: string
    orgId: string
    projectId: string
    tags:
        - string
    url: string
    validationRepo: string

    GithubConnector Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GithubConnector resource accepts the following input properties:

    ConnectionType string
    Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
    Credentials GithubConnectorCredentials
    Credentials to use for the connection.
    Identifier string
    Unique identifier of the resource.
    Url string
    URL of the Githubhub repository or account.
    ApiAuthentication GithubConnectorApiAuthentication
    Configuration for using the github api. API Access is required for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Execute on delegate or not.
    ForceDelete bool
    Enable this flag for force deletion of github connector
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    ValidationRepo string
    Repository to test the connection with. This is only used when connection_type is Account.
    ConnectionType string
    Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
    Credentials GithubConnectorCredentialsArgs
    Credentials to use for the connection.
    Identifier string
    Unique identifier of the resource.
    Url string
    URL of the Githubhub repository or account.
    ApiAuthentication GithubConnectorApiAuthenticationArgs
    Configuration for using the github api. API Access is required for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Execute on delegate or not.
    ForceDelete bool
    Enable this flag for force deletion of github connector
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    ValidationRepo string
    Repository to test the connection with. This is only used when connection_type is Account.
    connectionType String
    Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
    credentials GithubConnectorCredentials
    Credentials to use for the connection.
    identifier String
    Unique identifier of the resource.
    url String
    URL of the Githubhub repository or account.
    apiAuthentication GithubConnectorApiAuthentication
    Configuration for using the github api. API Access is required for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    Execute on delegate or not.
    forceDelete Boolean
    Enable this flag for force deletion of github connector
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    validationRepo String
    Repository to test the connection with. This is only used when connection_type is Account.
    connectionType string
    Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
    credentials GithubConnectorCredentials
    Credentials to use for the connection.
    identifier string
    Unique identifier of the resource.
    url string
    URL of the Githubhub repository or account.
    apiAuthentication GithubConnectorApiAuthentication
    Configuration for using the github api. API Access is required for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    executeOnDelegate boolean
    Execute on delegate or not.
    forceDelete boolean
    Enable this flag for force deletion of github connector
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    validationRepo string
    Repository to test the connection with. This is only used when connection_type is Account.
    connection_type str
    Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
    credentials GithubConnectorCredentialsArgs
    Credentials to use for the connection.
    identifier str
    Unique identifier of the resource.
    url str
    URL of the Githubhub repository or account.
    api_authentication GithubConnectorApiAuthenticationArgs
    Configuration for using the github api. API Access is required for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    execute_on_delegate bool
    Execute on delegate or not.
    force_delete bool
    Enable this flag for force deletion of github connector
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    Tags to associate with the resource.
    validation_repo str
    Repository to test the connection with. This is only used when connection_type is Account.
    connectionType String
    Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
    credentials Property Map
    Credentials to use for the connection.
    identifier String
    Unique identifier of the resource.
    url String
    URL of the Githubhub repository or account.
    apiAuthentication Property Map
    Configuration for using the github api. API Access is required for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    Execute on delegate or not.
    forceDelete Boolean
    Enable this flag for force deletion of github connector
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    validationRepo String
    Repository to test the connection with. This is only used when connection_type is Account.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GithubConnector resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing GithubConnector Resource

    Get an existing GithubConnector resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GithubConnectorState, opts?: CustomResourceOptions): GithubConnector
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_authentication: Optional[GithubConnectorApiAuthenticationArgs] = None,
        connection_type: Optional[str] = None,
        credentials: Optional[GithubConnectorCredentialsArgs] = None,
        delegate_selectors: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        execute_on_delegate: Optional[bool] = None,
        force_delete: Optional[bool] = None,
        identifier: Optional[str] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        project_id: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        url: Optional[str] = None,
        validation_repo: Optional[str] = None) -> GithubConnector
    func GetGithubConnector(ctx *Context, name string, id IDInput, state *GithubConnectorState, opts ...ResourceOption) (*GithubConnector, error)
    public static GithubConnector Get(string name, Input<string> id, GithubConnectorState? state, CustomResourceOptions? opts = null)
    public static GithubConnector get(String name, Output<String> id, GithubConnectorState state, CustomResourceOptions options)
    resources:  _:    type: harness:platform:GithubConnector    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiAuthentication GithubConnectorApiAuthentication
    Configuration for using the github api. API Access is required for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
    ConnectionType string
    Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
    Credentials GithubConnectorCredentials
    Credentials to use for the connection.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Execute on delegate or not.
    ForceDelete bool
    Enable this flag for force deletion of github connector
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    Url string
    URL of the Githubhub repository or account.
    ValidationRepo string
    Repository to test the connection with. This is only used when connection_type is Account.
    ApiAuthentication GithubConnectorApiAuthenticationArgs
    Configuration for using the github api. API Access is required for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
    ConnectionType string
    Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
    Credentials GithubConnectorCredentialsArgs
    Credentials to use for the connection.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Execute on delegate or not.
    ForceDelete bool
    Enable this flag for force deletion of github connector
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    Url string
    URL of the Githubhub repository or account.
    ValidationRepo string
    Repository to test the connection with. This is only used when connection_type is Account.
    apiAuthentication GithubConnectorApiAuthentication
    Configuration for using the github api. API Access is required for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
    connectionType String
    Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
    credentials GithubConnectorCredentials
    Credentials to use for the connection.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    Execute on delegate or not.
    forceDelete Boolean
    Enable this flag for force deletion of github connector
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    url String
    URL of the Githubhub repository or account.
    validationRepo String
    Repository to test the connection with. This is only used when connection_type is Account.
    apiAuthentication GithubConnectorApiAuthentication
    Configuration for using the github api. API Access is required for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
    connectionType string
    Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
    credentials GithubConnectorCredentials
    Credentials to use for the connection.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    executeOnDelegate boolean
    Execute on delegate or not.
    forceDelete boolean
    Enable this flag for force deletion of github connector
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    url string
    URL of the Githubhub repository or account.
    validationRepo string
    Repository to test the connection with. This is only used when connection_type is Account.
    api_authentication GithubConnectorApiAuthenticationArgs
    Configuration for using the github api. API Access is required for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
    connection_type str
    Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
    credentials GithubConnectorCredentialsArgs
    Credentials to use for the connection.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    execute_on_delegate bool
    Execute on delegate or not.
    force_delete bool
    Enable this flag for force deletion of github connector
    identifier str
    Unique identifier of the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    Tags to associate with the resource.
    url str
    URL of the Githubhub repository or account.
    validation_repo str
    Repository to test the connection with. This is only used when connection_type is Account.
    apiAuthentication Property Map
    Configuration for using the github api. API Access is required for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
    connectionType String
    Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
    credentials Property Map
    Credentials to use for the connection.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    Execute on delegate or not.
    forceDelete Boolean
    Enable this flag for force deletion of github connector
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    url String
    URL of the Githubhub repository or account.
    validationRepo String
    Repository to test the connection with. This is only used when connection_type is Account.

    Supporting Types

    GithubConnectorApiAuthentication, GithubConnectorApiAuthenticationArgs

    GithubApp GithubConnectorApiAuthenticationGithubApp
    Configuration for using the github app for interacting with the github api.
    TokenRef string
    Personal access token for interacting with the github api. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    GithubApp GithubConnectorApiAuthenticationGithubApp
    Configuration for using the github app for interacting with the github api.
    TokenRef string
    Personal access token for interacting with the github api. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    githubApp GithubConnectorApiAuthenticationGithubApp
    Configuration for using the github app for interacting with the github api.
    tokenRef String
    Personal access token for interacting with the github api. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    githubApp GithubConnectorApiAuthenticationGithubApp
    Configuration for using the github app for interacting with the github api.
    tokenRef string
    Personal access token for interacting with the github api. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    github_app GithubConnectorApiAuthenticationGithubApp
    Configuration for using the github app for interacting with the github api.
    token_ref str
    Personal access token for interacting with the github api. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    githubApp Property Map
    Configuration for using the github app for interacting with the github api.
    tokenRef String
    Personal access token for interacting with the github api. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    GithubConnectorApiAuthenticationGithubApp, GithubConnectorApiAuthenticationGithubAppArgs

    PrivateKeyRef string
    Reference to the secret containing the private key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    ApplicationId string
    Enter the GitHub App ID from the GitHub App General tab.
    ApplicationIdRef string
    Reference to the secret containing application id To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    InstallationId string
    Enter the Installation ID located in the URL of the installed GitHub App.
    InstallationIdRef string
    Reference to the secret containing installation id. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    PrivateKeyRef string
    Reference to the secret containing the private key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    ApplicationId string
    Enter the GitHub App ID from the GitHub App General tab.
    ApplicationIdRef string
    Reference to the secret containing application id To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    InstallationId string
    Enter the Installation ID located in the URL of the installed GitHub App.
    InstallationIdRef string
    Reference to the secret containing installation id. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    privateKeyRef String
    Reference to the secret containing the private key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    applicationId String
    Enter the GitHub App ID from the GitHub App General tab.
    applicationIdRef String
    Reference to the secret containing application id To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    installationId String
    Enter the Installation ID located in the URL of the installed GitHub App.
    installationIdRef String
    Reference to the secret containing installation id. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    privateKeyRef string
    Reference to the secret containing the private key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    applicationId string
    Enter the GitHub App ID from the GitHub App General tab.
    applicationIdRef string
    Reference to the secret containing application id To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    installationId string
    Enter the Installation ID located in the URL of the installed GitHub App.
    installationIdRef string
    Reference to the secret containing installation id. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    private_key_ref str
    Reference to the secret containing the private key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    application_id str
    Enter the GitHub App ID from the GitHub App General tab.
    application_id_ref str
    Reference to the secret containing application id To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    installation_id str
    Enter the Installation ID located in the URL of the installed GitHub App.
    installation_id_ref str
    Reference to the secret containing installation id. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    privateKeyRef String
    Reference to the secret containing the private key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    applicationId String
    Enter the GitHub App ID from the GitHub App General tab.
    applicationIdRef String
    Reference to the secret containing application id To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    installationId String
    Enter the Installation ID located in the URL of the installed GitHub App.
    installationIdRef String
    Reference to the secret containing installation id. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    GithubConnectorCredentials, GithubConnectorCredentialsArgs

    Http GithubConnectorCredentialsHttp
    Authenticate using Username and password over http(s) for the connection.
    Ssh GithubConnectorCredentialsSsh
    Authenticate using SSH for the connection.
    Http GithubConnectorCredentialsHttp
    Authenticate using Username and password over http(s) for the connection.
    Ssh GithubConnectorCredentialsSsh
    Authenticate using SSH for the connection.
    http GithubConnectorCredentialsHttp
    Authenticate using Username and password over http(s) for the connection.
    ssh GithubConnectorCredentialsSsh
    Authenticate using SSH for the connection.
    http GithubConnectorCredentialsHttp
    Authenticate using Username and password over http(s) for the connection.
    ssh GithubConnectorCredentialsSsh
    Authenticate using SSH for the connection.
    http GithubConnectorCredentialsHttp
    Authenticate using Username and password over http(s) for the connection.
    ssh GithubConnectorCredentialsSsh
    Authenticate using SSH for the connection.
    http Property Map
    Authenticate using Username and password over http(s) for the connection.
    ssh Property Map
    Authenticate using SSH for the connection.

    GithubConnectorCredentialsHttp, GithubConnectorCredentialsHttpArgs

    Anonymouses List<GithubConnectorCredentialsHttpAnonymouse>
    Configuration for using the http anonymous github for interacting with the github api.
    GithubApp GithubConnectorCredentialsHttpGithubApp
    Configuration for using the github app for interacting with the github api.
    TokenRef string
    Reference to a secret containing the personal access to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    Username string
    Username to use for authentication.
    UsernameRef string
    Reference to a secret containing the username to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    Anonymouses []GithubConnectorCredentialsHttpAnonymouse
    Configuration for using the http anonymous github for interacting with the github api.
    GithubApp GithubConnectorCredentialsHttpGithubApp
    Configuration for using the github app for interacting with the github api.
    TokenRef string
    Reference to a secret containing the personal access to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    Username string
    Username to use for authentication.
    UsernameRef string
    Reference to a secret containing the username to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    anonymouses List<GithubConnectorCredentialsHttpAnonymouse>
    Configuration for using the http anonymous github for interacting with the github api.
    githubApp GithubConnectorCredentialsHttpGithubApp
    Configuration for using the github app for interacting with the github api.
    tokenRef String
    Reference to a secret containing the personal access to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    username String
    Username to use for authentication.
    usernameRef String
    Reference to a secret containing the username to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    anonymouses GithubConnectorCredentialsHttpAnonymouse[]
    Configuration for using the http anonymous github for interacting with the github api.
    githubApp GithubConnectorCredentialsHttpGithubApp
    Configuration for using the github app for interacting with the github api.
    tokenRef string
    Reference to a secret containing the personal access to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    username string
    Username to use for authentication.
    usernameRef string
    Reference to a secret containing the username to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    anonymouses Sequence[GithubConnectorCredentialsHttpAnonymouse]
    Configuration for using the http anonymous github for interacting with the github api.
    github_app GithubConnectorCredentialsHttpGithubApp
    Configuration for using the github app for interacting with the github api.
    token_ref str
    Reference to a secret containing the personal access to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    username str
    Username to use for authentication.
    username_ref str
    Reference to a secret containing the username to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    anonymouses List<Property Map>
    Configuration for using the http anonymous github for interacting with the github api.
    githubApp Property Map
    Configuration for using the github app for interacting with the github api.
    tokenRef String
    Reference to a secret containing the personal access to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    username String
    Username to use for authentication.
    usernameRef String
    Reference to a secret containing the username to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    GithubConnectorCredentialsHttpGithubApp, GithubConnectorCredentialsHttpGithubAppArgs

    PrivateKeyRef string
    Reference to the secret containing the private key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    ApplicationId string
    Enter the GitHub App ID from the GitHub App General tab.
    ApplicationIdRef string
    Reference to the secret containing application id To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    InstallationId string
    Enter the Installation ID located in the URL of the installed GitHub App.
    InstallationIdRef string
    Reference to the secret containing installation id. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    PrivateKeyRef string
    Reference to the secret containing the private key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    ApplicationId string
    Enter the GitHub App ID from the GitHub App General tab.
    ApplicationIdRef string
    Reference to the secret containing application id To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    InstallationId string
    Enter the Installation ID located in the URL of the installed GitHub App.
    InstallationIdRef string
    Reference to the secret containing installation id. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    privateKeyRef String
    Reference to the secret containing the private key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    applicationId String
    Enter the GitHub App ID from the GitHub App General tab.
    applicationIdRef String
    Reference to the secret containing application id To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    installationId String
    Enter the Installation ID located in the URL of the installed GitHub App.
    installationIdRef String
    Reference to the secret containing installation id. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    privateKeyRef string
    Reference to the secret containing the private key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    applicationId string
    Enter the GitHub App ID from the GitHub App General tab.
    applicationIdRef string
    Reference to the secret containing application id To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    installationId string
    Enter the Installation ID located in the URL of the installed GitHub App.
    installationIdRef string
    Reference to the secret containing installation id. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    private_key_ref str
    Reference to the secret containing the private key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    application_id str
    Enter the GitHub App ID from the GitHub App General tab.
    application_id_ref str
    Reference to the secret containing application id To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    installation_id str
    Enter the Installation ID located in the URL of the installed GitHub App.
    installation_id_ref str
    Reference to the secret containing installation id. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    privateKeyRef String
    Reference to the secret containing the private key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    applicationId String
    Enter the GitHub App ID from the GitHub App General tab.
    applicationIdRef String
    Reference to the secret containing application id To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    installationId String
    Enter the Installation ID located in the URL of the installed GitHub App.
    installationIdRef String
    Reference to the secret containing installation id. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    GithubConnectorCredentialsSsh, GithubConnectorCredentialsSshArgs

    SshKeyRef string
    Reference to the Harness secret containing the ssh key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    SshKeyRef string
    Reference to the Harness secret containing the ssh key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    sshKeyRef String
    Reference to the Harness secret containing the ssh key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    sshKeyRef string
    Reference to the Harness secret containing the ssh key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    ssh_key_ref str
    Reference to the Harness secret containing the ssh key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    sshKeyRef String
    Reference to the Harness secret containing the ssh key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    Import

    Import account level github connector

    $ pulumi import harness:platform/githubConnector:GithubConnector example <connector_id>

    Import org level github connector

    $ pulumi import harness:platform/githubConnector:GithubConnector example <ord_id>/<connector_id>

    Import project level github connector

    $ pulumi import harness:platform/githubConnector:GithubConnector example <org_id>/<project_id>/<connector_id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.5.7 published on Saturday, Mar 8, 2025 by Pulumi
    pulumi/pulumi-harness