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

zitadel.getIdpGithubEs

Explore with Pulumi AI

zitadel v0.2.0 published on Monday, Mar 24, 2025 by pulumiverse

Datasource representing a GitHub Enterprise IDP on the instance.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var @default = Zitadel.GetIdpGithubEs.Invoke(new()
    {
        Id = "123456789012345678",
    });

});
Copy
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.LookupIdpGithubEs(ctx, &zitadel.LookupIdpGithubEsArgs{
			Id: "123456789012345678",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zitadel.ZitadelFunctions;
import com.pulumi.zitadel.inputs.GetIdpGithubEsArgs;
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) {
        final var default = ZitadelFunctions.getIdpGithubEs(GetIdpGithubEsArgs.builder()
            .id("123456789012345678")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as zitadel from "@pulumi/zitadel";

const default = zitadel.getIdpGithubEs({
    id: "123456789012345678",
});
Copy
import pulumi
import pulumi_zitadel as zitadel

default = zitadel.get_idp_github_es(id="123456789012345678")
Copy
variables:
  default:
    fn::invoke:
      Function: zitadel:getIdpGithubEs
      Arguments:
        id: '123456789012345678'
Copy

Using getIdpGithubEs

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIdpGithubEs(args: GetIdpGithubEsArgs, opts?: InvokeOptions): Promise<GetIdpGithubEsResult>
function getIdpGithubEsOutput(args: GetIdpGithubEsOutputArgs, opts?: InvokeOptions): Output<GetIdpGithubEsResult>
Copy
def get_idp_github_es(id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetIdpGithubEsResult
def get_idp_github_es_output(id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetIdpGithubEsResult]
Copy
func LookupIdpGithubEs(ctx *Context, args *LookupIdpGithubEsArgs, opts ...InvokeOption) (*LookupIdpGithubEsResult, error)
func LookupIdpGithubEsOutput(ctx *Context, args *LookupIdpGithubEsOutputArgs, opts ...InvokeOption) LookupIdpGithubEsResultOutput
Copy

> Note: This function is named LookupIdpGithubEs in the Go SDK.

public static class GetIdpGithubEs 
{
    public static Task<GetIdpGithubEsResult> InvokeAsync(GetIdpGithubEsArgs args, InvokeOptions? opts = null)
    public static Output<GetIdpGithubEsResult> Invoke(GetIdpGithubEsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIdpGithubEsResult> getIdpGithubEs(GetIdpGithubEsArgs args, InvokeOptions options)
public static Output<GetIdpGithubEsResult> getIdpGithubEs(GetIdpGithubEsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: zitadel:index/getIdpGithubEs:getIdpGithubEs
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The ID of this resource.
Id This property is required. string
The ID of this resource.
id This property is required. String
The ID of this resource.
id This property is required. string
The ID of this resource.
id This property is required. str
The ID of this resource.
id This property is required. String
The ID of this resource.

getIdpGithubEs Result

The following output properties are available:

AuthorizationEndpoint string
the providers authorization endpoint
ClientId string
client id generated by the identity provider
ClientSecret string
client secret generated by the identity provider
Id string
The ID of this resource.
IsAutoCreation bool
enabled if a new account in ZITADEL are created automatically on login with an external account
IsAutoUpdate bool
enabled if a the ZITADEL account fields are updated automatically on each login
IsCreationAllowed bool
enabled if users are able to create a new account in ZITADEL when using an external account
IsLinkingAllowed bool
enabled if users are 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
TokenEndpoint string
the providers token endpoint
UserEndpoint string
the providers user endpoint
AuthorizationEndpoint string
the providers authorization endpoint
ClientId string
client id generated by the identity provider
ClientSecret string
client secret generated by the identity provider
Id string
The ID of this resource.
IsAutoCreation bool
enabled if a new account in ZITADEL are created automatically on login with an external account
IsAutoUpdate bool
enabled if a the ZITADEL account fields are updated automatically on each login
IsCreationAllowed bool
enabled if users are able to create a new account in ZITADEL when using an external account
IsLinkingAllowed bool
enabled if users are 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
TokenEndpoint string
the providers token endpoint
UserEndpoint string
the providers user endpoint
authorizationEndpoint String
the providers authorization endpoint
clientId String
client id generated by the identity provider
clientSecret String
client secret generated by the identity provider
id String
The ID of this resource.
isAutoCreation Boolean
enabled if a new account in ZITADEL are created automatically on login with an external account
isAutoUpdate Boolean
enabled if a the ZITADEL account fields are updated automatically on each login
isCreationAllowed Boolean
enabled if users are able to create a new account in ZITADEL when using an external account
isLinkingAllowed Boolean
enabled if users are 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
tokenEndpoint String
the providers token endpoint
userEndpoint String
the providers user endpoint
authorizationEndpoint string
the providers authorization endpoint
clientId string
client id generated by the identity provider
clientSecret string
client secret generated by the identity provider
id string
The ID of this resource.
isAutoCreation boolean
enabled if a new account in ZITADEL are created automatically on login with an external account
isAutoUpdate boolean
enabled if a the ZITADEL account fields are updated automatically on each login
isCreationAllowed boolean
enabled if users are able to create a new account in ZITADEL when using an external account
isLinkingAllowed boolean
enabled if users are 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
tokenEndpoint string
the providers token endpoint
userEndpoint string
the providers user endpoint
authorization_endpoint str
the providers authorization endpoint
client_id str
client id generated by the identity provider
client_secret str
client secret generated by the identity provider
id str
The ID of this resource.
is_auto_creation bool
enabled if a new account in ZITADEL are created automatically on login with an external account
is_auto_update bool
enabled if a the ZITADEL account fields are updated automatically on each login
is_creation_allowed bool
enabled if users are able to create a new account in ZITADEL when using an external account
is_linking_allowed bool
enabled if users are 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
token_endpoint str
the providers token endpoint
user_endpoint str
the providers user endpoint
authorizationEndpoint String
the providers authorization endpoint
clientId String
client id generated by the identity provider
clientSecret String
client secret generated by the identity provider
id String
The ID of this resource.
isAutoCreation Boolean
enabled if a new account in ZITADEL are created automatically on login with an external account
isAutoUpdate Boolean
enabled if a the ZITADEL account fields are updated automatically on each login
isCreationAllowed Boolean
enabled if users are able to create a new account in ZITADEL when using an external account
isLinkingAllowed Boolean
enabled if users are 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
tokenEndpoint String
the providers token endpoint
userEndpoint String
the providers user endpoint

Package Details

Repository
zitadel pulumiverse/pulumi-zitadel
License
Apache-2.0
Notes
This Pulumi package is based on the zitadel Terraform Provider.
zitadel v0.2.0 published on Monday, Mar 24, 2025 by pulumiverse