orgs
Overview
Name | orgs |
Type | Resource |
Id | github.orgs.orgs |
Fields
Name | Datatype |
---|---|
id | integer |
name | string |
description | string |
owned_private_repos | integer |
members_can_create_repositories | boolean |
two_factor_requirement_enabled | boolean |
members_can_create_pages | boolean |
is_verified | boolean |
location | string |
private_gists | integer |
collaborators | integer |
has_organization_projects | boolean |
members_can_create_public_pages | boolean |
public_members_url | string |
members_allowed_repository_creation_type | string |
public_gists | integer |
html_url | string |
node_id | string |
members_can_create_internal_repositories | boolean |
members_can_create_private_pages | boolean |
plan | object |
repos_url | string |
blog | string |
members_can_fork_private_repositories | boolean |
members_can_create_private_repositories | boolean |
members_url | string |
disk_usage | integer |
url | string |
twitter_username | string |
following | integer |
hooks_url | string |
events_url | string |
login | string |
avatar_url | string |
email | string |
has_repository_projects | boolean |
issues_url | string |
updated_at | string |
total_private_repos | integer |
type | string |
default_repository_permission | string |
company | string |
public_repos | integer |
members_can_create_public_repositories | boolean |
created_at | string |
followers | integer |
billing_email | string |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | org | To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true , the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub plan. See "Authenticating with GitHub Apps" for details. For an example response, see 'Response with GitHub plan information' below." |
list | SELECT | Lists all organizations, in the order that they were created on GitHub. Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations. | |
list_for_user | SELECT | username | List public organization memberships for the specified user. This method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead. |
update | UPDATE | org | Parameter Deprecation 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.Enables an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges. |
list_for_authenticated_user | EXEC | List organizations for the authenticated user. OAuth scope requirements This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope. OAuth requests with insufficient scope receive a 403 Forbidden response. |