Organisations
Download SpecInteract with GitHub Orgs.
List organizations
Lists all organizations, in the order that they were created on GitHub Enterprise Server.
Note: Pagination is powered exclusively by the since
parameter. Use the Link header to get the URL for the next page of organizations.
since
int
An organization ID. Only return organizations with an ID greater than this ID.
per_page
int
The number of results per page (max 100).
- Default
- 30
Response
Response
[
{
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/github",
"repos_url": "https://api.github.com/orgs/github/repos",
"events_url": "https://api.github.com/orgs/github/events",
"hooks_url": "https://api.github.com/orgs/github/hooks",
"issues_url": "https://api.github.com/orgs/github/issues",
"members_url": "https://api.github.com/orgs/github/members{/member}",
"public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization"
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Not modified
Empty response
array[object (Organization Simple)]
- Content Type
- application/json
Organization Simple
object (Organization Simple)
A GitHub organization.
login
string
required
- Example
- "github"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDEyOk9yZ2FuaXphdGlvbjE="
url
string
uri
required
- Example
- "https://api.github.com/orgs/github"
repos_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/repos"
events_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/events"
hooks_url
string
required
- Example
- "https://api.github.com/orgs/github/hooks"
issues_url
string
required
- Example
- "https://api.github.com/orgs/github/issues"
members_url
string
required
- Example
- "https://api.github.com/orgs/github/members{/member}"
public_members_url
string
required
- Example
- "https://api.github.com/orgs/github/public_members{/member}"
avatar_url
string
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
description
string or null
required
- Example
- "A great organization"
Link
string
Deprecated - List custom repository roles in an organization
Note: This operation is deprecated and will be removed in the future. Use the "List custom repository roles" endpoint instead.
List the custom repository roles available in this organization. In order to see custom repository roles in an organization, the authenticated user must be an organization owner.
To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization and must use an access token with the admin:org
or repo
scope.
GitHub Apps must have the organization_custom_roles:read
or organization_administration:read
organization permission to use this endpoint.
For more information on custom repository roles, see "About custom repository roles."
organization_id
string
required
The unique identifier of the organization.
Response
Response - list of custom role names
{
"id": 8030,
"name": "Security Engineer",
"description": "Able to contribute code and maintain the security pipeline",
"base_role": "maintain",
"permissions": [
"delete_alerts_code_scanning"
],
"organization": {
"login": "github",
"id": 9919,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
"avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/github",
"html_url": "https://github.com/github",
"followers_url": "https://api.github.com/users/github/followers",
"following_url": "https://api.github.com/users/github/following{/other_user}",
"gists_url": "https://api.github.com/users/github/gists{/gist_id}",
"starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/github/subscriptions",
"organizations_url": "https://api.github.com/users/github/orgs",
"repos_url": "https://api.github.com/users/github/repos",
"events_url": "https://api.github.com/users/github/events{/privacy}",
"received_events_url": "https://api.github.com/users/github/received_events",
"type": "Organization",
"site_admin": false
},
"created_at": "2022-07-04T22:19:11Z",
"updated_at": "2022-07-04T22:20:11Z"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
The number of custom roles in this organization
- Example
- 3
custom_roles
array[object (Organization Custom Repository Role)]
Organization Custom Repository Role
object (Organization Custom Repository Role)
Custom repository roles created by organization administrators
id
int
required
The unique identifier of the custom role.
name
string
required
The name of the custom role.
description
string or null
A short description about who this role is for or what permissions it grants.
base_role
string
required
The system role from which this role inherits permissions.
- Enum
-
- read
- triage
- write
- maintain
permissions
array[string]
required
A list of additional permissions included in this role.
string
organization
object (organization)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
created_at
string
date-time
required
updated_at
string
date-time
required
Get an organization
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 Enterprise Server plan. See "Authenticating with GitHub Apps" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below."
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/github",
"repos_url": "https://api.github.com/orgs/github/repos",
"events_url": "https://api.github.com/orgs/github/events",
"hooks_url": "https://api.github.com/orgs/github/hooks",
"issues_url": "https://api.github.com/orgs/github/issues",
"members_url": "https://api.github.com/orgs/github/members{/member}",
"public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization",
"name": "github",
"company": "GitHub",
"blog": "https://github.com/blog",
"location": "San Francisco",
"email": "octocat@github.com",
"twitter_username": "github",
"is_verified": true,
"has_organization_projects": true,
"has_repository_projects": true,
"public_repos": 2,
"public_gists": 1,
"followers": 20,
"following": 0,
"html_url": "https://github.com/octocat",
"created_at": "2008-01-14T04:33:35Z",
"type": "Organization",
"total_private_repos": 100,
"owned_private_repos": 100,
"private_gists": 81,
"disk_usage": 10000,
"collaborators": 8,
"billing_email": "mona@github.com",
"plan": {
"name": "Medium",
"space": 400,
"private_repos": 20,
"filled_seats": 4,
"seats": 5
},
"default_repository_permission": "read",
"members_can_create_repositories": true,
"two_factor_requirement_enabled": true,
"members_allowed_repository_creation_type": "all",
"members_can_create_public_repositories": false,
"members_can_create_private_repositories": false,
"members_can_create_internal_repositories": false,
"members_can_create_pages": true,
"members_can_create_public_pages": true,
"members_can_create_private_pages": true,
"members_can_fork_private_repositories": false,
"web_commit_signoff_required": false,
"updated_at": "2014-03-03T18:58:10Z",
"dependency_graph_enabled_for_new_repositories": false,
"dependabot_alerts_enabled_for_new_repositories": false,
"dependabot_security_updates_enabled_for_new_repositories": false,
"advanced_security_enabled_for_new_repositories": false,
"secret_scanning_enabled_for_new_repositories": false,
"secret_scanning_push_protection_enabled_for_new_repositories": false,
"secret_scanning_push_protection_custom_link": false,
"secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
login
string
required
- Example
- "github"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDEyOk9yZ2FuaXphdGlvbjE="
url
string
uri
required
- Example
- "https://api.github.com/orgs/github"
repos_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/repos"
events_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/events"
hooks_url
string
required
- Example
- "https://api.github.com/orgs/github/hooks"
issues_url
string
required
- Example
- "https://api.github.com/orgs/github/issues"
members_url
string
required
- Example
- "https://api.github.com/orgs/github/members{/member}"
public_members_url
string
required
- Example
- "https://api.github.com/orgs/github/public_members{/member}"
avatar_url
string
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
description
string or null
required
- Example
- "A great organization"
name
string
- Example
- "github"
company
string
- Example
- "GitHub"
blog
string
uri
- Example
- "https://github.com/blog"
location
string
- Example
- "San Francisco"
string
- Example
- "octocat@github.com"
twitter_username
string or null
- Example
- "github"
is_verified
boolean
- Example
- true
has_organization_projects
boolean
required
- Example
- true
has_repository_projects
boolean
required
- Example
- true
public_repos
int
required
- Example
- 2
public_gists
int
required
- Example
- 1
followers
int
required
- Example
- 20
following
int
required
- Example
- 0
html_url
string
uri
required
- Example
- "https://github.com/octocat"
created_at
string
date-time
required
- Example
- "2008-01-14T04:33:35Z"
type
string
required
- Example
- "Organization"
total_private_repos
int
- Example
- 100
owned_private_repos
int
- Example
- 100
private_gists
int or null
- Example
- 81
disk_usage
int or null
- Example
- 10000
collaborators
int or null
- Example
- 8
billing_email
string or null
- Example
- "org@example.com"
plan
object (plan)
name
string
required
space
int
required
private_repos
int
required
filled_seats
int
seats
int
default_repository_permission
string or null
members_can_create_repositories
boolean or null
- Example
- true
two_factor_requirement_enabled
boolean or null
- Example
- true
members_allowed_repository_creation_type
string
- Example
- "all"
members_can_create_public_repositories
boolean
- Example
- true
members_can_create_private_repositories
boolean
- Example
- true
members_can_create_internal_repositories
boolean
- Example
- true
members_can_create_pages
boolean
- Example
- true
members_can_create_public_pages
boolean
- Example
- true
members_can_create_private_pages
boolean
- Example
- true
members_can_fork_private_repositories
boolean or null
- Example
- false
web_commit_signoff_required
boolean
- Example
- false
updated_at
string
date-time
required
advanced_security_enabled_for_new_repositories
boolean
Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.
This field is only visible to organization owners or members of a team with the security manager role.
- Example
- false
dependabot_alerts_enabled_for_new_repositories
boolean
Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.
This field is only visible to organization owners or members of a team with the security manager role.
- Example
- false
dependabot_security_updates_enabled_for_new_repositories
boolean
Whether dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.
This field is only visible to organization owners or members of a team with the security manager role.
- Example
- false
dependency_graph_enabled_for_new_repositories
boolean
Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.
This field is only visible to organization owners or members of a team with the security manager role.
- Example
- false
secret_scanning_enabled_for_new_repositories
boolean
Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.
This field is only visible to organization owners or members of a team with the security manager role.
- Example
- false
secret_scanning_push_protection_enabled_for_new_repositories
boolean
Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.
This field is only visible to organization owners or members of a team with the security manager role.
- Example
- false
secret_scanning_push_protection_custom_link_enabled
boolean
Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.
- Example
- false
secret_scanning_push_protection_custom_link
string or null
An optional URL string to display to contributors who are blocked from pushing a secret.
- Example
- "https://github.com/test-org/test-repo/blob/main/README.md"
Delete an organization
Deletes an organization and all its repositories.
The organization login will be unavailable for 90 days after deletion.
Please review the Terms of Service regarding account deletion before using this endpoint:
https://docs.github.com/enterprise-server@3.9/site-policy/github-terms/github-terms-of-service
org
string
required
The organization name. The name is not case sensitive.
Response
Accepted
null
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Forbidden
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
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.
Enables an authenticated organization owner with the admin:org
scope to update the organization's profile and member privileges.
billing_email
string
Billing email address. This address is not publicized.
company
string
The company name.
string
The publicly visible email address.
twitter_username
string
The Twitter username of the company.
location
string
The location.
name
string
The shorthand name of the company.
description
string
The description of the company.
has_organization_projects
boolean
Whether an organization can use organization projects.
has_repository_projects
boolean
Whether repositories that belong to the organization can use repository projects.
default_repository_permission
string
Default permission level members have for organization repositories.
- Default
- "read"
- Enum
-
- read
- write
- admin
- none
members_can_create_repositories
boolean
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
- true
members_can_create_internal_repositories
boolean
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.
members_can_create_private_repositories
boolean
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.
members_can_create_public_repositories
boolean
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_allowed_repository_creation_type
string
Specifies which types of repositories non-admin organization members can create.
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.
- Enum
-
- all
- private
- none
members_can_create_pages
boolean
Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.
- Default
- true
members_can_fork_private_repositories
boolean
Whether organization members can fork private organization repositories.
- Default
- false
web_commit_signoff_required
boolean
Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.
- Default
- false
blog
string
- Example
- "\"http://github.blog\""
advanced_security_enabled_for_new_repositories
boolean
Whether GitHub Advanced Security is automatically enabled for new repositories.
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.
dependabot_alerts_enabled_for_new_repositories
boolean
Whether Dependabot alerts is automatically enabled for new repositories.
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.
dependabot_security_updates_enabled_for_new_repositories
boolean
Whether Dependabot security updates is automatically enabled for new repositories.
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.
dependency_graph_enabled_for_new_repositories
boolean
Whether dependency graph is automatically enabled for new repositories.
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.
secret_scanning_enabled_for_new_repositories
boolean
Whether secret scanning is automatically enabled for new repositories.
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.
secret_scanning_push_protection_enabled_for_new_repositories
boolean
Whether secret scanning push protection is automatically enabled for new repositories.
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.
secret_scanning_push_protection_custom_link_enabled
boolean
Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.
secret_scanning_push_protection_custom_link
string
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.
org
string
required
The organization name. The name is not case sensitive.
Request
{
"billing_email": "mona@github.com",
"company": "GitHub",
"email": "mona@github.com",
"twitter_username": "github",
"location": "San Francisco",
"name": "github",
"description": "GitHub, the company.",
"default_repository_permission": "read",
"members_can_create_repositories": true,
"members_allowed_repository_creation_type": "all"
}
Response
Response
{
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/github",
"repos_url": "https://api.github.com/orgs/github/repos",
"events_url": "https://api.github.com/orgs/github/events",
"hooks_url": "https://api.github.com/orgs/github/hooks",
"issues_url": "https://api.github.com/orgs/github/issues",
"members_url": "https://api.github.com/orgs/github/members{/member}",
"public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization",
"name": "github",
"company": "GitHub",
"blog": "https://github.com/blog",
"location": "San Francisco",
"email": "octocat@github.com",
"twitter_username": "github",
"is_verified": true,
"has_organization_projects": true,
"has_repository_projects": true,
"public_repos": 2,
"public_gists": 1,
"followers": 20,
"following": 0,
"html_url": "https://github.com/octocat",
"created_at": "2008-01-14T04:33:35Z",
"type": "Organization",
"total_private_repos": 100,
"owned_private_repos": 100,
"private_gists": 81,
"disk_usage": 10000,
"collaborators": 8,
"billing_email": "mona@github.com",
"plan": {
"name": "Medium",
"space": 400,
"private_repos": 20,
"filled_seats": 4,
"seats": 5
},
"default_repository_permission": "read",
"members_can_create_repositories": true,
"two_factor_requirement_enabled": true,
"members_allowed_repository_creation_type": "all",
"members_can_create_public_repositories": false,
"members_can_create_private_repositories": false,
"members_can_create_internal_repositories": false,
"members_can_create_pages": true,
"members_can_create_public_pages": true,
"members_can_create_private_pages": true,
"members_can_fork_private_repositories": false,
"web_commit_signoff_required": false,
"updated_at": "2014-03-03T18:58:10Z",
"dependency_graph_enabled_for_new_repositories": false,
"dependabot_alerts_enabled_for_new_repositories": false,
"dependabot_security_updates_enabled_for_new_repositories": false,
"advanced_security_enabled_for_new_repositories": false,
"secret_scanning_enabled_for_new_repositories": false,
"secret_scanning_push_protection_enabled_for_new_repositories": false,
"secret_scanning_push_protection_custom_link": false,
"secret_scanning_push_protection_custom_link_enabled": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
Validation failed
{
"message": "string",
"documentation_url": "string",
"errors": [
{
"resource": "string",
"field": "string",
"message": "string",
"code": "string",
"index": 123,
"value": "string"
}
]
}
Conflict
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
login
string
required
- Example
- "github"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDEyOk9yZ2FuaXphdGlvbjE="
url
string
uri
required
- Example
- "https://api.github.com/orgs/github"
repos_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/repos"
events_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/events"
hooks_url
string
required
- Example
- "https://api.github.com/orgs/github/hooks"
issues_url
string
required
- Example
- "https://api.github.com/orgs/github/issues"
members_url
string
required
- Example
- "https://api.github.com/orgs/github/members{/member}"
public_members_url
string
required
- Example
- "https://api.github.com/orgs/github/public_members{/member}"
avatar_url
string
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
description
string or null
required
- Example
- "A great organization"
name
string
- Example
- "github"
company
string
- Example
- "GitHub"
blog
string
uri
- Example
- "https://github.com/blog"
location
string
- Example
- "San Francisco"
string
- Example
- "octocat@github.com"
twitter_username
string or null
- Example
- "github"
is_verified
boolean
- Example
- true
has_organization_projects
boolean
required
- Example
- true
has_repository_projects
boolean
required
- Example
- true
public_repos
int
required
- Example
- 2
public_gists
int
required
- Example
- 1
followers
int
required
- Example
- 20
following
int
required
- Example
- 0
html_url
string
uri
required
- Example
- "https://github.com/octocat"
created_at
string
date-time
required
- Example
- "2008-01-14T04:33:35Z"
type
string
required
- Example
- "Organization"
total_private_repos
int
- Example
- 100
owned_private_repos
int
- Example
- 100
private_gists
int or null
- Example
- 81
disk_usage
int or null
- Example
- 10000
collaborators
int or null
- Example
- 8
billing_email
string or null
- Example
- "org@example.com"
plan
object (plan)
name
string
required
space
int
required
private_repos
int
required
filled_seats
int
seats
int
default_repository_permission
string or null
members_can_create_repositories
boolean or null
- Example
- true
two_factor_requirement_enabled
boolean or null
- Example
- true
members_allowed_repository_creation_type
string
- Example
- "all"
members_can_create_public_repositories
boolean
- Example
- true
members_can_create_private_repositories
boolean
- Example
- true
members_can_create_internal_repositories
boolean
- Example
- true
members_can_create_pages
boolean
- Example
- true
members_can_create_public_pages
boolean
- Example
- true
members_can_create_private_pages
boolean
- Example
- true
members_can_fork_private_repositories
boolean or null
- Example
- false
web_commit_signoff_required
boolean
- Example
- false
updated_at
string
date-time
required
advanced_security_enabled_for_new_repositories
boolean
Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.
This field is only visible to organization owners or members of a team with the security manager role.
- Example
- false
dependabot_alerts_enabled_for_new_repositories
boolean
Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.
This field is only visible to organization owners or members of a team with the security manager role.
- Example
- false
dependabot_security_updates_enabled_for_new_repositories
boolean
Whether dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.
This field is only visible to organization owners or members of a team with the security manager role.
- Example
- false
dependency_graph_enabled_for_new_repositories
boolean
Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.
This field is only visible to organization owners or members of a team with the security manager role.
- Example
- false
secret_scanning_enabled_for_new_repositories
boolean
Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.
This field is only visible to organization owners or members of a team with the security manager role.
- Example
- false
secret_scanning_push_protection_enabled_for_new_repositories
boolean
Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.
This field is only visible to organization owners or members of a team with the security manager role.
- Example
- false
secret_scanning_push_protection_custom_link_enabled
boolean
Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.
- Example
- false
secret_scanning_push_protection_custom_link
string or null
An optional URL string to display to contributors who are blocked from pushing a secret.
- Example
- "https://github.com/test-org/test-repo/blob/main/README.md"
One Of
- Content Type
- application/json
Validation Error
object (Validation Error)
Validation Error
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
Validation Error Simple
object (Validation Error Simple)
Validation Error Simple
message
string
required
documentation_url
string
required
errors
array[string]
string
Get announcement banner for organization
Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the organization level. Organization members may also see an enterprise-level announcement banner. To get an announcement banner displayed at the enterprise level, use the enterprise-level endpoint.
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"announcement": "Very **important** announcement about _something_.",
"expires_at": "2021-01-01T00:00:00.000+00:00",
"user_dismissible": false
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
announcement
string or null
required
The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "Basic writing and formatting syntax."
- Example
- "Very **important** announcement about _something_."
expires_at
string or null
date-time
required
The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
. To set an announcement that never expires, omit this parameter, set it to null
, or set it to an empty string.
- Example
- "\"2021-01-01T00:00:00.000-07:00\""
user_dismissible
boolean or null
required
Whether an announcement can be dismissed by the user.
- Default
- false
- Example
- false
Remove announcement banner from organization
Removes the announcement banner currently set for the organization.
org
string
required
The organization name. The name is not case sensitive.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Set announcement banner for organization
Sets the announcement banner to display for the organization.
announcement
string or null
required
The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "Basic writing and formatting syntax."
- Example
- "Very **important** announcement about _something_."
expires_at
string or null
date-time
The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
. To set an announcement that never expires, omit this parameter, set it to null
, or set it to an empty string.
- Example
- "\"2021-01-01T00:00:00.000-07:00\""
org
string
required
The organization name. The name is not case sensitive.
Request
{
"announcement": "Very **important** announcement about _something_.",
"expires_at": "2021-01-01T00:00:00.000+00:00",
"user_dismissible": false
}
Response
Response
{
"announcement": "Very **important** announcement about _something_.",
"expires_at": "2021-01-01T00:00:00.000+00:00",
"user_dismissible": false
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
announcement
string or null
required
The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "Basic writing and formatting syntax."
- Example
- "Very **important** announcement about _something_."
expires_at
string or null
date-time
required
The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
. To set an announcement that never expires, omit this parameter, set it to null
, or set it to an empty string.
- Example
- "\"2021-01-01T00:00:00.000-07:00\""
user_dismissible
boolean or null
required
Whether an announcement can be dismissed by the user.
- Default
- false
- Example
- false
Get the audit log for an organization
Gets the audit log for an organization. For more information, see "Reviewing the audit log for your organization."
To use this endpoint, you must be an organization owner, and you must use an access token with the read:audit_log
scope. GitHub Apps must have the organization_administration
read permission to use this endpoint.
By default, the response includes up to 30 events from the past three months. Use the phrase
parameter to filter results and retrieve older events. For example, use the phrase
parameter with the created
qualifier to filter events based on when the events occurred. For more information, see "Reviewing the audit log for your organization."
Use pagination to retrieve fewer or more than 30 events. For more information, see "Resources in the REST API."
phrase
string
A search phrase. For more information, see Searching the audit log.
include
string
The event types to include:
web
- returns web (non-Git) events.git
- returns Git events.all
- returns both web and Git events.
The default is web
.
- Enum
-
- web
- git
- all
after
string
A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
before
string
A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
order
string
The order of audit log events. To list newest events first, specify desc
. To list oldest events first, specify asc
.
The default is desc
.
- Enum
-
- desc
- asc
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
org
string
required
The organization name. The name is not case sensitive.
Response
Response
[
{
"actor_ip": "88.123.45.123",
"from": "pull_requests#merge",
"device_cookie": null,
"actor": "mona-admin",
"actor_id": 7,
"repo": "octo-org/octo-repo",
"repo_id": 17,
"business": "github",
"business_id": 1,
"org": "octo-org",
"org_id": 8,
"action": "pull_request.merge",
"@timestamp": 1635940599755,
"created_at": 1635940599755,
"operation_type": "modify",
"actor_location": {
"country_code": "GB",
"country_name": "United Kingdom",
"region": "ENG",
"region_name": "England",
"city": "Louth",
"postal_code": "LN11",
"location": {
"lat": 53.4457,
"lon": 0.141
}
},
"data": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...",
"method": "POST",
"request_id": "e4dabc4d-ba16-4bca-1234-649be7ae1188",
"server_id": "5d17aab5-fd9f-abcd-a820-16bed246441b",
"request_category": "other",
"controller_action": "merge",
"url": "https://example.com/octo-org/octo-repo/pull/1/merge",
"client_id": 322299977.1635936,
"referrer": "https://example.com/octo-org/octo-repo/pull/1",
"actor_session": 1,
"pull_request_id": 1,
"category_type": "Resource Management"
}
},
{
"actor_ip": "88.123.45.123",
"from": "pull_request_review_events#create",
"device_cookie": null,
"actor": "mona-admin",
"actor_id": 7,
"business_id": 1,
"org_id": 8,
"action": "pull_request_review.submit",
"@timestamp": 1635940593079,
"created_at": 1635940593079,
"operation_type": "modify",
"actor_location": {
"country_code": "GB",
"country_name": "United Kingdom",
"region": "ENG",
"region_name": "England",
"city": "Louth",
"postal_code": "LN11",
"location": {
"lat": 53.4457,
"lon": 0.141
}
},
"data": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...",
"method": "PUT",
"request_id": "c0f63bb7-17b6-4796-940c-12345c5a581b",
"server_id": "2abc1234-f651-43e3-9696-e942ad5f8c89",
"request_category": "other",
"controller_action": "create",
"url": "https://example.com/octo-org/octo-repo/pull/1/reviews",
"client_id": 322299977.1635936,
"referrer": "https://example.com/octo-org/octo-repo/pull/1/files",
"actor_session": 1,
"spammy": false,
"pull_request_id": 1,
"body": null,
"allowed": true,
"id": 1,
"state": 40,
"issue_id": 1,
"review_id": 1,
"category_type": "Resource Management"
}
},
{
"actor_ip": "88.123.45.123",
"from": "pull_requests#create",
"device_cookie": null,
"actor": "mona",
"actor_id": 9,
"user_id": 9,
"repo": "octo-org/octo-repo",
"repo_id": 17,
"business": "github",
"business_id": 1,
"org": "octo-org",
"org_id": 8,
"action": "pull_request.create",
"@timestamp": 1635940554161,
"created_at": 1635940554161,
"operation_type": "create",
"actor_location": {
"country_code": "GB",
"country_name": "United Kingdom",
"region": "ENG",
"region_name": "England",
"city": "Louth",
"postal_code": "LN11",
"location": {
"lat": 53.4457,
"lon": 0.141
}
},
"data": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ...",
"method": "POST",
"request_id": "2773abeb-477f-4ebf-a017-f8e8a206c305",
"server_id": "796e3115-4ce8-4606-8fd0-99ea57a2e12b",
"request_category": "other",
"controller_action": "create",
"url": "https://example.com/octo-org/octo-repo/pull/create?base=octo-org%3Amain&head=mona%3Apatch-1",
"client_id": 386351111.163594,
"referrer": "https://example.com/octo-org/octo-repo/compare/main...mona:patch-1",
"actor_session": 2,
"pull_request_id": 1,
"category_type": "Resource Management"
}
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
array[object]
- Content Type
- application/json
object
@timestamp
int
The time the audit log event occurred, given as a Unix timestamp.
action
string
The name of the action that was performed, for example user.login
or repo.create
.
active
boolean
active_was
boolean
actor
string
The actor who performed the action.
actor_id
int
The id of the actor who performed the action.
actor_location
object (actor_location)
country_name
string
data
object (data)
org_id
int
user_id
int
business_id
int
blocked_user
string
The username of the account being blocked.
business
string
config
array[object]
object
config_was
array[object]
object
content_type
string
operation_type
string
created_at
int
The time the audit log event was recorded, given as a Unix timestamp.
deploy_key_fingerprint
string
_document_id
string
A unique identifier for an audit event.
emoji
string
events
array[object]
object
events_were
array[object]
object
explanation
string
fingerprint
string
hook_id
int
limited_availability
boolean
message
string
name
string
old_user
string
openssh_public_key
string
org
string
previous_visibility
string
read_only
boolean
repo
string
The name of the repository.
repository
string
The name of the repository.
repository_public
boolean
target_login
string
team
string
transport_protocol
int
The type of protocol (for example, HTTP or SSH) used to transfer Git data.
transport_protocol_name
string
A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data.
user
string
The user that was affected by the action performed (if available).
visibility
string
The repository visibility, for example public
or private
.
List custom repository roles in an organization
List the custom repository roles available in this organization. In order to see custom repository roles in an organization, the authenticated user must be an organization owner.
To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization and must use an access token with the admin:org
or repo
scope.
GitHub Apps must have the organization_custom_roles:read
or organization_administration:read
organization permission to use this endpoint.
For more information on custom repository roles, see "About custom repository roles."
org
string
required
The organization name. The name is not case sensitive.
Response
Response - list of custom role names
{
"total_count": 2,
"custom_roles": [
{
"id": 8030,
"name": "Security Engineer",
"description": "Able to contribute code and maintain the security pipeline",
"base_role": "maintain",
"permissions": [
"delete_alerts_code_scanning"
],
"organization": {
"login": "github",
"id": 9919,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
"avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/github",
"html_url": "https://github.com/github",
"followers_url": "https://api.github.com/users/github/followers",
"following_url": "https://api.github.com/users/github/following{/other_user}",
"gists_url": "https://api.github.com/users/github/gists{/gist_id}",
"starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/github/subscriptions",
"organizations_url": "https://api.github.com/users/github/orgs",
"repos_url": "https://api.github.com/users/github/repos",
"events_url": "https://api.github.com/users/github/events{/privacy}",
"received_events_url": "https://api.github.com/users/github/received_events",
"type": "Organization",
"site_admin": false
},
"created_at": "2022-07-04T22:19:11Z",
"updated_at": "2022-07-04T22:20:11Z"
},
{
"id": 8031,
"name": "Community manager",
"description": "Able to handle all the community interactions without being able to contribute code",
"base_role": "read",
"permissions": [
"mark_as_duplicate",
"manage_settings_pages",
"manage_settings_wiki",
"set_social_preview",
"edit_repo_metadata",
"toggle_discussion_comment_minimize"
],
"organization": {
"login": "github",
"id": 9919,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
"avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/github",
"html_url": "https://github.com/github",
"followers_url": "https://api.github.com/users/github/followers",
"following_url": "https://api.github.com/users/github/following{/other_user}",
"gists_url": "https://api.github.com/users/github/gists{/gist_id}",
"starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/github/subscriptions",
"organizations_url": "https://api.github.com/users/github/orgs",
"repos_url": "https://api.github.com/users/github/repos",
"events_url": "https://api.github.com/users/github/events{/privacy}",
"received_events_url": "https://api.github.com/users/github/received_events",
"type": "Organization",
"site_admin": false
},
"created_at": "2022-07-05T12:01:11Z",
"updated_at": "2022-07-05T12:20:11Z"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
The number of custom roles in this organization
- Example
- 3
custom_roles
array[object (Organization Custom Repository Role)]
Organization Custom Repository Role
object (Organization Custom Repository Role)
Custom repository roles created by organization administrators
id
int
required
The unique identifier of the custom role.
name
string
required
The name of the custom role.
description
string or null
A short description about who this role is for or what permissions it grants.
base_role
string
required
The system role from which this role inherits permissions.
- Enum
-
- read
- triage
- write
- maintain
permissions
array[string]
required
A list of additional permissions included in this role.
string
organization
object (organization)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
created_at
string
date-time
required
updated_at
string
date-time
required
Create a custom repository role
Creates a custom repository role that can be used by all repositories owned by the organization.
To use this endpoint, the authenticated user must be an administrator for the organization and must use an personal access token (classic) with admin:org
scope or a fine-grained personal access token with the organization_custom_roles:write
organization permission.
For more information on custom repository roles, see "About custom repository roles."
name
string
required
The name of the custom role.
description
string or null
A short description about who this role is for or what permissions it grants.
base_role
string
required
The system role from which this role inherits permissions.
- Enum
-
- read
- triage
- write
- maintain
permissions
array[string]
required
A list of additional permissions included in this role.
string
org
string
required
The organization name. The name is not case sensitive.
Request
{
"name": "Labeler",
"description": "A role for issue and pull request labelers",
"base_role": "read",
"permissions": [
"add_label"
]
}
Response
Response
{
"id": 8030,
"name": "Security Engineer",
"description": "Able to contribute code and maintain the security pipeline",
"base_role": "maintain",
"permissions": [
"delete_alerts_code_scanning"
],
"organization": {
"login": "github",
"id": 9919,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
"avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/github",
"html_url": "https://github.com/github",
"followers_url": "https://api.github.com/users/github/followers",
"following_url": "https://api.github.com/users/github/following{/other_user}",
"gists_url": "https://api.github.com/users/github/gists{/gist_id}",
"starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/github/subscriptions",
"organizations_url": "https://api.github.com/users/github/orgs",
"repos_url": "https://api.github.com/users/github/repos",
"events_url": "https://api.github.com/users/github/events{/privacy}",
"received_events_url": "https://api.github.com/users/github/received_events",
"type": "Organization",
"site_admin": false
},
"created_at": "2022-07-04T22:19:11Z",
"updated_at": "2022-07-04T22:20:11Z"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
{
"resource": "string",
"field": "string",
"message": "string",
"code": "string",
"index": 123,
"value": "string"
}
]
}
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
id
int
required
The unique identifier of the custom role.
name
string
required
The name of the custom role.
description
string or null
A short description about who this role is for or what permissions it grants.
base_role
string
required
The system role from which this role inherits permissions.
- Enum
-
- read
- triage
- write
- maintain
permissions
array[string]
required
A list of additional permissions included in this role.
string
organization
object (organization)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
created_at
string
date-time
required
updated_at
string
date-time
required
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
Get a custom repository role
Gets a custom repository role that is available to all repositories owned by the organization.
To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization and must use an access token with the admin:org
or repo
scope.
GitHub Apps must have the organization_custom_roles:read
or organization_administration:read
organization permission to use this endpoint.
For more information on custom repository roles, see "About custom repository roles."
org
string
required
The organization name. The name is not case sensitive.
role_id
int
required
The unique identifier of the role.
Response
Response
{
"id": 8030,
"name": "Security Engineer",
"description": "Able to contribute code and maintain the security pipeline",
"base_role": "maintain",
"permissions": [
"delete_alerts_code_scanning"
],
"organization": {
"login": "github",
"id": 9919,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
"avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/github",
"html_url": "https://github.com/github",
"followers_url": "https://api.github.com/users/github/followers",
"following_url": "https://api.github.com/users/github/following{/other_user}",
"gists_url": "https://api.github.com/users/github/gists{/gist_id}",
"starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/github/subscriptions",
"organizations_url": "https://api.github.com/users/github/orgs",
"repos_url": "https://api.github.com/users/github/repos",
"events_url": "https://api.github.com/users/github/events{/privacy}",
"received_events_url": "https://api.github.com/users/github/received_events",
"type": "Organization",
"site_admin": false
},
"created_at": "2022-07-04T22:19:11Z",
"updated_at": "2022-07-04T22:20:11Z"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
id
int
required
The unique identifier of the custom role.
name
string
required
The name of the custom role.
description
string or null
A short description about who this role is for or what permissions it grants.
base_role
string
required
The system role from which this role inherits permissions.
- Enum
-
- read
- triage
- write
- maintain
permissions
array[string]
required
A list of additional permissions included in this role.
string
organization
object (organization)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
created_at
string
date-time
required
updated_at
string
date-time
required
Delete a custom repository role
Deletes a custom role from an organization. Once the custom role has been deleted, any user, team, or invitation with the deleted custom role will be reassigned the inherited role.
To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with admin:org
scope.
GitHub Apps must have the organization_custom_roles:write
organization permission to use this endpoint.
For more information about custom repository roles, see "About custom repository roles."
org
string
required
The organization name. The name is not case sensitive.
role_id
int
required
The unique identifier of the role.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Update a custom repository role
Updates a custom repository role that can be used by all repositories owned by the organization.
To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with admin:org
scope.
GitHub Apps must have the organization_custom_roles:write
organization permission to use this endpoint.
For more information about custom repository roles, see "About custom repository roles."
name
string
The name of the custom role.
description
string or null
A short description about who this role is for or what permissions it grants.
base_role
string
The system role from which this role inherits permissions.
- Enum
-
- read
- triage
- write
- maintain
permissions
array[string]
A list of additional permissions included in this role.
string
org
string
required
The organization name. The name is not case sensitive.
role_id
int
required
The unique identifier of the role.
Request
{
"name": "Labeler",
"description": "A role for issue and PR labelers",
"base_role": "read",
"permissions": [
"add_label",
"remove_label"
]
}
Response
Response
{
"id": 8030,
"name": "Security Engineer",
"description": "Able to contribute code and maintain the security pipeline",
"base_role": "maintain",
"permissions": [
"delete_alerts_code_scanning"
],
"organization": {
"login": "github",
"id": 9919,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
"avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/github",
"html_url": "https://github.com/github",
"followers_url": "https://api.github.com/users/github/followers",
"following_url": "https://api.github.com/users/github/following{/other_user}",
"gists_url": "https://api.github.com/users/github/gists{/gist_id}",
"starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/github/subscriptions",
"organizations_url": "https://api.github.com/users/github/orgs",
"repos_url": "https://api.github.com/users/github/repos",
"events_url": "https://api.github.com/users/github/events{/privacy}",
"received_events_url": "https://api.github.com/users/github/received_events",
"type": "Organization",
"site_admin": false
},
"created_at": "2022-07-04T22:19:11Z",
"updated_at": "2022-07-04T22:20:11Z"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
{
"resource": "string",
"field": "string",
"message": "string",
"code": "string",
"index": 123,
"value": "string"
}
]
}
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
id
int
required
The unique identifier of the custom role.
name
string
required
The name of the custom role.
description
string or null
A short description about who this role is for or what permissions it grants.
base_role
string
required
The system role from which this role inherits permissions.
- Enum
-
- read
- triage
- write
- maintain
permissions
array[string]
required
A list of additional permissions included in this role.
string
organization
object (organization)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
created_at
string
date-time
required
updated_at
string
date-time
required
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
org
string
required
The organization name. The name is not case sensitive.
Response
Response
[
{
"id": 1,
"url": "https://api.github.com/orgs/octocat/hooks/1",
"ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings",
"deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries",
"name": "web",
"events": [
"push",
"pull_request"
],
"active": true,
"config": {
"url": "http://example.com",
"content_type": "json"
},
"updated_at": "2011-09-06T20:39:23Z",
"created_at": "2011-09-06T17:26:27Z",
"type": "Organization"
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
array[object (Org Hook)]
- Content Type
- application/json
Org Hook
object (Org Hook)
Org Hook
id
int
required
- Example
- 1
url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat/hooks/1"
ping_url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat/hooks/1/pings"
deliveries_url
string
uri
- Example
- "https://api.github.com/orgs/octocat/hooks/1/deliveries"
name
string
required
- Example
- "web"
events
array[string]
required
- Example
- [ "push", "pull_request" ]
string
active
boolean
required
- Example
- true
config
object (config)
required
url
string
- Example
- "\"http://example.com/2\""
insecure_ssl
string
- Example
- "\"0\""
content_type
string
- Example
- "\"form\""
secret
string
- Example
- "\"********\""
updated_at
string
date-time
required
- Example
- "2011-09-06T20:39:23Z"
created_at
string
date-time
required
- Example
- "2011-09-06T17:26:27Z"
type
string
required
Link
string
Create an organization webhook
Here's how you can create a hook that posts payloads in JSON format:
name
string
required
Must be passed as "web".
config
object (config)
required
Key/value pairs to provide settings for this webhook. These are defined below.
url
string
uri
required
The URL to which the payloads will be delivered.
- Example
- "https://example.com/webhook"
content_type
string
The media type used to serialize the payloads. Supported values include json
and form
. The default is form
.
- Example
- "\"json\""
secret
string
If provided, the secret
will be used as the key
to generate the HMAC hex digest value for delivery signature headers.
- Example
- "\"********\""
insecure_ssl
One Of
string
Determines whether the SSL certificate of the host for url
will be verified when delivering payloads. Supported values include 0
(verification is performed) and 1
(verification is not performed). The default is 0
. We strongly recommend not setting this to 1
as you are subject to man-in-the-middle and other attacks.
- Example
- "\"0\""
number
username
string
- Example
- "\"kdaigle\""
password
string
- Example
- "\"password\""
events
array[string]
Determines what events the hook is triggered for. Set to ["*"]
to receive all possible events.
- Default
- [ "push" ]
string
active
boolean
Determines if notifications are sent when the webhook is triggered. Set to true
to send notifications.
- Default
- true
org
string
required
The organization name. The name is not case sensitive.
Request
{
"name": "web",
"active": true,
"events": [
"push",
"pull_request"
],
"config": {
"url": "http://example.com/webhook",
"content_type": "json"
}
}
Response
Response
{
"id": 1,
"url": "https://api.github.com/orgs/octocat/hooks/1",
"ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings",
"deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries",
"name": "web",
"events": [
"push",
"pull_request"
],
"active": true,
"config": {
"url": "http://example.com",
"content_type": "json"
},
"updated_at": "2011-09-06T20:39:23Z",
"created_at": "2011-09-06T17:26:27Z",
"type": "Organization"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
id
int
required
- Example
- 1
url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat/hooks/1"
ping_url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat/hooks/1/pings"
deliveries_url
string
uri
- Example
- "https://api.github.com/orgs/octocat/hooks/1/deliveries"
name
string
required
- Example
- "web"
events
array[string]
required
- Example
- [ "push", "pull_request" ]
string
active
boolean
required
- Example
- true
config
object (config)
required
url
string
- Example
- "\"http://example.com/2\""
insecure_ssl
string
- Example
- "\"0\""
content_type
string
- Example
- "\"form\""
secret
string
- Example
- "\"********\""
updated_at
string
date-time
required
- Example
- "2011-09-06T20:39:23Z"
created_at
string
date-time
required
- Example
- "2011-09-06T17:26:27Z"
type
string
required
Location
string
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
{
"resource": "string",
"field": "string",
"message": "string",
"code": "string",
"index": 123,
"value": "string"
}
]
}
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
Get an organization webhook
Returns a webhook configured in an organization. To get only the webhook config
properties, see "Get a webhook configuration for an organization."
org
string
required
The organization name. The name is not case sensitive.
hook_id
int
required
The unique identifier of the hook.
Response
Response
{
"id": 1,
"url": "https://api.github.com/orgs/octocat/hooks/1",
"ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings",
"deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries",
"name": "web",
"events": [
"push",
"pull_request"
],
"active": true,
"config": {
"url": "http://example.com",
"content_type": "json"
},
"updated_at": "2011-09-06T20:39:23Z",
"created_at": "2011-09-06T17:26:27Z",
"type": "Organization"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
id
int
required
- Example
- 1
url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat/hooks/1"
ping_url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat/hooks/1/pings"
deliveries_url
string
uri
- Example
- "https://api.github.com/orgs/octocat/hooks/1/deliveries"
name
string
required
- Example
- "web"
events
array[string]
required
- Example
- [ "push", "pull_request" ]
string
active
boolean
required
- Example
- true
config
object (config)
required
url
string
- Example
- "\"http://example.com/2\""
insecure_ssl
string
- Example
- "\"0\""
content_type
string
- Example
- "\"form\""
secret
string
- Example
- "\"********\""
updated_at
string
date-time
required
- Example
- "2011-09-06T20:39:23Z"
created_at
string
date-time
required
- Example
- "2011-09-06T17:26:27Z"
type
string
required
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
org
string
required
The organization name. The name is not case sensitive.
hook_id
int
required
The unique identifier of the hook.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
message
string
documentation_url
string
url
string
status
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Update an organization webhook
Updates a webhook configured in an organization. When you update a webhook, the secret
will be overwritten. If you previously had a secret
set, you must provide the same secret
or set a new secret
or the secret will be removed. If you are only updating individual webhook config
properties, use "Update a webhook configuration for an organization."
config
object (config)
Key/value pairs to provide settings for this webhook. These are defined below.
url
string
uri
required
The URL to which the payloads will be delivered.
- Example
- "https://example.com/webhook"
content_type
string
The media type used to serialize the payloads. Supported values include json
and form
. The default is form
.
- Example
- "\"json\""
secret
string
If provided, the secret
will be used as the key
to generate the HMAC hex digest value for delivery signature headers.
- Example
- "\"********\""
insecure_ssl
One Of
string
Determines whether the SSL certificate of the host for url
will be verified when delivering payloads. Supported values include 0
(verification is performed) and 1
(verification is not performed). The default is 0
. We strongly recommend not setting this to 1
as you are subject to man-in-the-middle and other attacks.
- Example
- "\"0\""
number
events
array[string]
Determines what events the hook is triggered for.
- Default
- [ "push" ]
string
active
boolean
Determines if notifications are sent when the webhook is triggered. Set to true
to send notifications.
- Default
- true
name
string
- Example
- "\"web\""
org
string
required
The organization name. The name is not case sensitive.
hook_id
int
required
The unique identifier of the hook.
Request
{
"active": true,
"events": [
"pull_request"
]
}
Response
Response
{
"id": 1,
"url": "https://api.github.com/orgs/octocat/hooks/1",
"ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings",
"deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries",
"name": "web",
"events": [
"pull_request"
],
"active": true,
"config": {
"url": "http://example.com",
"content_type": "json"
},
"updated_at": "2011-09-06T20:39:23Z",
"created_at": "2011-09-06T17:26:27Z",
"type": "Organization"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
id
int
required
- Example
- 1
url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat/hooks/1"
ping_url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat/hooks/1/pings"
deliveries_url
string
uri
- Example
- "https://api.github.com/orgs/octocat/hooks/1/deliveries"
name
string
required
- Example
- "web"
events
array[string]
required
- Example
- [ "push", "pull_request" ]
string
active
boolean
required
- Example
- true
config
object (config)
required
url
string
- Example
- "\"http://example.com/2\""
insecure_ssl
string
- Example
- "\"0\""
content_type
string
- Example
- "\"form\""
secret
string
- Example
- "\"********\""
updated_at
string
date-time
required
- Example
- "2011-09-06T20:39:23Z"
created_at
string
date-time
required
- Example
- "2011-09-06T17:26:27Z"
type
string
required
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
{
"resource": "string",
"field": "string",
"message": "string",
"code": "string",
"index": 123,
"value": "string"
}
]
}
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
Get a webhook configuration for an organization
Returns the webhook configuration for an organization. To get more information about the webhook, including the active
state and events
, use "Get an organization webhook ."
Access tokens must have the admin:org_hook
scope, and GitHub Apps must have the organization_hooks:read
permission.
org
string
required
The organization name. The name is not case sensitive.
hook_id
int
required
The unique identifier of the hook.
Response
Response
{
"content_type": "json",
"insecure_ssl": "0",
"secret": "********",
"url": "https://example.com/webhook"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
url
string
uri
The URL to which the payloads will be delivered.
- Example
- "https://example.com/webhook"
content_type
string
The media type used to serialize the payloads. Supported values include json
and form
. The default is form
.
- Example
- "\"json\""
secret
string
If provided, the secret
will be used as the key
to generate the HMAC hex digest value for delivery signature headers.
- Example
- "\"********\""
insecure_ssl
One Of
string
Determines whether the SSL certificate of the host for url
will be verified when delivering payloads. Supported values include 0
(verification is performed) and 1
(verification is not performed). The default is 0
. We strongly recommend not setting this to 1
as you are subject to man-in-the-middle and other attacks.
- Example
- "\"0\""
number
Update a webhook configuration for an organization
Updates the webhook configuration for an organization. To update more information about the webhook, including the active
state and events
, use "Update an organization webhook ."
Access tokens must have the admin:org_hook
scope, and GitHub Apps must have the organization_hooks:write
permission.
url
string
uri
The URL to which the payloads will be delivered.
- Example
- "https://example.com/webhook"
content_type
string
The media type used to serialize the payloads. Supported values include json
and form
. The default is form
.
- Example
- "\"json\""
secret
string
If provided, the secret
will be used as the key
to generate the HMAC hex digest value for delivery signature headers.
- Example
- "\"********\""
insecure_ssl
One Of
string
Determines whether the SSL certificate of the host for url
will be verified when delivering payloads. Supported values include 0
(verification is performed) and 1
(verification is not performed). The default is 0
. We strongly recommend not setting this to 1
as you are subject to man-in-the-middle and other attacks.
- Example
- "\"0\""
number
org
string
required
The organization name. The name is not case sensitive.
hook_id
int
required
The unique identifier of the hook.
Request
{
"url": "http://example.com/webhook",
"content_type": "json",
"insecure_ssl": "0",
"secret": "********"
}
Response
Response
{
"content_type": "json",
"insecure_ssl": "0",
"secret": "********",
"url": "https://example.com/webhook"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
url
string
uri
The URL to which the payloads will be delivered.
- Example
- "https://example.com/webhook"
content_type
string
The media type used to serialize the payloads. Supported values include json
and form
. The default is form
.
- Example
- "\"json\""
secret
string
If provided, the secret
will be used as the key
to generate the HMAC hex digest value for delivery signature headers.
- Example
- "\"********\""
insecure_ssl
One Of
string
Determines whether the SSL certificate of the host for url
will be verified when delivering payloads. Supported values include 0
(verification is performed) and 1
(verification is not performed). The default is 0
. We strongly recommend not setting this to 1
as you are subject to man-in-the-middle and other attacks.
- Example
- "\"0\""
number
List deliveries for an organization webhook
Returns a list of webhook deliveries for a webhook configured in an organization.
per_page
int
The number of results per page (max 100).
- Default
- 30
cursor
string
Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the link
header for the next and previous page cursors.
redelivery
boolean
org
string
required
The organization name. The name is not case sensitive.
hook_id
int
required
The unique identifier of the hook.
Response
Response
[
{
"id": 12345678,
"guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
"delivered_at": "2019-06-03T00:57:16Z",
"redelivery": false,
"duration": 0.27,
"status": "OK",
"status_code": 200,
"event": "issues",
"action": "opened",
"installation_id": 123,
"repository_id": 456
},
{
"id": 123456789,
"guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
"delivered_at": "2019-06-04T00:57:16Z",
"redelivery": true,
"duration": 0.28,
"status": "OK",
"status_code": 200,
"event": "issues",
"action": "opened",
"installation_id": 123,
"repository_id": 456
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
message
string or null
documentation_url
string or null
detail
string or null
status
int
scimType
string or null
schemas
array[string]
string
Bad Request
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
{
"resource": "string",
"field": "string",
"message": "string",
"code": "string",
"index": 123,
"value": "string"
}
]
}
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
array[object (Simple webhook delivery)]
- Content Type
- application/json
Simple webhook delivery
object (Simple webhook delivery)
Delivery made by a webhook, without request and response information.
id
int
required
Unique identifier of the webhook delivery.
- Example
- 42
guid
string
required
Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).
- Example
- "58474f00-b361-11eb-836d-0e4f3503ccbe"
delivered_at
string
date-time
required
Time when the webhook delivery occurred.
- Example
- "2021-05-12T20:33:44Z"
redelivery
boolean
required
Whether the webhook delivery is a redelivery.
- Example
- false
duration
number
required
Time spent delivering.
- Example
- 0.03
status
string
required
Describes the response returned after attempting the delivery.
- Example
- "failed to connect"
status_code
int
required
Status code received when delivery was made.
- Example
- 502
event
string
required
The event that triggered the delivery.
- Example
- "issues"
action
string or null
required
The type of activity for the event that triggered the delivery.
- Example
- "opened"
installation_id
int or null
required
The id of the GitHub App installation associated with this event.
- Example
- 123
repository_id
int or null
required
The id of the repository associated with this event.
- Example
- 123
Get a webhook delivery for an organization webhook
Returns a delivery for a webhook configured in an organization.
org
string
required
The organization name. The name is not case sensitive.
hook_id
int
required
The unique identifier of the hook.
delivery_id
int
required
Response
Response
{
"id": 12345678,
"guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
"delivered_at": "2019-06-03T00:57:16Z",
"redelivery": false,
"duration": 0.27,
"status": "OK",
"status_code": 200,
"event": "issues",
"action": "opened",
"installation_id": 123,
"repository_id": 456,
"url": "https://www.example.com",
"request": {
"headers": {
"X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
"X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
"Accept": "*/*",
"X-GitHub-Hook-ID": "42",
"User-Agent": "GitHub-Hookshot/b8c71d8",
"X-GitHub-Event": "issues",
"X-GitHub-Hook-Installation-Target-ID": "123",
"X-GitHub-Hook-Installation-Target-Type": "repository",
"content-type": "application/json",
"X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d"
},
"payload": {
"action": "opened",
"issue": {
"body": "foo"
},
"repository": {
"id": 123
}
}
},
"response": {
"headers": {
"Content-Type": "text/html;charset=utf-8"
},
"payload": "ok"
}
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
message
string or null
documentation_url
string or null
detail
string or null
status
int
scimType
string or null
schemas
array[string]
string
Bad Request
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
{
"resource": "string",
"field": "string",
"message": "string",
"code": "string",
"index": 123,
"value": "string"
}
]
}
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
id
int
required
Unique identifier of the delivery.
- Example
- 42
guid
string
required
Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).
- Example
- "58474f00-b361-11eb-836d-0e4f3503ccbe"
delivered_at
string
date-time
required
Time when the delivery was delivered.
- Example
- "2021-05-12T20:33:44Z"
redelivery
boolean
required
Whether the delivery is a redelivery.
- Example
- false
duration
number
required
Time spent delivering.
- Example
- 0.03
status
string
required
Description of the status of the attempted delivery
- Example
- "failed to connect"
status_code
int
required
Status code received when delivery was made.
- Example
- 502
event
string
required
The event that triggered the delivery.
- Example
- "issues"
action
string or null
required
The type of activity for the event that triggered the delivery.
- Example
- "opened"
installation_id
int or null
required
The id of the GitHub App installation associated with this event.
- Example
- 123
repository_id
int or null
required
The id of the repository associated with this event.
- Example
- 123
url
string
The URL target of the delivery.
- Example
- "https://www.example.com"
request
object (request)
required
headers
object (headers) or null
required
The request headers sent with the webhook delivery.
payload
object (payload) or null
required
The webhook payload.
response
object (response)
required
headers
object (headers) or null
required
The response headers received when the delivery was made.
payload
string or null
required
The response payload received.
Redeliver a delivery for an organization webhook
Redeliver a delivery for a webhook configured in an organization.
org
string
required
The organization name. The name is not case sensitive.
hook_id
int
required
The unique identifier of the hook.
delivery_id
int
required
Response
Accepted
null
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
message
string
documentation_url
string
url
string
status
string
message
string or null
documentation_url
string or null
detail
string or null
status
int
scimType
string or null
schemas
array[string]
string
Bad Request
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
{
"resource": "string",
"field": "string",
"message": "string",
"code": "string",
"index": 123,
"value": "string"
}
]
}
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
Ping an organization webhook
This will trigger a ping event to be sent to the hook.
org
string
required
The organization name. The name is not case sensitive.
hook_id
int
required
The unique identifier of the hook.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
message
string
documentation_url
string
url
string
status
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
List app installations for an organization
Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with admin:read
scope to use this endpoint.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"total_count": 1,
"installations": [
{
"id": 25381,
"account": {
"login": "octo-org",
"id": 6811672,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
"avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/octo-org",
"html_url": "https://github.com/octo-org",
"followers_url": "https://api.github.com/users/octo-org/followers",
"following_url": "https://api.github.com/users/octo-org/following{/other_user}",
"gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
"organizations_url": "https://api.github.com/users/octo-org/orgs",
"repos_url": "https://api.github.com/users/octo-org/repos",
"events_url": "https://api.github.com/users/octo-org/events{/privacy}",
"received_events_url": "https://api.github.com/users/octo-org/received_events",
"type": "Organization",
"site_admin": false
},
"repository_selection": "selected",
"access_tokens_url": "https://api.github.com/app/installations/25381/access_tokens",
"repositories_url": "https://api.github.com/installation/repositories",
"html_url": "https://github.com/organizations/octo-org/settings/installations/25381",
"app_id": 2218,
"target_id": 6811672,
"target_type": "Organization",
"permissions": {
"deployments": "write",
"metadata": "read",
"pull_requests": "read",
"statuses": "read"
},
"events": [
"deployment",
"deployment_status"
],
"created_at": "2017-05-16T08:47:09.000-07:00",
"updated_at": "2017-06-06T11:23:23.000-07:00",
"single_file_name": "config.yml",
"has_multiple_single_files": true,
"single_file_paths": [
"config.yml",
".github/issue_TEMPLATE.md"
],
"app_slug": "github-actions",
"suspended_at": null,
"suspended_by": null
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
installations
array[object (Installation)]
required
Installation
object (Installation)
Installation
id
int
required
The ID of the installation.
- Example
- 1
account
Any Of or null
required
Simple User
object (Simple User)
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
Enterprise
object (Enterprise)
An enterprise on GitHub.
description
string or null
A short description of the enterprise.
html_url
string
uri
required
- Example
- "https://github.com/enterprises/octo-business"
website_url
string or null
uri
The enterprise's website URL.
id
int
required
Unique identifier of the enterprise
- Example
- 42
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
The name of the enterprise.
- Example
- "Octo Business"
slug
string
required
The slug url identifier for the enterprise.
- Example
- "octo-business"
created_at
string or null
date-time
required
- Example
- "2019-01-26T19:01:12Z"
updated_at
string or null
date-time
required
- Example
- "2019-01-26T19:14:43Z"
avatar_url
string
uri
required
repository_selection
string
required
Describe whether all repositories have been selected or there's a selection involved
- Enum
-
- all
- selected
access_tokens_url
string
uri
required
- Example
- "https://api.github.com/installations/1/access_tokens"
repositories_url
string
uri
required
- Example
- "https://api.github.com/installation/repositories"
html_url
string
uri
required
- Example
- "https://github.com/organizations/github/settings/installations/1"
app_id
int
required
- Example
- 1
target_id
int
required
The ID of the user or organization this token is being scoped to.
target_type
string
required
- Example
- "Organization"
permissions
object (permissions)
required
The permissions granted to the user-to-server access token.
- Example
- { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" }
actions
string
The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.
- Enum
-
- read
- write
administration
string
The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.
- Enum
-
- read
- write
checks
string
The level of permission to grant the access token for checks on code.
- Enum
-
- read
- write
contents
string
The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.
- Enum
-
- read
- write
deployments
string
The level of permission to grant the access token for deployments and deployment statuses.
- Enum
-
- read
- write
environments
string
The level of permission to grant the access token for managing repository environments.
- Enum
-
- read
- write
issues
string
The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.
- Enum
-
- read
- write
metadata
string
The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.
- Enum
-
- read
- write
packages
string
The level of permission to grant the access token for packages published to GitHub Packages.
- Enum
-
- read
- write
pages
string
The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.
- Enum
-
- read
- write
pull_requests
string
The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.
- Enum
-
- read
- write
repository_hooks
string
The level of permission to grant the access token to manage the post-receive hooks for a repository.
- Enum
-
- read
- write
repository_projects
string
The level of permission to grant the access token to manage repository projects, columns, and cards.
- Enum
-
- read
- write
- admin
secret_scanning_alerts
string
The level of permission to grant the access token to view and manage secret scanning alerts.
- Enum
-
- read
- write
secrets
string
The level of permission to grant the access token to manage repository secrets.
- Enum
-
- read
- write
security_events
string
The level of permission to grant the access token to view and manage security events like code scanning alerts.
- Enum
-
- read
- write
single_file
string
The level of permission to grant the access token to manage just a single file.
- Enum
-
- read
- write
statuses
string
The level of permission to grant the access token for commit statuses.
- Enum
-
- read
- write
vulnerability_alerts
string
The level of permission to grant the access token to manage Dependabot alerts.
- Enum
-
- read
- write
workflows
string
The level of permission to grant the access token to update GitHub Actions workflow files.
- Enum
-
- write
members
string
The level of permission to grant the access token for organization teams and members.
- Enum
-
- read
- write
organization_administration
string
The level of permission to grant the access token to manage access to an organization.
- Enum
-
- read
- write
organization_custom_roles
string
The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change.
- Enum
-
- read
- write
organization_announcement_banners
string
The level of permission to grant the access token to view and manage announcement banners for an organization.
- Enum
-
- read
- write
organization_hooks
string
The level of permission to grant the access token to manage the post-receive hooks for an organization.
- Enum
-
- read
- write
organization_personal_access_tokens
string
The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.
- Enum
-
- read
- write
organization_personal_access_token_requests
string
The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.
- Enum
-
- read
- write
organization_plan
string
The level of permission to grant the access token for viewing an organization's plan.
- Enum
-
- read
organization_projects
string
The level of permission to grant the access token to manage organization projects and projects beta (where available).
- Enum
-
- read
- write
- admin
organization_packages
string
The level of permission to grant the access token for organization packages published to GitHub Packages.
- Enum
-
- read
- write
organization_secrets
string
The level of permission to grant the access token to manage organization secrets.
- Enum
-
- read
- write
organization_self_hosted_runners
string
The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.
- Enum
-
- read
- write
organization_user_blocking
string
The level of permission to grant the access token to view and manage users blocked by the organization.
- Enum
-
- read
- write
team_discussions
string
The level of permission to grant the access token to manage team discussions and related comments.
- Enum
-
- read
- write
events
array[string]
required
string
created_at
string
date-time
required
updated_at
string
date-time
required
single_file_name
string or null
required
- Example
- "config.yaml"
has_multiple_single_files
boolean
- Example
- true
single_file_paths
array[string]
- Example
- [ "config.yml", ".github/issue_TEMPLATE.md" ]
string
app_slug
string
required
- Example
- "github-actions"
suspended_by
object (suspended_by) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
suspended_at
string or null
date-time
required
contact_email
string or null
- Example
- "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\""
Link
string
List organization members
List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
filter
string
Filter members returned in the list. 2fa_disabled
means that only members without two-factor authentication enabled will be returned. This options is only available for organization owners.
- Default
- "all"
- Enum
-
- 2fa_disabled
- all
role
string
Filter members returned by their role.
- Default
- "all"
- Enum
-
- all
- admin
- member
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
org
string
required
The organization name. The name is not case sensitive.
Response
Response
[
{
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
{
"resource": "string",
"field": "string",
"message": "string",
"code": "string",
"index": 123,
"value": "string"
}
]
}
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
array[object (Simple User)]
- Content Type
- application/json
Simple User
object (Simple User)
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
Link
string
Check organization membership for a user
Check if a user is, publicly or privately, a member of the organization.
org
string
required
The organization name. The name is not case sensitive.
username
string
required
The handle for the GitHub user account.
Response
Response if requester is an organization member and user is a member
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
No schema
Location
string
Response if requester is not an organization member
Empty response
Not Found if requester is an organization member and user is not a member
Empty response
Remove an organization member
Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
org
string
required
The organization name. The name is not case sensitive.
username
string
required
The handle for the GitHub user account.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
message
string
documentation_url
string
url
string
status
string
Forbidden
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Get organization membership for a user
In order to get a user's membership with an organization, the authenticated user must be an organization member. The state
parameter in the response can be used to identify the user's membership status.
org
string
required
The organization name. The name is not case sensitive.
username
string
required
The handle for the GitHub user account.
Response
Response
{
"url": "https://api.github.com/orgs/octocat/memberships/defunkt",
"state": "active",
"role": "admin",
"organization_url": "https://api.github.com/orgs/octocat",
"organization": {
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/github",
"repos_url": "https://api.github.com/orgs/github/repos",
"events_url": "https://api.github.com/orgs/github/events",
"hooks_url": "https://api.github.com/orgs/github/hooks",
"issues_url": "https://api.github.com/orgs/github/issues",
"members_url": "https://api.github.com/orgs/github/members{/member}",
"public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization"
},
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
}
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Forbidden
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat/memberships/defunkt"
state
string
required
The state of the member in the organization. The pending
state indicates the user has not yet accepted an invitation.
- Enum
-
- active
- pending
- Example
- "active"
role
string
required
The user's membership type in the organization.
- Enum
-
- admin
- member
- billing_manager
- Example
- "admin"
organization_url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat"
organization
object (organization)
required
A GitHub organization.
login
string
required
- Example
- "github"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDEyOk9yZ2FuaXphdGlvbjE="
url
string
uri
required
- Example
- "https://api.github.com/orgs/github"
repos_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/repos"
events_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/events"
hooks_url
string
required
- Example
- "https://api.github.com/orgs/github/hooks"
issues_url
string
required
- Example
- "https://api.github.com/orgs/github/issues"
members_url
string
required
- Example
- "https://api.github.com/orgs/github/members{/member}"
public_members_url
string
required
- Example
- "https://api.github.com/orgs/github/public_members{/member}"
avatar_url
string
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
description
string or null
required
- Example
- "A great organization"
user
object (user) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
permissions
object (permissions)
can_create_repository
boolean
required
Set organization membership for a user
Only authenticated organization owners can add a member to the organization or update the member's role.
If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be
pending
until they accept the invitation.Authenticated users can update a user's membership by passing the
role
parameter. If the authenticated user changes a member's role toadmin
, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role tomember
, no email will be sent.
Rate limits
To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
role
string
The role to give the user in the organization. Can be one of:
admin
- The user will become an owner of the organization.member
- The user will become a non-owner member of the organization.
- Default
- "member"
- Enum
-
- admin
- member
org
string
required
The organization name. The name is not case sensitive.
username
string
required
The handle for the GitHub user account.
Request
{
"role": "member"
}
Response
Response
{
"url": "https://api.github.com/orgs/octocat/memberships/defunkt",
"state": "active",
"role": "admin",
"organization_url": "https://api.github.com/orgs/octocat",
"organization": {
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/github",
"repos_url": "https://api.github.com/orgs/github/repos",
"events_url": "https://api.github.com/orgs/github/events",
"hooks_url": "https://api.github.com/orgs/github/hooks",
"issues_url": "https://api.github.com/orgs/github/issues",
"members_url": "https://api.github.com/orgs/github/members{/member}",
"public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization"
},
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
}
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
{
"resource": "string",
"field": "string",
"message": "string",
"code": "string",
"index": 123,
"value": "string"
}
]
}
Forbidden
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat/memberships/defunkt"
state
string
required
The state of the member in the organization. The pending
state indicates the user has not yet accepted an invitation.
- Enum
-
- active
- pending
- Example
- "active"
role
string
required
The user's membership type in the organization.
- Enum
-
- admin
- member
- billing_manager
- Example
- "admin"
organization_url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat"
organization
object (organization)
required
A GitHub organization.
login
string
required
- Example
- "github"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDEyOk9yZ2FuaXphdGlvbjE="
url
string
uri
required
- Example
- "https://api.github.com/orgs/github"
repos_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/repos"
events_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/events"
hooks_url
string
required
- Example
- "https://api.github.com/orgs/github/hooks"
issues_url
string
required
- Example
- "https://api.github.com/orgs/github/issues"
members_url
string
required
- Example
- "https://api.github.com/orgs/github/members{/member}"
public_members_url
string
required
- Example
- "https://api.github.com/orgs/github/public_members{/member}"
avatar_url
string
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
description
string or null
required
- Example
- "A great organization"
user
object (user) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
permissions
object (permissions)
can_create_repository
boolean
required
Remove organization membership for a user
In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
org
string
required
The organization name. The name is not case sensitive.
username
string
required
The handle for the GitHub user account.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
Forbidden
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
List outside collaborators for an organization
List all users who are outside collaborators of an organization.
filter
string
Filter the list of outside collaborators. 2fa_disabled
means that only outside collaborators without two-factor authentication enabled will be returned.
- Default
- "all"
- Enum
-
- 2fa_disabled
- all
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
org
string
required
The organization name. The name is not case sensitive.
Response
Response
[
{
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
array[object (Simple User)]
- Content Type
- application/json
Simple User
object (Simple User)
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
Link
string
Convert an organization member to outside collaborator
When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "Converting an organization member to an outside collaborator". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "Enforcing repository management policies in your enterprise."
async
boolean
When set to true
, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.
- Default
- false
org
string
required
The organization name. The name is not case sensitive.
username
string
required
The handle for the GitHub user account.
Request
{
"async": true
}
null
Response
User is getting converted asynchronously
null
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
No schema
message
string
documentation_url
string
url
string
status
string
User was converted
Empty response
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "Enforcing repository management policies in your enterprise."
Empty response
Remove outside collaborator from an organization
Removing a user from this list will remove them from all the organization's repositories.
org
string
required
The organization name. The name is not case sensitive.
username
string
required
The handle for the GitHub user account.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
message
string
documentation_url
string
Unprocessable Entity if user is a member of the organization
{
"message": "You cannot specify an organization member to remove as an outside collaborator.",
"documentation_url": "https://docs.github.com/enterprise-server@3.9/rest/reference/orgs#remove-outside-collaborator"
}
List public organization members
Members of an organization can choose to have their membership publicized or not.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
org
string
required
The organization name. The name is not case sensitive.
Response
Response
[
{
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
array[object (Simple User)]
- Content Type
- application/json
Simple User
object (Simple User)
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
Link
string
org
string
required
The organization name. The name is not case sensitive.
username
string
required
The handle for the GitHub user account.
Response
Response if user is a public member
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
Not Found if user is not a public member
Empty response
Set public organization membership for the authenticated user
The user can publicize their own membership. (A user cannot publicize the membership for another user.)
Note that you'll need to set Content-Length
to zero when calling out to this endpoint. For more information, see "HTTP verbs."
org
string
required
The organization name. The name is not case sensitive.
username
string
required
The handle for the GitHub user account.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
message
string
documentation_url
string
url
string
status
string
Forbidden
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Remove public organization membership for the authenticated user
org
string
required
The organization name. The name is not case sensitive.
username
string
required
The handle for the GitHub user account.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
List repository fine-grained permissions for an organization
Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "About custom repository roles."
To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization and must use an access token with the admin:org
or repo
scope.
GitHub Apps must have the organization_custom_roles:read
or organization_administration:read
organization permission to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
Response
Response
[
{
"name": "add_assignee",
"description": "Assign or remove a user"
},
{
"name": "remove_assignee",
"description": "Remove an assigned user"
},
{
"name": "add_label",
"description": "Add or remove a label"
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
array[object (Repository Fine-Grained Permission)]
- Content Type
- application/json
Repository Fine-Grained Permission
object (Repository Fine-Grained Permission)
A fine-grained permission that protects repository resources.
name
string
required
description
string
required
List security manager teams
Lists teams that are security managers for an organization. For more information, see "Managing security managers in your organization."
To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the read:org
scope.
GitHub Apps must have the administration
organization read permission to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
Response
Response
[
{
"id": 1,
"node_id": "MDQ6VGVhbTE=",
"url": "https://api.github.com/teams/1",
"html_url": "https://github.com/orgs/github/teams/justice-league",
"name": "Justice League",
"slug": "justice-league",
"description": "A great team.",
"privacy": "closed",
"permission": "admin",
"members_url": "https://api.github.com/teams/1/members{/member}",
"repositories_url": "https://api.github.com/teams/1/repos",
"parent": null
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
array[object (Team Simple)]
- Content Type
- application/json
Team Simple
object (Team Simple)
Groups of organization members that gives permissions on specified repositories.
id
int
required
Unique identifier of the team
- Example
- 1
node_id
string
required
- Example
- "MDQ6VGVhbTE="
url
string
uri
required
URL for the team
- Example
- "https://api.github.com/organizations/1/team/1"
members_url
string
required
- Example
- "https://api.github.com/organizations/1/team/1/members{/member}"
name
string
required
Name of the team
- Example
- "Justice League"
description
string or null
required
Description of the team
- Example
- "A great team."
permission
string
required
Permission that the team will have for its repositories
- Example
- "admin"
privacy
string
The level of privacy this team should have
- Example
- "closed"
html_url
string
uri
required
- Example
- "https://github.com/orgs/rails/teams/core"
repositories_url
string
uri
required
- Example
- "https://api.github.com/organizations/1/team/1/repos"
slug
string
required
- Example
- "justice-league"
ldap_dn
string
Distinguished Name (DN) that team maps to within LDAP environment
- Example
- "uid=example,ou=users,dc=github,dc=com"
Add a security manager team
Adds a team as a security manager for an organization. For more information, see "Managing security for an organization for an organization."
To use this endpoint, you must be an administrator for the organization, and you must use an access token with the write:org
scope.
GitHub Apps must have the administration
organization read-write permission to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
team_slug
string
required
The slug of the team name.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
The organization has reached the maximum number of security manager teams.
Empty response
Remove a security manager team
Removes the security manager role from a team for an organization. For more information, see "Managing security managers in your organization team from an organization."
To use this endpoint, you must be an administrator for the organization, and you must use an access token with the admin:org
scope.
GitHub Apps must have the administration
organization read-write permission to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
team_slug
string
required
The slug of the team name.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Enable or disable a security feature for an organization
Enables or disables the specified security feature for all eligible repositories in an organization.
To use this endpoint, you must be an organization owner or be member of a team with the security manager role. A token with the 'write:org' scope is also required.
GitHub Apps must have the organization_administration:write
permission to use this endpoint.
For more information, see "Managing security managers in your organization."
org
string
required
The organization name. The name is not case sensitive.
security_product
string
required
The security feature to enable or disable.
- Enum
-
- dependency_graph
- dependabot_alerts
- dependabot_security_updates
- advanced_security
- code_scanning_default_setup
- secret_scanning
- secret_scanning_push_protection
enablement
string
required
The action to take.
enable_all
means to enable the specified security feature for all repositories in the organization.
disable_all
means to disable the specified security feature for all repositories in the organization.
- Enum
-
- enable_all
- disable_all
Response
Action started
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
The action could not be taken due to an in progress enablement, or a policy is preventing enablement
Empty response
state
string
Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.
- Enum
-
- active
- pending
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
Response
Response
[
{
"url": "https://api.github.com/orgs/octocat/memberships/defunkt",
"state": "active",
"role": "admin",
"organization_url": "https://api.github.com/orgs/octocat",
"organization": {
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/github",
"repos_url": "https://api.github.com/orgs/github/repos",
"events_url": "https://api.github.com/orgs/github/events",
"hooks_url": "https://api.github.com/orgs/github/hooks",
"issues_url": "https://api.github.com/orgs/github/issues",
"members_url": "https://api.github.com/orgs/github/members{/member}",
"public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization"
},
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
}
},
{
"url": "https://api.github.com/orgs/invitocat/memberships/defunkt",
"state": "pending",
"role": "admin",
"organization_url": "https://api.github.com/orgs/invitocat",
"organization": {
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/github",
"repos_url": "https://api.github.com/orgs/github/repos",
"events_url": "https://api.github.com/orgs/github/events",
"hooks_url": "https://api.github.com/orgs/github/hooks",
"issues_url": "https://api.github.com/orgs/github/issues",
"members_url": "https://api.github.com/orgs/github/members{/member}",
"public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization"
},
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
}
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
Not modified
Empty response
Forbidden
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Requires authentication
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
{
"resource": "string",
"field": "string",
"message": "string",
"code": "string",
"index": 123,
"value": "string"
}
]
}
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
array[object (Org Membership)]
- Content Type
- application/json
Org Membership
object (Org Membership)
Org Membership
url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat/memberships/defunkt"
state
string
required
The state of the member in the organization. The pending
state indicates the user has not yet accepted an invitation.
- Enum
-
- active
- pending
- Example
- "active"
role
string
required
The user's membership type in the organization.
- Enum
-
- admin
- member
- billing_manager
- Example
- "admin"
organization_url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat"
organization
object (organization)
required
A GitHub organization.
login
string
required
- Example
- "github"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDEyOk9yZ2FuaXphdGlvbjE="
url
string
uri
required
- Example
- "https://api.github.com/orgs/github"
repos_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/repos"
events_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/events"
hooks_url
string
required
- Example
- "https://api.github.com/orgs/github/hooks"
issues_url
string
required
- Example
- "https://api.github.com/orgs/github/issues"
members_url
string
required
- Example
- "https://api.github.com/orgs/github/members{/member}"
public_members_url
string
required
- Example
- "https://api.github.com/orgs/github/public_members{/member}"
avatar_url
string
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
description
string or null
required
- Example
- "A great organization"
user
object (user) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
permissions
object (permissions)
can_create_repository
boolean
required
Link
string
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"url": "https://api.github.com/orgs/invitocat/memberships/defunkt",
"state": "pending",
"role": "admin",
"organization_url": "https://api.github.com/orgs/invitocat",
"organization": {
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/github",
"repos_url": "https://api.github.com/orgs/github/repos",
"events_url": "https://api.github.com/orgs/github/events",
"hooks_url": "https://api.github.com/orgs/github/hooks",
"issues_url": "https://api.github.com/orgs/github/issues",
"members_url": "https://api.github.com/orgs/github/members{/member}",
"public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization"
},
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
}
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
Forbidden
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat/memberships/defunkt"
state
string
required
The state of the member in the organization. The pending
state indicates the user has not yet accepted an invitation.
- Enum
-
- active
- pending
- Example
- "active"
role
string
required
The user's membership type in the organization.
- Enum
-
- admin
- member
- billing_manager
- Example
- "admin"
organization_url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat"
organization
object (organization)
required
A GitHub organization.
login
string
required
- Example
- "github"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDEyOk9yZ2FuaXphdGlvbjE="
url
string
uri
required
- Example
- "https://api.github.com/orgs/github"
repos_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/repos"
events_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/events"
hooks_url
string
required
- Example
- "https://api.github.com/orgs/github/hooks"
issues_url
string
required
- Example
- "https://api.github.com/orgs/github/issues"
members_url
string
required
- Example
- "https://api.github.com/orgs/github/members{/member}"
public_members_url
string
required
- Example
- "https://api.github.com/orgs/github/public_members{/member}"
avatar_url
string
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
description
string or null
required
- Example
- "A great organization"
user
object (user) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
permissions
object (permissions)
can_create_repository
boolean
required
state
string
required
The state that the membership should be in. Only "active"
will be accepted.
- Enum
-
- active
org
string
required
The organization name. The name is not case sensitive.
Request
{
"state": "active"
}
Response
Response
{
"url": "https://api.github.com/orgs/octocat/memberships/defunkt",
"state": "active",
"role": "admin",
"organization_url": "https://api.github.com/orgs/octocat",
"organization": {
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/github",
"repos_url": "https://api.github.com/orgs/github/repos",
"events_url": "https://api.github.com/orgs/github/events",
"hooks_url": "https://api.github.com/orgs/github/hooks",
"issues_url": "https://api.github.com/orgs/github/issues",
"members_url": "https://api.github.com/orgs/github/members{/member}",
"public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization"
},
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
}
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
Forbidden
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
{
"resource": "string",
"field": "string",
"message": "string",
"code": "string",
"index": 123,
"value": "string"
}
]
}
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat/memberships/defunkt"
state
string
required
The state of the member in the organization. The pending
state indicates the user has not yet accepted an invitation.
- Enum
-
- active
- pending
- Example
- "active"
role
string
required
The user's membership type in the organization.
- Enum
-
- admin
- member
- billing_manager
- Example
- "admin"
organization_url
string
uri
required
- Example
- "https://api.github.com/orgs/octocat"
organization
object (organization)
required
A GitHub organization.
login
string
required
- Example
- "github"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDEyOk9yZ2FuaXphdGlvbjE="
url
string
uri
required
- Example
- "https://api.github.com/orgs/github"
repos_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/repos"
events_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/events"
hooks_url
string
required
- Example
- "https://api.github.com/orgs/github/hooks"
issues_url
string
required
- Example
- "https://api.github.com/orgs/github/issues"
members_url
string
required
- Example
- "https://api.github.com/orgs/github/members{/member}"
public_members_url
string
required
- Example
- "https://api.github.com/orgs/github/public_members{/member}"
avatar_url
string
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
description
string or null
required
- Example
- "A great organization"
user
object (user) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
permissions
object (permissions)
can_create_repository
boolean
required
List organizations for the authenticated user
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.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
Response
Response
[
{
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/github",
"repos_url": "https://api.github.com/orgs/github/repos",
"events_url": "https://api.github.com/orgs/github/events",
"hooks_url": "https://api.github.com/orgs/github/hooks",
"issues_url": "https://api.github.com/orgs/github/issues",
"members_url": "https://api.github.com/orgs/github/members{/member}",
"public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization"
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
Not modified
Empty response
Forbidden
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Requires authentication
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
array[object (Organization Simple)]
- Content Type
- application/json
Organization Simple
object (Organization Simple)
A GitHub organization.
login
string
required
- Example
- "github"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDEyOk9yZ2FuaXphdGlvbjE="
url
string
uri
required
- Example
- "https://api.github.com/orgs/github"
repos_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/repos"
events_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/events"
hooks_url
string
required
- Example
- "https://api.github.com/orgs/github/hooks"
issues_url
string
required
- Example
- "https://api.github.com/orgs/github/issues"
members_url
string
required
- Example
- "https://api.github.com/orgs/github/members{/member}"
public_members_url
string
required
- Example
- "https://api.github.com/orgs/github/public_members{/member}"
avatar_url
string
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
description
string or null
required
- Example
- "A great organization"
Link
string
List organizations for a user
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.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
username
string
required
The handle for the GitHub user account.
Response
Response
[
{
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/github",
"repos_url": "https://api.github.com/orgs/github/repos",
"events_url": "https://api.github.com/orgs/github/events",
"hooks_url": "https://api.github.com/orgs/github/hooks",
"issues_url": "https://api.github.com/orgs/github/issues",
"members_url": "https://api.github.com/orgs/github/members{/member}",
"public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization"
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
array[object (Organization Simple)]
- Content Type
- application/json
Organization Simple
object (Organization Simple)
A GitHub organization.
login
string
required
- Example
- "github"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDEyOk9yZ2FuaXphdGlvbjE="
url
string
uri
required
- Example
- "https://api.github.com/orgs/github"
repos_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/repos"
events_url
string
uri
required
- Example
- "https://api.github.com/orgs/github/events"
hooks_url
string
required
- Example
- "https://api.github.com/orgs/github/hooks"
issues_url
string
required
- Example
- "https://api.github.com/orgs/github/issues"
members_url
string
required
- Example
- "https://api.github.com/orgs/github/members{/member}"
public_members_url
string
required
- Example
- "https://api.github.com/orgs/github/public_members{/member}"
avatar_url
string
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
description
string or null
required
- Example
- "A great organization"
Link
string
Was this page helpful?