PATCH /orgs/{org}

[!WARNING] Closing down notice: GitHub will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

[!WARNING] Closing down notice: Code security product enablement for new repositories through the organization API is closing down. Please use code security configurations to set defaults instead. For more information on setting a default security configuration, see the changelog.

Updates the organization's profile and member privileges.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

Servers

Path parameters

Name Type Required Description
org String Yes

The organization name. The name is not case sensitive.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
secret_scanning_enabled_for_new_repositories Boolean No

Endpoint closing down notice. Please use code security configurations instead.

Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization."

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

billing_email String No

Billing email address. This address is not publicized.

has_organization_projects Boolean No

Whether an organization can use organization projects.

description String No

The description of the company. The maximum size is 160 characters.

members_can_create_public_pages Boolean No

Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.

Default value: true

advanced_security_enabled_for_new_repositories Boolean No

Endpoint closing down notice. Please use code security configurations instead.

Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization."

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

members_can_create_private_pages Boolean No

Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.

Default value: true

secret_scanning_push_protection_custom_link_enabled Boolean No

Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.

deploy_keys_enabled_for_repositories Boolean No

Controls whether or not deploy keys may be added and used for repositories in the organization.

members_can_create_internal_repositories Boolean No

Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

secret_scanning_push_protection_enabled_for_new_repositories Boolean No

Endpoint closing down notice. Please use code security configurations instead.

Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization."

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

email String No

The publicly visible email address.

company String No

The company name.

members_can_fork_private_repositories Boolean No

Whether organization members can fork private organization repositories.

Default value: false

web_commit_signoff_required Boolean No

Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.

Default value: false

dependabot_alerts_enabled_for_new_repositories Boolean No

Endpoint closing down notice. Please use code security configurations instead.

Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization."

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

location String No

The location.

members_can_create_public_repositories Boolean No

Whether organization members can create public repositories, which are visible to anyone. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

members_can_create_pages Boolean No

Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.

Default value: true

default_repository_permission String No

Default permission level members have for organization repositories.

Possible values:

  • "read"
  • "write"
  • "admin"
  • "none"

Default value: "read"

members_allowed_repository_creation_type String No

Specifies which types of repositories non-admin organization members can create. private is only available to repositories that are part of an organization on GitHub Enterprise Cloud. Note: This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.

Possible values:

  • "private"
  • "none"
  • "all"
has_repository_projects Boolean No

Whether repositories that belong to the organization can use repository projects.

secret_scanning_push_protection_custom_link String No

If secret_scanning_push_protection_custom_link_enabled is true, the URL that will be displayed to contributors who are blocked from pushing a secret.

name String No

The shorthand name of the company.

members_can_create_repositories Boolean No

Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

Default value: true

dependabot_security_updates_enabled_for_new_repositories Boolean No

Endpoint closing down notice. Please use code security configurations instead.

Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization."

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

members_can_create_private_repositories Boolean No

Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

blog String No
dependency_graph_enabled_for_new_repositories Boolean No

Endpoint closing down notice. Please use code security configurations instead.

Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization."

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

twitter_username String No

The Twitter username of the company.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.