1. Packages
  2. Zitadel
  3. API Docs
  4. IdpGithub
zitadel v0.2.0 published on Monday, Mar 24, 2025 by pulumiverse
pulumiverse/pulumi-zitadel

zitadel.IdpGithub

Get Started
zitadel logo
zitadel v0.2.0 published on Monday, Mar 24, 2025 by pulumiverse
pulumiverse/pulumi-zitadel

    Resource representing a GitHub IDP on the instance.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zitadel = Pulumiverse.Zitadel;

return await Deployment.RunAsync(() => 
{
    var @default = new Zitadel.IdpGithub("default", new()
    {
        Name = "GitHub",
        ClientId = "86a165...",
        ClientSecret = "*****afdbac18",
        Scopes = new[]
        {
            "openid",
            "profile",
            "email",
        },
        IsLinkingAllowed = false,
        IsCreationAllowed = true,
        IsAutoCreation = false,
        IsAutoUpdate = true,
    });

});

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-zitadel/sdk/go/zitadel"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zitadel.NewIdpGithub(ctx, "default", &zitadel.IdpGithubArgs{
			Name:         pulumi.String("GitHub"),
			ClientId:     pulumi.String("86a165..."),
			ClientSecret: pulumi.String("*****afdbac18"),
			Scopes: pulumi.StringArray{
				pulumi.String("openid"),
				pulumi.String("profile"),
				pulumi.String("email"),
			},
			IsLinkingAllowed:  pulumi.Bool(false),
			IsCreationAllowed: pulumi.Bool(true),
			IsAutoCreation:    pulumi.Bool(false),
			IsAutoUpdate:      pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zitadel.IdpGithub;
import com.pulumi.zitadel.IdpGithubArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new IdpGithub("default", IdpGithubArgs.builder()        
            .name("GitHub")
            .clientId("86a165...")
            .clientSecret("*****afdbac18")
            .scopes(            
                "openid",
                "profile",
                "email")
            .isLinkingAllowed(false)
            .isCreationAllowed(true)
            .isAutoCreation(false)
            .isAutoUpdate(true)
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as zitadel from "@pulumiverse/zitadel";

const _default = new zitadel.IdpGithub("default", {
    name: "GitHub",
    clientId: "86a165...",
    clientSecret: "*****afdbac18",
    scopes: [
        "openid",
        "profile",
        "email",
    ],
    isLinkingAllowed: false,
    isCreationAllowed: true,
    isAutoCreation: false,
    isAutoUpdate: true,
});

    import pulumi
import pulumiverse_zitadel as zitadel

default = zitadel.IdpGithub("default",
    name="GitHub",
    client_id="86a165...",
    client_secret="*****afdbac18",
    scopes=[
        "openid",
        "profile",
        "email",
    ],
    is_linking_allowed=False,
    is_creation_allowed=True,
    is_auto_creation=False,
    is_auto_update=True)

    resources:
  default:
    type: zitadel:IdpGithub
    properties:
      name: GitHub
      clientId: 86a165...
      clientSecret: '*****afdbac18'
      scopes:
        - openid
        - profile
        - email
      isLinkingAllowed: false
      isCreationAllowed: true
      isAutoCreation: false
      isAutoUpdate: true

    Create IdpGithub Resource

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

    Constructor syntax

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

@overload
def IdpGithub(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              client_id: Optional[str] = None,
              client_secret: Optional[str] = None,
              is_auto_creation: Optional[bool] = None,
              is_auto_update: Optional[bool] = None,
              is_creation_allowed: Optional[bool] = None,
              is_linking_allowed: Optional[bool] = None,
              name: Optional[str] = None,
              scopes: Optional[Sequence[str]] = None)
    func NewIdpGithub(ctx *Context, name string, args IdpGithubArgs, opts ...ResourceOption) (*IdpGithub, error)
    public IdpGithub(string name, IdpGithubArgs args, CustomResourceOptions? opts = null)
    public IdpGithub(String name, IdpGithubArgs args)
public IdpGithub(String name, IdpGithubArgs args, CustomResourceOptions options)

    type: zitadel:IdpGithub
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 IdpGithubArgs
    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 IdpGithubArgs
    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 IdpGithubArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdpGithubArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdpGithubArgs
    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 idpGithubResource = new Zitadel.IdpGithub("idpGithubResource", new()
{
    ClientId = "string",
    ClientSecret = "string",
    IsAutoCreation = false,
    IsAutoUpdate = false,
    IsCreationAllowed = false,
    IsLinkingAllowed = false,
    Name = "string",
    Scopes = new[]
    {
        "string",
    },
});

    example, err := zitadel.NewIdpGithub(ctx, "idpGithubResource", &zitadel.IdpGithubArgs{
	ClientId:          pulumi.String("string"),
	ClientSecret:      pulumi.String("string"),
	IsAutoCreation:    pulumi.Bool(false),
	IsAutoUpdate:      pulumi.Bool(false),
	IsCreationAllowed: pulumi.Bool(false),
	IsLinkingAllowed:  pulumi.Bool(false),
	Name:              pulumi.String("string"),
	Scopes: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var idpGithubResource = new IdpGithub("idpGithubResource", IdpGithubArgs.builder()
    .clientId("string")
    .clientSecret("string")
    .isAutoCreation(false)
    .isAutoUpdate(false)
    .isCreationAllowed(false)
    .isLinkingAllowed(false)
    .name("string")
    .scopes("string")
    .build());

    idp_github_resource = zitadel.IdpGithub("idpGithubResource",
    client_id="string",
    client_secret="string",
    is_auto_creation=False,
    is_auto_update=False,
    is_creation_allowed=False,
    is_linking_allowed=False,
    name="string",
    scopes=["string"])

    const idpGithubResource = new zitadel.IdpGithub("idpGithubResource", {
    clientId: "string",
    clientSecret: "string",
    isAutoCreation: false,
    isAutoUpdate: false,
    isCreationAllowed: false,
    isLinkingAllowed: false,
    name: "string",
    scopes: ["string"],
});

    type: zitadel:IdpGithub
properties:
    clientId: string
    clientSecret: string
    isAutoCreation: false
    isAutoUpdate: false
    isCreationAllowed: false
    isLinkingAllowed: false
    name: string
    scopes:
        - string

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

    ClientId string
    client id generated by the identity provider
    ClientSecret string
    client secret generated by the identity provider
    IsAutoCreation bool
    enable if a new account in ZITADEL should be created automatically on login with an external account
    IsAutoUpdate bool
    enable if a the ZITADEL account fields should be updated automatically on each login
    IsCreationAllowed bool
    enable if users should be able to create a new account in ZITADEL when using an external account
    IsLinkingAllowed bool
    enable if users should be able to link an existing ZITADEL user with an external account
    Name string
    Name of the IDP
    Scopes List<string>
    the scopes requested by ZITADEL during the request on the identity provider
    ClientId string
    client id generated by the identity provider
    ClientSecret string
    client secret generated by the identity provider
    IsAutoCreation bool
    enable if a new account in ZITADEL should be created automatically on login with an external account
    IsAutoUpdate bool
    enable if a the ZITADEL account fields should be updated automatically on each login
    IsCreationAllowed bool
    enable if users should be able to create a new account in ZITADEL when using an external account
    IsLinkingAllowed bool
    enable if users should be able to link an existing ZITADEL user with an external account
    Name string
    Name of the IDP
    Scopes []string
    the scopes requested by ZITADEL during the request on the identity provider
    clientId String
    client id generated by the identity provider
    clientSecret String
    client secret generated by the identity provider
    isAutoCreation Boolean
    enable if a new account in ZITADEL should be created automatically on login with an external account
    isAutoUpdate Boolean
    enable if a the ZITADEL account fields should be updated automatically on each login
    isCreationAllowed Boolean
    enable if users should be able to create a new account in ZITADEL when using an external account
    isLinkingAllowed Boolean
    enable if users should be able to link an existing ZITADEL user with an external account
    name String
    Name of the IDP
    scopes List<String>
    the scopes requested by ZITADEL during the request on the identity provider
    clientId string
    client id generated by the identity provider
    clientSecret string
    client secret generated by the identity provider
    isAutoCreation boolean
    enable if a new account in ZITADEL should be created automatically on login with an external account
    isAutoUpdate boolean
    enable if a the ZITADEL account fields should be updated automatically on each login
    isCreationAllowed boolean
    enable if users should be able to create a new account in ZITADEL when using an external account
    isLinkingAllowed boolean
    enable if users should be able to link an existing ZITADEL user with an external account
    name string
    Name of the IDP
    scopes string[]
    the scopes requested by ZITADEL during the request on the identity provider
    client_id str
    client id generated by the identity provider
    client_secret str
    client secret generated by the identity provider
    is_auto_creation bool
    enable if a new account in ZITADEL should be created automatically on login with an external account
    is_auto_update bool
    enable if a the ZITADEL account fields should be updated automatically on each login
    is_creation_allowed bool
    enable if users should be able to create a new account in ZITADEL when using an external account
    is_linking_allowed bool
    enable if users should be able to link an existing ZITADEL user with an external account
    name str
    Name of the IDP
    scopes Sequence[str]
    the scopes requested by ZITADEL during the request on the identity provider
    clientId String
    client id generated by the identity provider
    clientSecret String
    client secret generated by the identity provider
    isAutoCreation Boolean
    enable if a new account in ZITADEL should be created automatically on login with an external account
    isAutoUpdate Boolean
    enable if a the ZITADEL account fields should be updated automatically on each login
    isCreationAllowed Boolean
    enable if users should be able to create a new account in ZITADEL when using an external account
    isLinkingAllowed Boolean
    enable if users should be able to link an existing ZITADEL user with an external account
    name String
    Name of the IDP
    scopes List<String>
    the scopes requested by ZITADEL during the request on the identity provider

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IdpGithub 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 IdpGithub Resource

    Get an existing IdpGithub 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?: IdpGithubState, opts?: CustomResourceOptions): IdpGithub
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        is_auto_creation: Optional[bool] = None,
        is_auto_update: Optional[bool] = None,
        is_creation_allowed: Optional[bool] = None,
        is_linking_allowed: Optional[bool] = None,
        name: Optional[str] = None,
        scopes: Optional[Sequence[str]] = None) -> IdpGithub
    func GetIdpGithub(ctx *Context, name string, id IDInput, state *IdpGithubState, opts ...ResourceOption) (*IdpGithub, error)
    public static IdpGithub Get(string name, Input<string> id, IdpGithubState? state, CustomResourceOptions? opts = null)
    public static IdpGithub get(String name, Output<String> id, IdpGithubState state, CustomResourceOptions options)
    resources:  _:    type: zitadel:IdpGithub    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:
    ClientId string
    client id generated by the identity provider
    ClientSecret string
    client secret generated by the identity provider
    IsAutoCreation bool
    enable if a new account in ZITADEL should be created automatically on login with an external account
    IsAutoUpdate bool
    enable if a the ZITADEL account fields should be updated automatically on each login
    IsCreationAllowed bool
    enable if users should be able to create a new account in ZITADEL when using an external account
    IsLinkingAllowed bool
    enable if users should be able to link an existing ZITADEL user with an external account
    Name string
    Name of the IDP
    Scopes List<string>
    the scopes requested by ZITADEL during the request on the identity provider
    ClientId string
    client id generated by the identity provider
    ClientSecret string
    client secret generated by the identity provider
    IsAutoCreation bool
    enable if a new account in ZITADEL should be created automatically on login with an external account
    IsAutoUpdate bool
    enable if a the ZITADEL account fields should be updated automatically on each login
    IsCreationAllowed bool
    enable if users should be able to create a new account in ZITADEL when using an external account
    IsLinkingAllowed bool
    enable if users should be able to link an existing ZITADEL user with an external account
    Name string
    Name of the IDP
    Scopes []string
    the scopes requested by ZITADEL during the request on the identity provider
    clientId String
    client id generated by the identity provider
    clientSecret String
    client secret generated by the identity provider
    isAutoCreation Boolean
    enable if a new account in ZITADEL should be created automatically on login with an external account
    isAutoUpdate Boolean
    enable if a the ZITADEL account fields should be updated automatically on each login
    isCreationAllowed Boolean
    enable if users should be able to create a new account in ZITADEL when using an external account
    isLinkingAllowed Boolean
    enable if users should be able to link an existing ZITADEL user with an external account
    name String
    Name of the IDP
    scopes List<String>
    the scopes requested by ZITADEL during the request on the identity provider
    clientId string
    client id generated by the identity provider
    clientSecret string
    client secret generated by the identity provider
    isAutoCreation boolean
    enable if a new account in ZITADEL should be created automatically on login with an external account
    isAutoUpdate boolean
    enable if a the ZITADEL account fields should be updated automatically on each login
    isCreationAllowed boolean
    enable if users should be able to create a new account in ZITADEL when using an external account
    isLinkingAllowed boolean
    enable if users should be able to link an existing ZITADEL user with an external account
    name string
    Name of the IDP
    scopes string[]
    the scopes requested by ZITADEL during the request on the identity provider
    client_id str
    client id generated by the identity provider
    client_secret str
    client secret generated by the identity provider
    is_auto_creation bool
    enable if a new account in ZITADEL should be created automatically on login with an external account
    is_auto_update bool
    enable if a the ZITADEL account fields should be updated automatically on each login
    is_creation_allowed bool
    enable if users should be able to create a new account in ZITADEL when using an external account
    is_linking_allowed bool
    enable if users should be able to link an existing ZITADEL user with an external account
    name str
    Name of the IDP
    scopes Sequence[str]
    the scopes requested by ZITADEL during the request on the identity provider
    clientId String
    client id generated by the identity provider
    clientSecret String
    client secret generated by the identity provider
    isAutoCreation Boolean
    enable if a new account in ZITADEL should be created automatically on login with an external account
    isAutoUpdate Boolean
    enable if a the ZITADEL account fields should be updated automatically on each login
    isCreationAllowed Boolean
    enable if users should be able to create a new account in ZITADEL when using an external account
    isLinkingAllowed Boolean
    enable if users should be able to link an existing ZITADEL user with an external account
    name String
    Name of the IDP
    scopes List<String>
    the scopes requested by ZITADEL during the request on the identity provider

    Import

    bash The resource can be imported using the ID format <id[:client_secret]>, e.g.

     $ pulumi import zitadel:index/idpGithub:IdpGithub imported '123456789012345678:1234567890123456781234567890123456787890'

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

    Package Details

    Repository
    zitadel pulumiverse/pulumi-zitadel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the zitadel Terraform Provider.
    zitadel logo
    zitadel v0.2.0 published on Monday, Mar 24, 2025 by pulumiverse
    pulumiverse/pulumi-zitadel
      Meet Neo: Your AI Platform Teammate