getOrganization

GitHub v6.12.1, Feb 12 26

Viewing docs for GitHub v6.12.1
published on Thursday, Feb 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-github

Viewing docs for GitHub v6.12.1
published on Thursday, Feb 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-github

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";

const example = github.getOrganization({
    name: "github",
});

import pulumi
import pulumi_github as github

example = github.get_organization(name="github")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := github.GetOrganization(ctx, &github.GetOrganizationArgs{
			Name: "github",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Github.GetOrganization.Invoke(new()
    {
        Name = "github",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.GithubFunctions;
import com.pulumi.github.inputs.GetOrganizationArgs;
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 example = GithubFunctions.getOrganization(GetOrganizationArgs.builder()
            .name("github")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: github:getOrganization
      arguments:
        name: github

Using getOrganization

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 getOrganization(args: GetOrganizationArgs, opts?: InvokeOptions): Promise<GetOrganizationResult>
function getOrganizationOutput(args: GetOrganizationOutputArgs, opts?: InvokeOptions): Output<GetOrganizationResult>

def get_organization(ignore_archived_repos: Optional[bool] = None,
                     name: Optional[str] = None,
                     summary_only: Optional[bool] = None,
                     opts: Optional[InvokeOptions] = None) -> GetOrganizationResult
def get_organization_output(ignore_archived_repos: Optional[pulumi.Input[bool]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     summary_only: Optional[pulumi.Input[bool]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationResult]

func GetOrganization(ctx *Context, args *GetOrganizationArgs, opts ...InvokeOption) (*GetOrganizationResult, error)
func GetOrganizationOutput(ctx *Context, args *GetOrganizationOutputArgs, opts ...InvokeOption) GetOrganizationResultOutput

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

public static class GetOrganization 
{
    public static Task<GetOrganizationResult> InvokeAsync(GetOrganizationArgs args, InvokeOptions? opts = null)
    public static Output<GetOrganizationResult> Invoke(GetOrganizationInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOrganizationResult> getOrganization(GetOrganizationArgs args, InvokeOptions options)
public static Output<GetOrganizationResult> getOrganization(GetOrganizationArgs args, InvokeOptions options)

fn::invoke:
  function: github:index/getOrganization:getOrganization
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of the organization.
IgnoreArchivedRepos bool: Whether or not to include archived repos in the repositories list. Defaults to false.
SummaryOnly bool: Exclude the repos, members and other attributes from the returned result. Defaults to false.

Name string: The name of the organization.
IgnoreArchivedRepos bool: Whether or not to include archived repos in the repositories list. Defaults to false.
SummaryOnly bool: Exclude the repos, members and other attributes from the returned result. Defaults to false.

name String: The name of the organization.
ignoreArchivedRepos Boolean: Whether or not to include archived repos in the repositories list. Defaults to false.
summaryOnly Boolean: Exclude the repos, members and other attributes from the returned result. Defaults to false.

name string: The name of the organization.
ignoreArchivedRepos boolean: Whether or not to include archived repos in the repositories list. Defaults to false.
summaryOnly boolean: Exclude the repos, members and other attributes from the returned result. Defaults to false.

name str: The name of the organization.
ignore_archived_repos bool: Whether or not to include archived repos in the repositories list. Defaults to false.
summary_only bool: Exclude the repos, members and other attributes from the returned result. Defaults to false.

name String: The name of the organization.
ignoreArchivedRepos Boolean: Whether or not to include archived repos in the repositories list. Defaults to false.
summaryOnly Boolean: Exclude the repos, members and other attributes from the returned result. Defaults to false.