Skip to main content
Manja / GitHub

Update an organization

**Parameter Deprecation Notice:** GitHub Enterprise Server 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](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.

PATCH/orgs/{org}
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Request

Path Parameters
org string
required
Body Params
optional
application/jsonobject
billing_email string
optional

Billing email address. This address is not publicized.

blog string
optional

Example: "http://github.blog"

company string
optional

The company name.

default_repository_permission string
optional

Default permission level members have for organization repositories: \* `read` - can pull, but not push to or administer this repository. \* `write` - can pull and push, but not administer this repository. \* `admin` - can pull, push, and administer this repository. \* `none` - no permissions granted by default.

Default: read

Allowed: "read""write""admin""none"

description string
optional

The description of the company.

email string
optional

The publicly visible email address.

has_organization_projects boolean
optional

Toggles whether an organization can use organization projects.

has_repository_projects boolean
optional

Toggles whether repositories that belong to the organization can use repository projects.

location string
optional

The location.

members_allowed_repository_creation_type string
optional

Specifies which types of repositories non-admin organization members can create. Can be one of: \* `all` - all organization members can create public and private repositories. \* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \* `none` - only admin members can create repositories. **Note:** This parameter is deprecated 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.

Allowed: "all""private""none"

members_can_create_internal_repositories boolean
optional

Toggles 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+. Can be one of: \* `true` - all organization members can create internal repositories. \* `false` - only organization owners can create internal repositories. Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation.

members_can_create_pages boolean
optional

Toggles whether organization members can create GitHub Pages sites. Can be one of: \* `true` - all organization members can create GitHub Pages sites. \* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.

Default: true

members_can_create_private_repositories boolean
optional

Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: \* `true` - all organization members can create private repositories. \* `false` - only organization owners can create private repositories. Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation.

members_can_create_public_repositories boolean
optional

Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: \* `true` - all organization members can create public repositories. \* `false` - only organization owners can create public repositories. Default: `true`. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation.

members_can_create_repositories boolean
optional

Toggles the ability of non-admin organization members to create repositories. Can be one of: \* `true` - all organization members can create repositories. \* `false` - only organization owners can create repositories. Default: `true` **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.

Default: true

members_can_fork_private_repositories boolean
optional

Toggles whether organization members can fork private organization repositories. Can be one of: \* `true` - all organization members can fork private repositories within the organization. \* `false` - no organization members can fork private repositories within the organization.

Default: false

name string
optional

The shorthand name of the company.

twitter_username string
optional

The Twitter username of the company.

Responses

application/json Organization Full object

Response

avatar_url string
required

Example: https://github.com/images/error/octocat_happy.gif

billing_email string<email>
optionalnullable

Example: [email protected]

blog string<uri>
optional

Example: https://github.com/blog

collaborators integer
optionalnullable

Example: 8

company string
optional

Example: GitHub

created_at string<date-time>
required

Example: 2008-01-14T04:33:35Z

default_repository_permission string
optionalnullable
description string
requirednullable

Example: A great organization

disk_usage integer
optionalnullable

Example: 10000

email string<email>
optional

Example: [email protected]

events_url string<uri>
required

Example: https://api.github.com/orgs/github/events

followers integer
required

Example: 20

following integer
required

Example: 0

has_organization_projects boolean
required

Example: true

has_repository_projects boolean
required

Example: true

hooks_url string
required

Example: https://api.github.com/orgs/github/hooks

html_url string<uri>
required

Example: https://github.com/octocat

id integer
required

Example: 1

is_verified boolean
optional

Example: true

issues_url string
required

Example: https://api.github.com/orgs/github/issues

location string
optional

Example: San Francisco

login string
required

Example: github

members_allowed_repository_creation_type string
optional

Example: all

members_can_create_internal_repositories boolean
optional

Example: true

members_can_create_pages boolean
optional

Example: true

members_can_create_private_pages boolean
optional

Example: true

members_can_create_private_repositories boolean
optional

Example: true

members_can_create_public_pages boolean
optional

Example: true

members_can_create_public_repositories boolean
optional

Example: true

members_can_create_repositories boolean
optionalnullable

Example: true

members_can_fork_private_repositories boolean
optionalnullable

Example: false

members_url string
required

Example: https://api.github.com/orgs/github/members{/member}

name string
optional

Example: github

node_id string
required

Example: MDEyOk9yZ2FuaXphdGlvbjE=

owned_private_repos integer
optional

Example: 100

plan object
optional
filled_seats integer
optional
name string
required
private_repos integer
required
seats integer
optional
space integer
required
private_gists integer
optionalnullable

Example: 81

public_gists integer
required

Example: 1

public_members_url string
required

Example: https://api.github.com/orgs/github/public_members{/member}

public_repos integer
required

Example: 2

repos_url string<uri>
required

Example: https://api.github.com/orgs/github/repos

total_private_repos integer
optional

Example: 100

twitter_username string
optionalnullable

Example: github

two_factor_requirement_enabled boolean
optionalnullable

Example: true

type string
required

Example: Organization

updated_at string<date-time>
required
url string<uri>
required

Example: https://api.github.com/orgs/github

application/json Basic Error object

Conflict

documentation_url string
optional
message string
optional
status string
optional
url string
optional
application/json

Validation failed