1. Packages
  2. GitHub
  3. API Docs
  4. OrganizationSettings
GitHub v6.1.0 published on Monday, Mar 11, 2024 by Pulumi

github.OrganizationSettings

Explore with Pulumi AI

github logo
GitHub v6.1.0 published on Monday, Mar 11, 2024 by Pulumi

    This resource allows you to create and manage settings for a GitHub Organization.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as github from "@pulumi/github";
    
    const test = new github.OrganizationSettings("test", {
        advancedSecurityEnabledForNewRepositories: false,
        billingEmail: "test@example.com",
        blog: "https://example.com",
        company: "Test Company",
        defaultRepositoryPermission: "read",
        dependabotAlertsEnabledForNewRepositories: false,
        dependabotSecurityUpdatesEnabledForNewRepositories: false,
        dependencyGraphEnabledForNewRepositories: false,
        description: "Test Description",
        email: "test@example.com",
        hasOrganizationProjects: true,
        hasRepositoryProjects: true,
        location: "Test Location",
        membersCanCreateInternalRepositories: true,
        membersCanCreatePages: true,
        membersCanCreatePrivatePages: true,
        membersCanCreatePrivateRepositories: true,
        membersCanCreatePublicPages: true,
        membersCanCreatePublicRepositories: true,
        membersCanCreateRepositories: true,
        membersCanForkPrivateRepositories: true,
        secretScanningEnabledForNewRepositories: false,
        secretScanningPushProtectionEnabledForNewRepositories: false,
        twitterUsername: "Test",
        webCommitSignoffRequired: true,
    });
    
    import pulumi
    import pulumi_github as github
    
    test = github.OrganizationSettings("test",
        advanced_security_enabled_for_new_repositories=False,
        billing_email="test@example.com",
        blog="https://example.com",
        company="Test Company",
        default_repository_permission="read",
        dependabot_alerts_enabled_for_new_repositories=False,
        dependabot_security_updates_enabled_for_new_repositories=False,
        dependency_graph_enabled_for_new_repositories=False,
        description="Test Description",
        email="test@example.com",
        has_organization_projects=True,
        has_repository_projects=True,
        location="Test Location",
        members_can_create_internal_repositories=True,
        members_can_create_pages=True,
        members_can_create_private_pages=True,
        members_can_create_private_repositories=True,
        members_can_create_public_pages=True,
        members_can_create_public_repositories=True,
        members_can_create_repositories=True,
        members_can_fork_private_repositories=True,
        secret_scanning_enabled_for_new_repositories=False,
        secret_scanning_push_protection_enabled_for_new_repositories=False,
        twitter_username="Test",
        web_commit_signoff_required=True)
    
    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.NewOrganizationSettings(ctx, "test", &github.OrganizationSettingsArgs{
    			AdvancedSecurityEnabledForNewRepositories: pulumi.Bool(false),
    			BillingEmail:                pulumi.String("test@example.com"),
    			Blog:                        pulumi.String("https://example.com"),
    			Company:                     pulumi.String("Test Company"),
    			DefaultRepositoryPermission: pulumi.String("read"),
    			DependabotAlertsEnabledForNewRepositories:             pulumi.Bool(false),
    			DependabotSecurityUpdatesEnabledForNewRepositories:    pulumi.Bool(false),
    			DependencyGraphEnabledForNewRepositories:              pulumi.Bool(false),
    			Description:                                           pulumi.String("Test Description"),
    			Email:                                                 pulumi.String("test@example.com"),
    			HasOrganizationProjects:                               pulumi.Bool(true),
    			HasRepositoryProjects:                                 pulumi.Bool(true),
    			Location:                                              pulumi.String("Test Location"),
    			MembersCanCreateInternalRepositories:                  pulumi.Bool(true),
    			MembersCanCreatePages:                                 pulumi.Bool(true),
    			MembersCanCreatePrivatePages:                          pulumi.Bool(true),
    			MembersCanCreatePrivateRepositories:                   pulumi.Bool(true),
    			MembersCanCreatePublicPages:                           pulumi.Bool(true),
    			MembersCanCreatePublicRepositories:                    pulumi.Bool(true),
    			MembersCanCreateRepositories:                          pulumi.Bool(true),
    			MembersCanForkPrivateRepositories:                     pulumi.Bool(true),
    			SecretScanningEnabledForNewRepositories:               pulumi.Bool(false),
    			SecretScanningPushProtectionEnabledForNewRepositories: pulumi.Bool(false),
    			TwitterUsername:                                       pulumi.String("Test"),
    			WebCommitSignoffRequired:                              pulumi.Bool(true),
    		})
    		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 test = new Github.OrganizationSettings("test", new()
        {
            AdvancedSecurityEnabledForNewRepositories = false,
            BillingEmail = "test@example.com",
            Blog = "https://example.com",
            Company = "Test Company",
            DefaultRepositoryPermission = "read",
            DependabotAlertsEnabledForNewRepositories = false,
            DependabotSecurityUpdatesEnabledForNewRepositories = false,
            DependencyGraphEnabledForNewRepositories = false,
            Description = "Test Description",
            Email = "test@example.com",
            HasOrganizationProjects = true,
            HasRepositoryProjects = true,
            Location = "Test Location",
            MembersCanCreateInternalRepositories = true,
            MembersCanCreatePages = true,
            MembersCanCreatePrivatePages = true,
            MembersCanCreatePrivateRepositories = true,
            MembersCanCreatePublicPages = true,
            MembersCanCreatePublicRepositories = true,
            MembersCanCreateRepositories = true,
            MembersCanForkPrivateRepositories = true,
            SecretScanningEnabledForNewRepositories = false,
            SecretScanningPushProtectionEnabledForNewRepositories = false,
            TwitterUsername = "Test",
            WebCommitSignoffRequired = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.github.OrganizationSettings;
    import com.pulumi.github.OrganizationSettingsArgs;
    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 test = new OrganizationSettings("test", OrganizationSettingsArgs.builder()        
                .advancedSecurityEnabledForNewRepositories(false)
                .billingEmail("test@example.com")
                .blog("https://example.com")
                .company("Test Company")
                .defaultRepositoryPermission("read")
                .dependabotAlertsEnabledForNewRepositories(false)
                .dependabotSecurityUpdatesEnabledForNewRepositories(false)
                .dependencyGraphEnabledForNewRepositories(false)
                .description("Test Description")
                .email("test@example.com")
                .hasOrganizationProjects(true)
                .hasRepositoryProjects(true)
                .location("Test Location")
                .membersCanCreateInternalRepositories(true)
                .membersCanCreatePages(true)
                .membersCanCreatePrivatePages(true)
                .membersCanCreatePrivateRepositories(true)
                .membersCanCreatePublicPages(true)
                .membersCanCreatePublicRepositories(true)
                .membersCanCreateRepositories(true)
                .membersCanForkPrivateRepositories(true)
                .secretScanningEnabledForNewRepositories(false)
                .secretScanningPushProtectionEnabledForNewRepositories(false)
                .twitterUsername("Test")
                .webCommitSignoffRequired(true)
                .build());
    
        }
    }
    
    resources:
      test:
        type: github:OrganizationSettings
        properties:
          advancedSecurityEnabledForNewRepositories: false
          billingEmail: test@example.com
          blog: https://example.com
          company: Test Company
          defaultRepositoryPermission: read
          dependabotAlertsEnabledForNewRepositories: false
          dependabotSecurityUpdatesEnabledForNewRepositories: false
          dependencyGraphEnabledForNewRepositories: false
          description: Test Description
          email: test@example.com
          hasOrganizationProjects: true
          hasRepositoryProjects: true
          location: Test Location
          membersCanCreateInternalRepositories: true
          membersCanCreatePages: true
          membersCanCreatePrivatePages: true
          membersCanCreatePrivateRepositories: true
          membersCanCreatePublicPages: true
          membersCanCreatePublicRepositories: true
          membersCanCreateRepositories: true
          membersCanForkPrivateRepositories: true
          secretScanningEnabledForNewRepositories: false
          secretScanningPushProtectionEnabledForNewRepositories: false
          twitterUsername: Test
          webCommitSignoffRequired: true
    

    Create OrganizationSettings Resource

    new OrganizationSettings(name: string, args: OrganizationSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def OrganizationSettings(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             advanced_security_enabled_for_new_repositories: Optional[bool] = None,
                             billing_email: Optional[str] = None,
                             blog: Optional[str] = None,
                             company: Optional[str] = None,
                             default_repository_permission: Optional[str] = None,
                             dependabot_alerts_enabled_for_new_repositories: Optional[bool] = None,
                             dependabot_security_updates_enabled_for_new_repositories: Optional[bool] = None,
                             dependency_graph_enabled_for_new_repositories: Optional[bool] = None,
                             description: Optional[str] = None,
                             email: Optional[str] = None,
                             has_organization_projects: Optional[bool] = None,
                             has_repository_projects: Optional[bool] = None,
                             location: Optional[str] = None,
                             members_can_create_internal_repositories: Optional[bool] = None,
                             members_can_create_pages: Optional[bool] = None,
                             members_can_create_private_pages: Optional[bool] = None,
                             members_can_create_private_repositories: Optional[bool] = None,
                             members_can_create_public_pages: Optional[bool] = None,
                             members_can_create_public_repositories: Optional[bool] = None,
                             members_can_create_repositories: Optional[bool] = None,
                             members_can_fork_private_repositories: Optional[bool] = None,
                             name: Optional[str] = None,
                             secret_scanning_enabled_for_new_repositories: Optional[bool] = None,
                             secret_scanning_push_protection_enabled_for_new_repositories: Optional[bool] = None,
                             twitter_username: Optional[str] = None,
                             web_commit_signoff_required: Optional[bool] = None)
    @overload
    def OrganizationSettings(resource_name: str,
                             args: OrganizationSettingsArgs,
                             opts: Optional[ResourceOptions] = None)
    func NewOrganizationSettings(ctx *Context, name string, args OrganizationSettingsArgs, opts ...ResourceOption) (*OrganizationSettings, error)
    public OrganizationSettings(string name, OrganizationSettingsArgs args, CustomResourceOptions? opts = null)
    public OrganizationSettings(String name, OrganizationSettingsArgs args)
    public OrganizationSettings(String name, OrganizationSettingsArgs args, CustomResourceOptions options)
    
    type: github:OrganizationSettings
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args OrganizationSettingsArgs
    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 OrganizationSettingsArgs
    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 OrganizationSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationSettingsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    OrganizationSettings Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The OrganizationSettings resource accepts the following input properties:

    BillingEmail string
    The billing email address for the organization.
    AdvancedSecurityEnabledForNewRepositories bool
    Whether or not advanced security is enabled for new repositories. Defaults to false.
    Blog string
    The blog URL for the organization.
    Company string
    The company name for the organization.
    DefaultRepositoryPermission string
    The default permission for organization members to create new repositories. Can be one of read, write, admin, or none. Defaults to read.
    DependabotAlertsEnabledForNewRepositories bool
    Whether or not dependabot alerts are enabled for new repositories. Defaults to false.
    DependabotSecurityUpdatesEnabledForNewRepositories bool
    Whether or not dependabot security updates are enabled for new repositories. Defaults to false.
    DependencyGraphEnabledForNewRepositories bool
    Whether or not dependency graph is enabled for new repositories. Defaults to false.
    Description string
    The description for the organization.
    Email string
    The email address for the organization.
    HasOrganizationProjects bool
    Whether or not organization projects are enabled for the organization.
    HasRepositoryProjects bool
    Whether or not repository projects are enabled for the organization.
    Location string
    The location for the organization.
    MembersCanCreateInternalRepositories bool
    Whether or not organization members can create new internal repositories. For Enterprise Organizations only.
    MembersCanCreatePages bool
    Whether or not organization members can create new pages. Defaults to true.
    MembersCanCreatePrivatePages bool
    Whether or not organization members can create new private pages. Defaults to true.
    MembersCanCreatePrivateRepositories bool
    Whether or not organization members can create new private repositories. Defaults to true.
    MembersCanCreatePublicPages bool
    Whether or not organization members can create new public pages. Defaults to true.
    MembersCanCreatePublicRepositories bool
    Whether or not organization members can create new public repositories. Defaults to true.
    MembersCanCreateRepositories bool
    Whether or not organization members can create new repositories. Defaults to true.
    MembersCanForkPrivateRepositories bool
    Whether or not organization members can fork private repositories. Defaults to false.
    Name string
    The name for the organization.
    SecretScanningEnabledForNewRepositories bool
    Whether or not secret scanning is enabled for new repositories. Defaults to false.
    SecretScanningPushProtectionEnabledForNewRepositories bool
    Whether or not secret scanning push protection is enabled for new repositories. Defaults to false.
    TwitterUsername string
    The Twitter username for the organization.
    WebCommitSignoffRequired bool
    Whether or not commit signatures are required for commits to the organization. Defaults to false.
    BillingEmail string
    The billing email address for the organization.
    AdvancedSecurityEnabledForNewRepositories bool
    Whether or not advanced security is enabled for new repositories. Defaults to false.
    Blog string
    The blog URL for the organization.
    Company string
    The company name for the organization.
    DefaultRepositoryPermission string
    The default permission for organization members to create new repositories. Can be one of read, write, admin, or none. Defaults to read.
    DependabotAlertsEnabledForNewRepositories bool
    Whether or not dependabot alerts are enabled for new repositories. Defaults to false.
    DependabotSecurityUpdatesEnabledForNewRepositories bool
    Whether or not dependabot security updates are enabled for new repositories. Defaults to false.
    DependencyGraphEnabledForNewRepositories bool
    Whether or not dependency graph is enabled for new repositories. Defaults to false.
    Description string
    The description for the organization.
    Email string
    The email address for the organization.
    HasOrganizationProjects bool
    Whether or not organization projects are enabled for the organization.
    HasRepositoryProjects bool
    Whether or not repository projects are enabled for the organization.
    Location string
    The location for the organization.
    MembersCanCreateInternalRepositories bool
    Whether or not organization members can create new internal repositories. For Enterprise Organizations only.
    MembersCanCreatePages bool
    Whether or not organization members can create new pages. Defaults to true.
    MembersCanCreatePrivatePages bool
    Whether or not organization members can create new private pages. Defaults to true.
    MembersCanCreatePrivateRepositories bool
    Whether or not organization members can create new private repositories. Defaults to true.
    MembersCanCreatePublicPages bool
    Whether or not organization members can create new public pages. Defaults to true.
    MembersCanCreatePublicRepositories bool
    Whether or not organization members can create new public repositories. Defaults to true.
    MembersCanCreateRepositories bool
    Whether or not organization members can create new repositories. Defaults to true.
    MembersCanForkPrivateRepositories bool
    Whether or not organization members can fork private repositories. Defaults to false.
    Name string
    The name for the organization.
    SecretScanningEnabledForNewRepositories bool
    Whether or not secret scanning is enabled for new repositories. Defaults to false.
    SecretScanningPushProtectionEnabledForNewRepositories bool
    Whether or not secret scanning push protection is enabled for new repositories. Defaults to false.
    TwitterUsername string
    The Twitter username for the organization.
    WebCommitSignoffRequired bool
    Whether or not commit signatures are required for commits to the organization. Defaults to false.
    billingEmail String
    The billing email address for the organization.
    advancedSecurityEnabledForNewRepositories Boolean
    Whether or not advanced security is enabled for new repositories. Defaults to false.
    blog String
    The blog URL for the organization.
    company String
    The company name for the organization.
    defaultRepositoryPermission String
    The default permission for organization members to create new repositories. Can be one of read, write, admin, or none. Defaults to read.
    dependabotAlertsEnabledForNewRepositories Boolean
    Whether or not dependabot alerts are enabled for new repositories. Defaults to false.
    dependabotSecurityUpdatesEnabledForNewRepositories Boolean
    Whether or not dependabot security updates are enabled for new repositories. Defaults to false.
    dependencyGraphEnabledForNewRepositories Boolean
    Whether or not dependency graph is enabled for new repositories. Defaults to false.
    description String
    The description for the organization.
    email String
    The email address for the organization.
    hasOrganizationProjects Boolean
    Whether or not organization projects are enabled for the organization.
    hasRepositoryProjects Boolean
    Whether or not repository projects are enabled for the organization.
    location String
    The location for the organization.
    membersCanCreateInternalRepositories Boolean
    Whether or not organization members can create new internal repositories. For Enterprise Organizations only.
    membersCanCreatePages Boolean
    Whether or not organization members can create new pages. Defaults to true.
    membersCanCreatePrivatePages Boolean
    Whether or not organization members can create new private pages. Defaults to true.
    membersCanCreatePrivateRepositories Boolean
    Whether or not organization members can create new private repositories. Defaults to true.
    membersCanCreatePublicPages Boolean
    Whether or not organization members can create new public pages. Defaults to true.
    membersCanCreatePublicRepositories Boolean
    Whether or not organization members can create new public repositories. Defaults to true.
    membersCanCreateRepositories Boolean
    Whether or not organization members can create new repositories. Defaults to true.
    membersCanForkPrivateRepositories Boolean
    Whether or not organization members can fork private repositories. Defaults to false.
    name String
    The name for the organization.
    secretScanningEnabledForNewRepositories Boolean
    Whether or not secret scanning is enabled for new repositories. Defaults to false.
    secretScanningPushProtectionEnabledForNewRepositories Boolean
    Whether or not secret scanning push protection is enabled for new repositories. Defaults to false.
    twitterUsername String
    The Twitter username for the organization.
    webCommitSignoffRequired Boolean
    Whether or not commit signatures are required for commits to the organization. Defaults to false.
    billingEmail string
    The billing email address for the organization.
    advancedSecurityEnabledForNewRepositories boolean
    Whether or not advanced security is enabled for new repositories. Defaults to false.
    blog string
    The blog URL for the organization.
    company string
    The company name for the organization.
    defaultRepositoryPermission string
    The default permission for organization members to create new repositories. Can be one of read, write, admin, or none. Defaults to read.
    dependabotAlertsEnabledForNewRepositories boolean
    Whether or not dependabot alerts are enabled for new repositories. Defaults to false.
    dependabotSecurityUpdatesEnabledForNewRepositories boolean
    Whether or not dependabot security updates are enabled for new repositories. Defaults to false.
    dependencyGraphEnabledForNewRepositories boolean
    Whether or not dependency graph is enabled for new repositories. Defaults to false.
    description string
    The description for the organization.
    email string
    The email address for the organization.
    hasOrganizationProjects boolean
    Whether or not organization projects are enabled for the organization.
    hasRepositoryProjects boolean
    Whether or not repository projects are enabled for the organization.
    location string
    The location for the organization.
    membersCanCreateInternalRepositories boolean
    Whether or not organization members can create new internal repositories. For Enterprise Organizations only.
    membersCanCreatePages boolean
    Whether or not organization members can create new pages. Defaults to true.
    membersCanCreatePrivatePages boolean
    Whether or not organization members can create new private pages. Defaults to true.
    membersCanCreatePrivateRepositories boolean
    Whether or not organization members can create new private repositories. Defaults to true.
    membersCanCreatePublicPages boolean
    Whether or not organization members can create new public pages. Defaults to true.
    membersCanCreatePublicRepositories boolean
    Whether or not organization members can create new public repositories. Defaults to true.
    membersCanCreateRepositories boolean
    Whether or not organization members can create new repositories. Defaults to true.
    membersCanForkPrivateRepositories boolean
    Whether or not organization members can fork private repositories. Defaults to false.
    name string
    The name for the organization.
    secretScanningEnabledForNewRepositories boolean
    Whether or not secret scanning is enabled for new repositories. Defaults to false.
    secretScanningPushProtectionEnabledForNewRepositories boolean
    Whether or not secret scanning push protection is enabled for new repositories. Defaults to false.
    twitterUsername string
    The Twitter username for the organization.
    webCommitSignoffRequired boolean
    Whether or not commit signatures are required for commits to the organization. Defaults to false.
    billing_email str
    The billing email address for the organization.
    advanced_security_enabled_for_new_repositories bool
    Whether or not advanced security is enabled for new repositories. Defaults to false.
    blog str
    The blog URL for the organization.
    company str
    The company name for the organization.
    default_repository_permission str
    The default permission for organization members to create new repositories. Can be one of read, write, admin, or none. Defaults to read.
    dependabot_alerts_enabled_for_new_repositories bool
    Whether or not dependabot alerts are enabled for new repositories. Defaults to false.
    dependabot_security_updates_enabled_for_new_repositories bool
    Whether or not dependabot security updates are enabled for new repositories. Defaults to false.
    dependency_graph_enabled_for_new_repositories bool
    Whether or not dependency graph is enabled for new repositories. Defaults to false.
    description str
    The description for the organization.
    email str
    The email address for the organization.
    has_organization_projects bool
    Whether or not organization projects are enabled for the organization.
    has_repository_projects bool
    Whether or not repository projects are enabled for the organization.
    location str
    The location for the organization.
    members_can_create_internal_repositories bool
    Whether or not organization members can create new internal repositories. For Enterprise Organizations only.
    members_can_create_pages bool
    Whether or not organization members can create new pages. Defaults to true.
    members_can_create_private_pages bool
    Whether or not organization members can create new private pages. Defaults to true.
    members_can_create_private_repositories bool
    Whether or not organization members can create new private repositories. Defaults to true.
    members_can_create_public_pages bool
    Whether or not organization members can create new public pages. Defaults to true.
    members_can_create_public_repositories bool
    Whether or not organization members can create new public repositories. Defaults to true.
    members_can_create_repositories bool
    Whether or not organization members can create new repositories. Defaults to true.
    members_can_fork_private_repositories bool
    Whether or not organization members can fork private repositories. Defaults to false.
    name str
    The name for the organization.
    secret_scanning_enabled_for_new_repositories bool
    Whether or not secret scanning is enabled for new repositories. Defaults to false.
    secret_scanning_push_protection_enabled_for_new_repositories bool
    Whether or not secret scanning push protection is enabled for new repositories. Defaults to false.
    twitter_username str
    The Twitter username for the organization.
    web_commit_signoff_required bool
    Whether or not commit signatures are required for commits to the organization. Defaults to false.
    billingEmail String
    The billing email address for the organization.
    advancedSecurityEnabledForNewRepositories Boolean
    Whether or not advanced security is enabled for new repositories. Defaults to false.
    blog String
    The blog URL for the organization.
    company String
    The company name for the organization.
    defaultRepositoryPermission String
    The default permission for organization members to create new repositories. Can be one of read, write, admin, or none. Defaults to read.
    dependabotAlertsEnabledForNewRepositories Boolean
    Whether or not dependabot alerts are enabled for new repositories. Defaults to false.
    dependabotSecurityUpdatesEnabledForNewRepositories Boolean
    Whether or not dependabot security updates are enabled for new repositories. Defaults to false.
    dependencyGraphEnabledForNewRepositories Boolean
    Whether or not dependency graph is enabled for new repositories. Defaults to false.
    description String
    The description for the organization.
    email String
    The email address for the organization.
    hasOrganizationProjects Boolean
    Whether or not organization projects are enabled for the organization.
    hasRepositoryProjects Boolean
    Whether or not repository projects are enabled for the organization.
    location String
    The location for the organization.
    membersCanCreateInternalRepositories Boolean
    Whether or not organization members can create new internal repositories. For Enterprise Organizations only.
    membersCanCreatePages Boolean
    Whether or not organization members can create new pages. Defaults to true.
    membersCanCreatePrivatePages Boolean
    Whether or not organization members can create new private pages. Defaults to true.
    membersCanCreatePrivateRepositories Boolean
    Whether or not organization members can create new private repositories. Defaults to true.
    membersCanCreatePublicPages Boolean
    Whether or not organization members can create new public pages. Defaults to true.
    membersCanCreatePublicRepositories Boolean
    Whether or not organization members can create new public repositories. Defaults to true.
    membersCanCreateRepositories Boolean
    Whether or not organization members can create new repositories. Defaults to true.
    membersCanForkPrivateRepositories Boolean
    Whether or not organization members can fork private repositories. Defaults to false.
    name String
    The name for the organization.
    secretScanningEnabledForNewRepositories Boolean
    Whether or not secret scanning is enabled for new repositories. Defaults to false.
    secretScanningPushProtectionEnabledForNewRepositories Boolean
    Whether or not secret scanning push protection is enabled for new repositories. Defaults to false.
    twitterUsername String
    The Twitter username for the organization.
    webCommitSignoffRequired Boolean
    Whether or not commit signatures are required for commits to the organization. Defaults to false.

    Outputs

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

    Get an existing OrganizationSettings 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?: OrganizationSettingsState, opts?: CustomResourceOptions): OrganizationSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            advanced_security_enabled_for_new_repositories: Optional[bool] = None,
            billing_email: Optional[str] = None,
            blog: Optional[str] = None,
            company: Optional[str] = None,
            default_repository_permission: Optional[str] = None,
            dependabot_alerts_enabled_for_new_repositories: Optional[bool] = None,
            dependabot_security_updates_enabled_for_new_repositories: Optional[bool] = None,
            dependency_graph_enabled_for_new_repositories: Optional[bool] = None,
            description: Optional[str] = None,
            email: Optional[str] = None,
            has_organization_projects: Optional[bool] = None,
            has_repository_projects: Optional[bool] = None,
            location: Optional[str] = None,
            members_can_create_internal_repositories: Optional[bool] = None,
            members_can_create_pages: Optional[bool] = None,
            members_can_create_private_pages: Optional[bool] = None,
            members_can_create_private_repositories: Optional[bool] = None,
            members_can_create_public_pages: Optional[bool] = None,
            members_can_create_public_repositories: Optional[bool] = None,
            members_can_create_repositories: Optional[bool] = None,
            members_can_fork_private_repositories: Optional[bool] = None,
            name: Optional[str] = None,
            secret_scanning_enabled_for_new_repositories: Optional[bool] = None,
            secret_scanning_push_protection_enabled_for_new_repositories: Optional[bool] = None,
            twitter_username: Optional[str] = None,
            web_commit_signoff_required: Optional[bool] = None) -> OrganizationSettings
    func GetOrganizationSettings(ctx *Context, name string, id IDInput, state *OrganizationSettingsState, opts ...ResourceOption) (*OrganizationSettings, error)
    public static OrganizationSettings Get(string name, Input<string> id, OrganizationSettingsState? state, CustomResourceOptions? opts = null)
    public static OrganizationSettings get(String name, Output<String> id, OrganizationSettingsState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AdvancedSecurityEnabledForNewRepositories bool
    Whether or not advanced security is enabled for new repositories. Defaults to false.
    BillingEmail string
    The billing email address for the organization.
    Blog string
    The blog URL for the organization.
    Company string
    The company name for the organization.
    DefaultRepositoryPermission string
    The default permission for organization members to create new repositories. Can be one of read, write, admin, or none. Defaults to read.
    DependabotAlertsEnabledForNewRepositories bool
    Whether or not dependabot alerts are enabled for new repositories. Defaults to false.
    DependabotSecurityUpdatesEnabledForNewRepositories bool
    Whether or not dependabot security updates are enabled for new repositories. Defaults to false.
    DependencyGraphEnabledForNewRepositories bool
    Whether or not dependency graph is enabled for new repositories. Defaults to false.
    Description string
    The description for the organization.
    Email string
    The email address for the organization.
    HasOrganizationProjects bool
    Whether or not organization projects are enabled for the organization.
    HasRepositoryProjects bool
    Whether or not repository projects are enabled for the organization.
    Location string
    The location for the organization.
    MembersCanCreateInternalRepositories bool
    Whether or not organization members can create new internal repositories. For Enterprise Organizations only.
    MembersCanCreatePages bool
    Whether or not organization members can create new pages. Defaults to true.
    MembersCanCreatePrivatePages bool
    Whether or not organization members can create new private pages. Defaults to true.
    MembersCanCreatePrivateRepositories bool
    Whether or not organization members can create new private repositories. Defaults to true.
    MembersCanCreatePublicPages bool
    Whether or not organization members can create new public pages. Defaults to true.
    MembersCanCreatePublicRepositories bool
    Whether or not organization members can create new public repositories. Defaults to true.
    MembersCanCreateRepositories bool
    Whether or not organization members can create new repositories. Defaults to true.
    MembersCanForkPrivateRepositories bool
    Whether or not organization members can fork private repositories. Defaults to false.
    Name string
    The name for the organization.
    SecretScanningEnabledForNewRepositories bool
    Whether or not secret scanning is enabled for new repositories. Defaults to false.
    SecretScanningPushProtectionEnabledForNewRepositories bool
    Whether or not secret scanning push protection is enabled for new repositories. Defaults to false.
    TwitterUsername string
    The Twitter username for the organization.
    WebCommitSignoffRequired bool
    Whether or not commit signatures are required for commits to the organization. Defaults to false.
    AdvancedSecurityEnabledForNewRepositories bool
    Whether or not advanced security is enabled for new repositories. Defaults to false.
    BillingEmail string
    The billing email address for the organization.
    Blog string
    The blog URL for the organization.
    Company string
    The company name for the organization.
    DefaultRepositoryPermission string
    The default permission for organization members to create new repositories. Can be one of read, write, admin, or none. Defaults to read.
    DependabotAlertsEnabledForNewRepositories bool
    Whether or not dependabot alerts are enabled for new repositories. Defaults to false.
    DependabotSecurityUpdatesEnabledForNewRepositories bool
    Whether or not dependabot security updates are enabled for new repositories. Defaults to false.
    DependencyGraphEnabledForNewRepositories bool
    Whether or not dependency graph is enabled for new repositories. Defaults to false.
    Description string
    The description for the organization.
    Email string
    The email address for the organization.
    HasOrganizationProjects bool
    Whether or not organization projects are enabled for the organization.
    HasRepositoryProjects bool
    Whether or not repository projects are enabled for the organization.
    Location string
    The location for the organization.
    MembersCanCreateInternalRepositories bool
    Whether or not organization members can create new internal repositories. For Enterprise Organizations only.
    MembersCanCreatePages bool
    Whether or not organization members can create new pages. Defaults to true.
    MembersCanCreatePrivatePages bool
    Whether or not organization members can create new private pages. Defaults to true.
    MembersCanCreatePrivateRepositories bool
    Whether or not organization members can create new private repositories. Defaults to true.
    MembersCanCreatePublicPages bool
    Whether or not organization members can create new public pages. Defaults to true.
    MembersCanCreatePublicRepositories bool
    Whether or not organization members can create new public repositories. Defaults to true.
    MembersCanCreateRepositories bool
    Whether or not organization members can create new repositories. Defaults to true.
    MembersCanForkPrivateRepositories bool
    Whether or not organization members can fork private repositories. Defaults to false.
    Name string
    The name for the organization.
    SecretScanningEnabledForNewRepositories bool
    Whether or not secret scanning is enabled for new repositories. Defaults to false.
    SecretScanningPushProtectionEnabledForNewRepositories bool
    Whether or not secret scanning push protection is enabled for new repositories. Defaults to false.
    TwitterUsername string
    The Twitter username for the organization.
    WebCommitSignoffRequired bool
    Whether or not commit signatures are required for commits to the organization. Defaults to false.
    advancedSecurityEnabledForNewRepositories Boolean
    Whether or not advanced security is enabled for new repositories. Defaults to false.
    billingEmail String
    The billing email address for the organization.
    blog String
    The blog URL for the organization.
    company String
    The company name for the organization.
    defaultRepositoryPermission String
    The default permission for organization members to create new repositories. Can be one of read, write, admin, or none. Defaults to read.
    dependabotAlertsEnabledForNewRepositories Boolean
    Whether or not dependabot alerts are enabled for new repositories. Defaults to false.
    dependabotSecurityUpdatesEnabledForNewRepositories Boolean
    Whether or not dependabot security updates are enabled for new repositories. Defaults to false.
    dependencyGraphEnabledForNewRepositories Boolean
    Whether or not dependency graph is enabled for new repositories. Defaults to false.
    description String
    The description for the organization.
    email String
    The email address for the organization.
    hasOrganizationProjects Boolean
    Whether or not organization projects are enabled for the organization.
    hasRepositoryProjects Boolean
    Whether or not repository projects are enabled for the organization.
    location String
    The location for the organization.
    membersCanCreateInternalRepositories Boolean
    Whether or not organization members can create new internal repositories. For Enterprise Organizations only.
    membersCanCreatePages Boolean
    Whether or not organization members can create new pages. Defaults to true.
    membersCanCreatePrivatePages Boolean
    Whether or not organization members can create new private pages. Defaults to true.
    membersCanCreatePrivateRepositories Boolean
    Whether or not organization members can create new private repositories. Defaults to true.
    membersCanCreatePublicPages Boolean
    Whether or not organization members can create new public pages. Defaults to true.
    membersCanCreatePublicRepositories Boolean
    Whether or not organization members can create new public repositories. Defaults to true.
    membersCanCreateRepositories Boolean
    Whether or not organization members can create new repositories. Defaults to true.
    membersCanForkPrivateRepositories Boolean
    Whether or not organization members can fork private repositories. Defaults to false.
    name String
    The name for the organization.
    secretScanningEnabledForNewRepositories Boolean
    Whether or not secret scanning is enabled for new repositories. Defaults to false.
    secretScanningPushProtectionEnabledForNewRepositories Boolean
    Whether or not secret scanning push protection is enabled for new repositories. Defaults to false.
    twitterUsername String
    The Twitter username for the organization.
    webCommitSignoffRequired Boolean
    Whether or not commit signatures are required for commits to the organization. Defaults to false.
    advancedSecurityEnabledForNewRepositories boolean
    Whether or not advanced security is enabled for new repositories. Defaults to false.
    billingEmail string
    The billing email address for the organization.
    blog string
    The blog URL for the organization.
    company string
    The company name for the organization.
    defaultRepositoryPermission string
    The default permission for organization members to create new repositories. Can be one of read, write, admin, or none. Defaults to read.
    dependabotAlertsEnabledForNewRepositories boolean
    Whether or not dependabot alerts are enabled for new repositories. Defaults to false.
    dependabotSecurityUpdatesEnabledForNewRepositories boolean
    Whether or not dependabot security updates are enabled for new repositories. Defaults to false.
    dependencyGraphEnabledForNewRepositories boolean
    Whether or not dependency graph is enabled for new repositories. Defaults to false.
    description string
    The description for the organization.
    email string
    The email address for the organization.
    hasOrganizationProjects boolean
    Whether or not organization projects are enabled for the organization.
    hasRepositoryProjects boolean
    Whether or not repository projects are enabled for the organization.
    location string
    The location for the organization.
    membersCanCreateInternalRepositories boolean
    Whether or not organization members can create new internal repositories. For Enterprise Organizations only.
    membersCanCreatePages boolean
    Whether or not organization members can create new pages. Defaults to true.
    membersCanCreatePrivatePages boolean
    Whether or not organization members can create new private pages. Defaults to true.
    membersCanCreatePrivateRepositories boolean
    Whether or not organization members can create new private repositories. Defaults to true.
    membersCanCreatePublicPages boolean
    Whether or not organization members can create new public pages. Defaults to true.
    membersCanCreatePublicRepositories boolean
    Whether or not organization members can create new public repositories. Defaults to true.
    membersCanCreateRepositories boolean
    Whether or not organization members can create new repositories. Defaults to true.
    membersCanForkPrivateRepositories boolean
    Whether or not organization members can fork private repositories. Defaults to false.
    name string
    The name for the organization.
    secretScanningEnabledForNewRepositories boolean
    Whether or not secret scanning is enabled for new repositories. Defaults to false.
    secretScanningPushProtectionEnabledForNewRepositories boolean
    Whether or not secret scanning push protection is enabled for new repositories. Defaults to false.
    twitterUsername string
    The Twitter username for the organization.
    webCommitSignoffRequired boolean
    Whether or not commit signatures are required for commits to the organization. Defaults to false.
    advanced_security_enabled_for_new_repositories bool
    Whether or not advanced security is enabled for new repositories. Defaults to false.
    billing_email str
    The billing email address for the organization.
    blog str
    The blog URL for the organization.
    company str
    The company name for the organization.
    default_repository_permission str
    The default permission for organization members to create new repositories. Can be one of read, write, admin, or none. Defaults to read.
    dependabot_alerts_enabled_for_new_repositories bool
    Whether or not dependabot alerts are enabled for new repositories. Defaults to false.
    dependabot_security_updates_enabled_for_new_repositories bool
    Whether or not dependabot security updates are enabled for new repositories. Defaults to false.
    dependency_graph_enabled_for_new_repositories bool
    Whether or not dependency graph is enabled for new repositories. Defaults to false.
    description str
    The description for the organization.
    email str
    The email address for the organization.
    has_organization_projects bool
    Whether or not organization projects are enabled for the organization.
    has_repository_projects bool
    Whether or not repository projects are enabled for the organization.
    location str
    The location for the organization.
    members_can_create_internal_repositories bool
    Whether or not organization members can create new internal repositories. For Enterprise Organizations only.
    members_can_create_pages bool
    Whether or not organization members can create new pages. Defaults to true.
    members_can_create_private_pages bool
    Whether or not organization members can create new private pages. Defaults to true.
    members_can_create_private_repositories bool
    Whether or not organization members can create new private repositories. Defaults to true.
    members_can_create_public_pages bool
    Whether or not organization members can create new public pages. Defaults to true.
    members_can_create_public_repositories bool
    Whether or not organization members can create new public repositories. Defaults to true.
    members_can_create_repositories bool
    Whether or not organization members can create new repositories. Defaults to true.
    members_can_fork_private_repositories bool
    Whether or not organization members can fork private repositories. Defaults to false.
    name str
    The name for the organization.
    secret_scanning_enabled_for_new_repositories bool
    Whether or not secret scanning is enabled for new repositories. Defaults to false.
    secret_scanning_push_protection_enabled_for_new_repositories bool
    Whether or not secret scanning push protection is enabled for new repositories. Defaults to false.
    twitter_username str
    The Twitter username for the organization.
    web_commit_signoff_required bool
    Whether or not commit signatures are required for commits to the organization. Defaults to false.
    advancedSecurityEnabledForNewRepositories Boolean
    Whether or not advanced security is enabled for new repositories. Defaults to false.
    billingEmail String
    The billing email address for the organization.
    blog String
    The blog URL for the organization.
    company String
    The company name for the organization.
    defaultRepositoryPermission String
    The default permission for organization members to create new repositories. Can be one of read, write, admin, or none. Defaults to read.
    dependabotAlertsEnabledForNewRepositories Boolean
    Whether or not dependabot alerts are enabled for new repositories. Defaults to false.
    dependabotSecurityUpdatesEnabledForNewRepositories Boolean
    Whether or not dependabot security updates are enabled for new repositories. Defaults to false.
    dependencyGraphEnabledForNewRepositories Boolean
    Whether or not dependency graph is enabled for new repositories. Defaults to false.
    description String
    The description for the organization.
    email String
    The email address for the organization.
    hasOrganizationProjects Boolean
    Whether or not organization projects are enabled for the organization.
    hasRepositoryProjects Boolean
    Whether or not repository projects are enabled for the organization.
    location String
    The location for the organization.
    membersCanCreateInternalRepositories Boolean
    Whether or not organization members can create new internal repositories. For Enterprise Organizations only.
    membersCanCreatePages Boolean
    Whether or not organization members can create new pages. Defaults to true.
    membersCanCreatePrivatePages Boolean
    Whether or not organization members can create new private pages. Defaults to true.
    membersCanCreatePrivateRepositories Boolean
    Whether or not organization members can create new private repositories. Defaults to true.
    membersCanCreatePublicPages Boolean
    Whether or not organization members can create new public pages. Defaults to true.
    membersCanCreatePublicRepositories Boolean
    Whether or not organization members can create new public repositories. Defaults to true.
    membersCanCreateRepositories Boolean
    Whether or not organization members can create new repositories. Defaults to true.
    membersCanForkPrivateRepositories Boolean
    Whether or not organization members can fork private repositories. Defaults to false.
    name String
    The name for the organization.
    secretScanningEnabledForNewRepositories Boolean
    Whether or not secret scanning is enabled for new repositories. Defaults to false.
    secretScanningPushProtectionEnabledForNewRepositories Boolean
    Whether or not secret scanning push protection is enabled for new repositories. Defaults to false.
    twitterUsername String
    The Twitter username for the organization.
    webCommitSignoffRequired Boolean
    Whether or not commit signatures are required for commits to the organization. Defaults to false.

    Import

    Organization settings can be imported using the id of the organization. The id of the organization can be found using the get an organization API.

    $ pulumi import github:index/organizationSettings:OrganizationSettings test 123456789
    

    Package Details

    Repository
    GitHub pulumi/pulumi-github
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the github Terraform Provider.
    github logo
    GitHub v6.1.0 published on Monday, Mar 11, 2024 by Pulumi