1. Packages
  2. Rancher2 Provider
  3. API Docs
  4. AuthConfigGithubapp
Rancher 2 v11.0.0 published on Wednesday, Dec 24, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-rancher2

rancher2.AuthConfigGithubapp

rancher2 logo
Rancher 2 v11.0.0 published on Wednesday, Dec 24, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-rancher2

    Create AuthConfigGithubapp Resource

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

    Constructor syntax

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

@overload
def AuthConfigGithubapp(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        app_id: Optional[str] = None,
                        client_id: Optional[str] = None,
                        client_secret: Optional[str] = None,
                        private_key: Optional[str] = None,
                        access_mode: Optional[str] = None,
                        allowed_principal_ids: Optional[Sequence[str]] = None,
                        annotations: Optional[Mapping[str, str]] = None,
                        enabled: Optional[bool] = None,
                        hostname: Optional[str] = None,
                        installation_id: Optional[str] = None,
                        labels: Optional[Mapping[str, str]] = None,
                        tls: Optional[bool] = None)
    func NewAuthConfigGithubapp(ctx *Context, name string, args AuthConfigGithubappArgs, opts ...ResourceOption) (*AuthConfigGithubapp, error)
    public AuthConfigGithubapp(string name, AuthConfigGithubappArgs args, CustomResourceOptions? opts = null)
    public AuthConfigGithubapp(String name, AuthConfigGithubappArgs args)
public AuthConfigGithubapp(String name, AuthConfigGithubappArgs args, CustomResourceOptions options)

    type: rancher2:AuthConfigGithubapp
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 AuthConfigGithubappArgs
    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 AuthConfigGithubappArgs
    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 AuthConfigGithubappArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthConfigGithubappArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthConfigGithubappArgs
    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 authConfigGithubappResource = new Rancher2.AuthConfigGithubapp("authConfigGithubappResource", new()
{
    AppId = "string",
    ClientId = "string",
    ClientSecret = "string",
    PrivateKey = "string",
    AccessMode = "string",
    AllowedPrincipalIds = new[]
    {
        "string",
    },
    Annotations = 
    {
        { "string", "string" },
    },
    Enabled = false,
    Hostname = "string",
    InstallationId = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Tls = false,
});

    example, err := rancher2.NewAuthConfigGithubapp(ctx, "authConfigGithubappResource", &rancher2.AuthConfigGithubappArgs{
	AppId:        pulumi.String("string"),
	ClientId:     pulumi.String("string"),
	ClientSecret: pulumi.String("string"),
	PrivateKey:   pulumi.String("string"),
	AccessMode:   pulumi.String("string"),
	AllowedPrincipalIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Enabled:        pulumi.Bool(false),
	Hostname:       pulumi.String("string"),
	InstallationId: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Tls: pulumi.Bool(false),
})

    var authConfigGithubappResource = new AuthConfigGithubapp("authConfigGithubappResource", AuthConfigGithubappArgs.builder()
    .appId("string")
    .clientId("string")
    .clientSecret("string")
    .privateKey("string")
    .accessMode("string")
    .allowedPrincipalIds("string")
    .annotations(Map.of("string", "string"))
    .enabled(false)
    .hostname("string")
    .installationId("string")
    .labels(Map.of("string", "string"))
    .tls(false)
    .build());

    auth_config_githubapp_resource = rancher2.AuthConfigGithubapp("authConfigGithubappResource",
    app_id="string",
    client_id="string",
    client_secret="string",
    private_key="string",
    access_mode="string",
    allowed_principal_ids=["string"],
    annotations={
        "string": "string",
    },
    enabled=False,
    hostname="string",
    installation_id="string",
    labels={
        "string": "string",
    },
    tls=False)

    const authConfigGithubappResource = new rancher2.AuthConfigGithubapp("authConfigGithubappResource", {
    appId: "string",
    clientId: "string",
    clientSecret: "string",
    privateKey: "string",
    accessMode: "string",
    allowedPrincipalIds: ["string"],
    annotations: {
        string: "string",
    },
    enabled: false,
    hostname: "string",
    installationId: "string",
    labels: {
        string: "string",
    },
    tls: false,
});

    type: rancher2:AuthConfigGithubapp
properties:
    accessMode: string
    allowedPrincipalIds:
        - string
    annotations:
        string: string
    appId: string
    clientId: string
    clientSecret: string
    enabled: false
    hostname: string
    installationId: string
    labels:
        string: string
    privateKey: string
    tls: false

    AuthConfigGithubapp 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 AuthConfigGithubapp resource accepts the following input properties:

    AppId string
    The GitHub App ID is provided on the GitHub apps page.
    ClientId string
    ClientSecret string
    PrivateKey string
    PEM format private key for signing requests.
    AccessMode string
    AllowedPrincipalIds List<string>
    Annotations Dictionary<string, string>
    Annotations of the resource
    Enabled bool
    Hostname string
    InstallationId string
    If the Installation ID is not provided, all installations for the App will be queried.
    Labels Dictionary<string, string>
    Labels of the resource
    Tls bool
    AppId string
    The GitHub App ID is provided on the GitHub apps page.
    ClientId string
    ClientSecret string
    PrivateKey string
    PEM format private key for signing requests.
    AccessMode string
    AllowedPrincipalIds []string
    Annotations map[string]string
    Annotations of the resource
    Enabled bool
    Hostname string
    InstallationId string
    If the Installation ID is not provided, all installations for the App will be queried.
    Labels map[string]string
    Labels of the resource
    Tls bool
    appId String
    The GitHub App ID is provided on the GitHub apps page.
    clientId String
    clientSecret String
    privateKey String
    PEM format private key for signing requests.
    accessMode String
    allowedPrincipalIds List<String>
    annotations Map<String,String>
    Annotations of the resource
    enabled Boolean
    hostname String
    installationId String
    If the Installation ID is not provided, all installations for the App will be queried.
    labels Map<String,String>
    Labels of the resource
    tls Boolean
    appId string
    The GitHub App ID is provided on the GitHub apps page.
    clientId string
    clientSecret string
    privateKey string
    PEM format private key for signing requests.
    accessMode string
    allowedPrincipalIds string[]
    annotations {[key: string]: string}
    Annotations of the resource
    enabled boolean
    hostname string
    installationId string
    If the Installation ID is not provided, all installations for the App will be queried.
    labels {[key: string]: string}
    Labels of the resource
    tls boolean
    app_id str
    The GitHub App ID is provided on the GitHub apps page.
    client_id str
    client_secret str
    private_key str
    PEM format private key for signing requests.
    access_mode str
    allowed_principal_ids Sequence[str]
    annotations Mapping[str, str]
    Annotations of the resource
    enabled bool
    hostname str
    installation_id str
    If the Installation ID is not provided, all installations for the App will be queried.
    labels Mapping[str, str]
    Labels of the resource
    tls bool
    appId String
    The GitHub App ID is provided on the GitHub apps page.
    clientId String
    clientSecret String
    privateKey String
    PEM format private key for signing requests.
    accessMode String
    allowedPrincipalIds List<String>
    annotations Map<String>
    Annotations of the resource
    enabled Boolean
    hostname String
    installationId String
    If the Installation ID is not provided, all installations for the App will be queried.
    labels Map<String>
    Labels of the resource
    tls Boolean

    Outputs

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

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

    Look up Existing AuthConfigGithubapp Resource

    Get an existing AuthConfigGithubapp 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?: AuthConfigGithubappState, opts?: CustomResourceOptions): AuthConfigGithubapp
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_mode: Optional[str] = None,
        allowed_principal_ids: Optional[Sequence[str]] = None,
        annotations: Optional[Mapping[str, str]] = None,
        app_id: Optional[str] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        enabled: Optional[bool] = None,
        hostname: Optional[str] = None,
        installation_id: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        private_key: Optional[str] = None,
        tls: Optional[bool] = None,
        type: Optional[str] = None) -> AuthConfigGithubapp
    func GetAuthConfigGithubapp(ctx *Context, name string, id IDInput, state *AuthConfigGithubappState, opts ...ResourceOption) (*AuthConfigGithubapp, error)
    public static AuthConfigGithubapp Get(string name, Input<string> id, AuthConfigGithubappState? state, CustomResourceOptions? opts = null)
    public static AuthConfigGithubapp get(String name, Output<String> id, AuthConfigGithubappState state, CustomResourceOptions options)
    resources:  _:    type: rancher2:AuthConfigGithubapp    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:
    AccessMode string
    AllowedPrincipalIds List<string>
    Annotations Dictionary<string, string>
    Annotations of the resource
    AppId string
    The GitHub App ID is provided on the GitHub apps page.
    ClientId string
    ClientSecret string
    Enabled bool
    Hostname string
    InstallationId string
    If the Installation ID is not provided, all installations for the App will be queried.
    Labels Dictionary<string, string>
    Labels of the resource
    Name string
    PrivateKey string
    PEM format private key for signing requests.
    Tls bool
    Type string
    AccessMode string
    AllowedPrincipalIds []string
    Annotations map[string]string
    Annotations of the resource
    AppId string
    The GitHub App ID is provided on the GitHub apps page.
    ClientId string
    ClientSecret string
    Enabled bool
    Hostname string
    InstallationId string
    If the Installation ID is not provided, all installations for the App will be queried.
    Labels map[string]string
    Labels of the resource
    Name string
    PrivateKey string
    PEM format private key for signing requests.
    Tls bool
    Type string
    accessMode String
    allowedPrincipalIds List<String>
    annotations Map<String,String>
    Annotations of the resource
    appId String
    The GitHub App ID is provided on the GitHub apps page.
    clientId String
    clientSecret String
    enabled Boolean
    hostname String
    installationId String
    If the Installation ID is not provided, all installations for the App will be queried.
    labels Map<String,String>
    Labels of the resource
    name String
    privateKey String
    PEM format private key for signing requests.
    tls Boolean
    type String
    accessMode string
    allowedPrincipalIds string[]
    annotations {[key: string]: string}
    Annotations of the resource
    appId string
    The GitHub App ID is provided on the GitHub apps page.
    clientId string
    clientSecret string
    enabled boolean
    hostname string
    installationId string
    If the Installation ID is not provided, all installations for the App will be queried.
    labels {[key: string]: string}
    Labels of the resource
    name string
    privateKey string
    PEM format private key for signing requests.
    tls boolean
    type string
    access_mode str
    allowed_principal_ids Sequence[str]
    annotations Mapping[str, str]
    Annotations of the resource
    app_id str
    The GitHub App ID is provided on the GitHub apps page.
    client_id str
    client_secret str
    enabled bool
    hostname str
    installation_id str
    If the Installation ID is not provided, all installations for the App will be queried.
    labels Mapping[str, str]
    Labels of the resource
    name str
    private_key str
    PEM format private key for signing requests.
    tls bool
    type str
    accessMode String
    allowedPrincipalIds List<String>
    annotations Map<String>
    Annotations of the resource
    appId String
    The GitHub App ID is provided on the GitHub apps page.
    clientId String
    clientSecret String
    enabled Boolean
    hostname String
    installationId String
    If the Installation ID is not provided, all installations for the App will be queried.
    labels Map<String>
    Labels of the resource
    name String
    privateKey String
    PEM format private key for signing requests.
    tls Boolean
    type String

    Package Details

    Repository
    Rancher2 pulumi/pulumi-rancher2
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rancher2 Terraform Provider.
    rancher2 logo
    Rancher 2 v11.0.0 published on Wednesday, Dec 24, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-rancher2
      Meet Neo: Your AI Platform Teammate