getOrganization

Use this data source to retrieve basic information about a GitHub Organization.

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")
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 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
})
}
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

Return

A collection of values returned by getOrganization.

Parameters

argument

A collection of arguments for invoking getOrganization.


suspend fun getOrganization(ignoreArchivedRepos: Boolean? = null, name: String, summaryOnly: Boolean? = null): GetOrganizationResult

Return

A collection of values returned by getOrganization.

Parameters

ignoreArchivedRepos

Whether or not to include archived repos in the repositories list. Defaults to false.

name

The name of the organization.

summaryOnly

Exclude the repos, members and other attributes from the returned result. Defaults to false.

See also


Return

A collection of values returned by getOrganization.

Parameters

argument

Builder for com.pulumi.github.kotlin.inputs.GetOrganizationPlainArgs.

See also