Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.
Português do Brasil
Nenhum resultado encontrado.

Explorar por produto

REST API
  • Get started
  • Account and profile
  • Authentication
  • Repositories
  • GitHub
  • Enterprise administrators
  • Billing and payments
  • Organizations
  • Code security
  • GitHub Issues
  • GitHub Actions
  • GitHub Codespaces
  • GitHub Packages
  • Search on GitHub
  • Developers
  • REST API
  • GraphQL API
  • GitHub CLI
  • GitHub Discussions
  • GitHub Sponsors
  • Building communities
  • GitHub Pages
  • Education
  • GitHub Desktop
  • Atom
  • Electron
  • CodeQL
  • npm
    • Português do Brasil
  • English
  • 简体中文 (Simplified Chinese)
  • 日本語 (Japanese)
  • Español (Spanish)
  • Português do Brasil (Portuguese)

    • Esta versão do GitHub Enterprise foi descontinuada em 2021-09-23. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, melhorar a segurança e novos recursos, upgrade to the latest version of GitHub Enterprise. Para ajuda com a atualização, contact GitHub Enterprise support.

    Versão do artigo

    Neste artigo

    Organizações

    The Organizations API gives you access to control and manage all your GitHub Enterprise Server organizations.

    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.

    get /organizations

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    since integer query

    An organization ID. Only return organizations with an ID greater than this ID.
    per_page integer query

    Results per page (max 100)

    Default: 30

    Amostras de código

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/organizations
    JavaScript (@octokit/core.js)
    await octokit.request('GET /organizations')

    Response

    Status: 200 OK
    [
  {
    "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"
  }
]

    Not modified

    Status: 304 Not Modified

    Notes

    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."

    get /orgs/{org}

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.Ver aviso de pré-visualização
    org string path

    Amostras de código

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG
    JavaScript (@octokit/core.js)
    await octokit.request('GET /orgs/{org}', {
  org: 'org'
})

    Default response

    Status: 200 OK
    {
  "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",
  "updated_at": "2014-03-03T18:58:10Z",
  "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
}

    Resource not found

    Status: 404 Not Found

    Notes

    Aviso de pré-visualização

    New repository creation permissions are available to preview. You can now use members_can_create_public_repositories, members_can_create_private_repositories, and members_can_create_internal_repositories. 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+. These parameters provide more granular permissions to configure the type of repositories organization members can create.

    To access these new parameters during the preview period, you must provide a custom media type in the Accept header:

    application/vnd.github.surtur-preview+json

    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.

    patch /orgs/{org}

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.Ver aviso de pré-visualização
    org string path
    billing_email string body

    Billing email address. This address is not publicized.
    company string body

    The company name.
    email string body

    The publicly visible email address.
    twitter_username string body

    The Twitter username of the company.
    location string body

    The location.
    name string body

    The shorthand name of the company.
    description string body

    The description of the company.
    has_organization_projects boolean body

    Toggles whether an organization can use organization projects.
    has_repository_projects boolean body

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

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

    Default: read
    members_can_create_repositories boolean body

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

    Default: true
    members_can_create_internal_repositories boolean body

    Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of:
    * true - all organization members can create internal repositories.
    * false - only organization owners can create internal repositories.
    Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.
    members_can_create_private_repositories boolean body

    Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of:
    * true - all organization members can create private repositories.
    * false - only organization owners can create private repositories.
    Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.
    members_can_create_public_repositories boolean body

    Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of:
    * true - all organization members can create public repositories.
    * false - only organization owners can create public repositories.
    Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.
    members_allowed_repository_creation_type string body

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

    Amostras de código

    Shell
    curl \
  -X PATCH \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG \
  -d '{"billing_email":"billing_email"}'
    JavaScript (@octokit/core.js)
    await octokit.request('PATCH /orgs/{org}', {
  org: 'org',
  billing_email: 'billing_email'
})

    Response

    Status: 200 OK
    {
  "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
  },
  "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,
  "updated_at": "2014-03-03T18:58:10Z"
}

    Conflict

    Status: 409 Conflict

    Validation failed

    Status: 422 Unprocessable Entity

    Notes

    Aviso de pré-visualização

    New repository creation permissions are available to preview. You can now use members_can_create_public_repositories, members_can_create_private_repositories, and members_can_create_internal_repositories. 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+. These parameters provide more granular permissions to configure the type of repositories organization members can create.

    To access these new parameters during the preview period, you must provide a custom media type in the Accept header:

    application/vnd.github.surtur-preview+json

    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.

    get /orgs/{org}/installations

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    per_page integer query

    Results per page (max 100)

    Default: 30
    page integer query

    Page number of the results to fetch.

    Default: 1

    Amostras de código

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/installations
    JavaScript (@octokit/core.js)
    await octokit.request('GET /orgs/{org}/installations', {
  org: 'org'
})

    Response

    Status: 200 OK
    {
  "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",
      "app_slug": "github-actions"
    }
  ]
}

    Notes

    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.

    get /user/orgs

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    per_page integer query

    Results per page (max 100)

    Default: 30
    page integer query

    Page number of the results to fetch.

    Default: 1

    Amostras de código

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/user/orgs
    JavaScript (@octokit/core.js)
    await octokit.request('GET /user/orgs')

    Response

    Status: 200 OK
    [
  {
    "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"
  }
]

    Not modified

    Status: 304 Not Modified

    Requires authentication

    Status: 401 Unauthorized

    Forbidden

    Status: 403 Forbidden

    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.

    get /users/{username}/orgs

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    username string path
    per_page integer query

    Results per page (max 100)

    Default: 30
    page integer query

    Page number of the results to fetch.

    Default: 1

    Amostras de código

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/users/USERNAME/orgs
    JavaScript (@octokit/core.js)
    await octokit.request('GET /users/{username}/orgs', {
  username: 'username'
})

    Response

    Status: 200 OK
    [
  {
    "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"
  }
]

    Notes

    Integrantes

    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.

    get /orgs/{org}/members

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    filter string query

    Filter members returned in the list. Can be one of:
    * 2fa_disabled - Members without two-factor authentication enabled. Available for organization owners.
    * all - All members the authenticated user can see.

    Default: all
    role string query

    Filter members returned by their role. Can be one of:
    * all - All members of the organization, regardless of role.
    * admin - Organization owners.
    * member - Non-owner organization members.

    Default: all
    per_page integer query

    Results per page (max 100)

    Default: 30
    page integer query

    Page number of the results to fetch.

    Default: 1

    Amostras de código

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/members
    JavaScript (@octokit/core.js)
    await octokit.request('GET /orgs/{org}/members', {
  org: 'org'
})

    Response

    Status: 200 OK
    [
  {
    "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
  }
]

    Response if requester is not an organization member

    Status: 302 Found

    Validation failed

    Status: 422 Unprocessable Entity

    Notes

    Check organization membership for a user

    Check if a user is, publicly or privately, a member of the organization.

    get /orgs/{org}/members/{username}

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    username string path

    Amostras de código

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME
    JavaScript (@octokit/core.js)
    await octokit.request('GET /orgs/{org}/members/{username}', {
  org: 'org',
  username: 'username'
})

    Response if requester is an organization member and user is a member

    Status: 204 No Content

    Response if requester is not an organization member

    Status: 302 Found

    Not Found if requester is an organization member and user is not a member

    Status: 404 Not Found

    Notes

    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.

    delete /orgs/{org}/members/{username}

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    username string path

    Amostras de código

    Shell
    curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/members/USERNAME
    JavaScript (@octokit/core.js)
    await octokit.request('DELETE /orgs/{org}/members/{username}', {
  org: 'org',
  username: 'username'
})

    Response

    Status: 204 No Content

    Forbidden

    Status: 403 Forbidden

    Notes

    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.

    get /orgs/{org}/memberships/{username}

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    username string path

    Amostras de código

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME
    JavaScript (@octokit/core.js)
    await octokit.request('GET /orgs/{org}/memberships/{username}', {
  org: 'org',
  username: 'username'
})

    Response if user has an active admin membership with organization

    Status: 200 OK
    {
  "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
  }
}

    Forbidden

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found

    Notes

    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 to admin, 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 to member, 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.

    put /orgs/{org}/memberships/{username}

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    username string path
    role string body

    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

    Amostras de código

    Shell
    curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME \
  -d '{"role":"role"}'
    JavaScript (@octokit/core.js)
    await octokit.request('PUT /orgs/{org}/memberships/{username}', {
  org: 'org',
  username: 'username',
  role: 'role'
})

    Response if user has an active admin membership with organization

    Status: 200 OK
    {
  "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
  }
}

    Forbidden

    Status: 403 Forbidden

    Validation failed

    Status: 422 Unprocessable Entity

    Notes

    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.

    delete /orgs/{org}/memberships/{username}

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    username string path

    Amostras de código

    Shell
    curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/memberships/USERNAME
    JavaScript (@octokit/core.js)
    await octokit.request('DELETE /orgs/{org}/memberships/{username}', {
  org: 'org',
  username: 'username'
})

    Response

    Status: 204 No Content

    Forbidden

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found

    Notes

    List public organization members

    Members of an organization can choose to have their membership publicized or not.

    get /orgs/{org}/public_members

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    per_page integer query

    Results per page (max 100)

    Default: 30
    page integer query

    Page number of the results to fetch.

    Default: 1

    Amostras de código

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/public_members
    JavaScript (@octokit/core.js)
    await octokit.request('GET /orgs/{org}/public_members', {
  org: 'org'
})

    Response

    Status: 200 OK
    [
  {
    "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
  }
]

    Notes

    Check public organization membership for a user 

    get /orgs/{org}/public_members/{username}

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    username string path

    Amostras de código

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    JavaScript (@octokit/core.js)
    await octokit.request('GET /orgs/{org}/public_members/{username}', {
  org: 'org',
  username: 'username'
})

    Response if user is a public member

    Status: 204 No Content

    Not Found if user is not a public member

    Status: 404 Not Found

    Notes

    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."

    put /orgs/{org}/public_members/{username}

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    username string path

    Amostras de código

    Shell
    curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    JavaScript (@octokit/core.js)
    await octokit.request('PUT /orgs/{org}/public_members/{username}', {
  org: 'org',
  username: 'username'
})

    Response

    Status: 204 No Content

    Forbidden

    Status: 403 Forbidden

    Remove public organization membership for the authenticated user 

    delete /orgs/{org}/public_members/{username}

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    username string path

    Amostras de código

    Shell
    curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/public_members/USERNAME
    JavaScript (@octokit/core.js)
    await octokit.request('DELETE /orgs/{org}/public_members/{username}', {
  org: 'org',
  username: 'username'
})

    Response

    Status: 204 No Content

    List organization memberships for the authenticated user 

    get /user/memberships/orgs

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    state string query

    Indicates the state of the memberships to return. Can be either active or pending. If not specified, the API returns both active and pending memberships.
    per_page integer query

    Results per page (max 100)

    Default: 30
    page integer query

    Page number of the results to fetch.

    Default: 1

    Amostras de código

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/user/memberships/orgs
    JavaScript (@octokit/core.js)
    await octokit.request('GET /user/memberships/orgs')

    Response

    Status: 200 OK
    [
  {
    "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
    }
  }
]

    Not modified

    Status: 304 Not Modified

    Requires authentication

    Status: 401 Unauthorized

    Forbidden

    Status: 403 Forbidden

    Validation failed

    Status: 422 Unprocessable Entity

    Get an organization membership for the authenticated user 

    get /user/memberships/orgs/{org}

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path

    Amostras de código

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/user/memberships/orgs/ORG
    JavaScript (@octokit/core.js)
    await octokit.request('GET /user/memberships/orgs/{org}', {
  org: 'org'
})

    Response

    Status: 200 OK
    {
  "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
  }
}

    Forbidden

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found

    Update an organization membership for the authenticated user 

    patch /user/memberships/orgs/{org}

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    state string body

    Required. The state that the membership should be in. Only "active" will be accepted.

    Amostras de código

    Shell
    curl \
  -X PATCH \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/user/memberships/orgs/ORG \
  -d '{"state":"state"}'
    JavaScript (@octokit/core.js)
    await octokit.request('PATCH /user/memberships/orgs/{org}', {
  org: 'org',
  state: 'state'
})

    Response

    Status: 200 OK
    {
  "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
  }
}

    Forbidden

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found

    Validation failed

    Status: 422 Unprocessable Entity

    Colaboradores externos

    List outside collaborators for an organization

    List all users who are outside collaborators of an organization.

    get /orgs/{org}/outside_collaborators

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    filter string query

    Filter the list of outside collaborators. Can be one of:
    * 2fa_disabled: Outside collaborators without two-factor authentication enabled.
    * all: All outside collaborators.

    Default: all
    per_page integer query

    Results per page (max 100)

    Default: 30
    page integer query

    Page number of the results to fetch.

    Default: 1

    Amostras de código

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators
    JavaScript (@octokit/core.js)
    await octokit.request('GET /orgs/{org}/outside_collaborators', {
  org: 'org'
})

    Response

    Status: 200 OK
    [
  {
    "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
  }
]

    Notes

    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".

    put /orgs/{org}/outside_collaborators/{username}

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    username string path

    Amostras de código

    Shell
    curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME
    JavaScript (@octokit/core.js)
    await octokit.request('PUT /orgs/{org}/outside_collaborators/{username}', {
  org: 'org',
  username: 'username'
})

    User is getting converted asynchronously

    Status: 202 Accepted

    User was converted

    Status: 204 No Content

    Forbidden if user is the last owner of the organization or not a member of the organization

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found

    Notes

    Remove outside collaborator from an organization

    Removing a user from this list will remove them from all the organization's repositories.

    delete /orgs/{org}/outside_collaborators/{username}

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    username string path

    Amostras de código

    Shell
    curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/outside_collaborators/USERNAME
    JavaScript (@octokit/core.js)
    await octokit.request('DELETE /orgs/{org}/outside_collaborators/{username}', {
  org: 'org',
  username: 'username'
})

    Response

    Status: 204 No Content

    Unprocessable Entity if user is a member of the organization

    Status: 422 Unprocessable Entity
    {
  "message": "You cannot specify an organization member to remove as an outside collaborator.",
  "documentation_url": "https://docs.github.com/enterprise-server@2.22/rest/reference/orgs#remove-outside-collaborator"
}

    Notes

    Webhooks

    Organization webhooks allow you to receive HTTP POST payloads whenever certain events happen in an organization. The webhook REST APIs enable you to manage repository and organization webhooks. For more information, see:

    Para obter mais informações sobre ações que você pode assinar, consulte " tipos de evento de GitHub".

    Escopos & Restrições

    Todas as ações contra webhooks da organização exigem que o usuário autenticado seja um administrador da organização que está sendo gerenciada. Além disso, os tokens do OAuth requerem o escopo admin:org_hook. Para obter mais informações, consulte "Escopos para aplicativos OAuth."

    Para proteger dados sensíveis que podem estar presentes nas configurações do webhook, também aplicamos as seguintes regras de controle de acesso:

    • Os aplicativos OAuth não podem listar, visualizar ou editar webhooks que não criaram.
    • Os usuários não podem listar, visualizar ou editar webhooks que foram criados por aplicativos OAuth.

    Receber Webhooks

    Para que GitHub Enterprise Server envie cargas de webhook, seu servidor deve ser acessível pela internet. É altamente recomendável o uso de SSL para que possamos enviar cargas criptografadas por HTTPS.

    Para obter mais práticas recomendadas, consulte nosso guia.

    Cabeçalhos de webhook

    GitHub Enterprise Server enviará ao longo de vários cabeçalhos de HTTP para diferenciar entre tipos de evento e identificadores de carga. Consulte cabeçalhos de webhook para obter informações.

    List organization webhooks 

    get /orgs/{org}/hooks

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    per_page integer query

    Results per page (max 100)

    Default: 30
    page integer query

    Page number of the results to fetch.

    Default: 1

    Amostras de código

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/hooks
    JavaScript (@octokit/core.js)
    await octokit.request('GET /orgs/{org}/hooks', {
  org: 'org'
})

    Response

    Status: 200 OK
    [
  {
    "id": 1,
    "url": "https://api.github.com/orgs/octocat/hooks/1",
    "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings",
    "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"
  }
]

    Resource not found

    Status: 404 Not Found

    Notes

    Create an organization webhook

    Here's how you can create a hook that posts payloads in JSON format:

    post /orgs/{org}/hooks

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    name string body

    Required. Must be passed as "web".
    config object body

    Required. Key/value pairs to provide settings for this webhook. These are defined below.
    Properties of the config object
    url (string)

    Required. The URL to which the payloads will be delivered.
    content_type (string)

    The media type used to serialize the payloads. Supported values include json and form. The default is form.
    secret (string)

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
    insecure_ssl (string or number)

    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.
    username (string)
    password (string)
    events array of strings body

    Determines what events the hook is triggered for.

    Default: push
    active boolean body

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    Default: true

    Amostras de código

    Shell
    curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/hooks \
  -d '{"name":"name","config":{"url":"url","content_type":"content_type","secret":"secret","insecure_ssl":"insecure_ssl","username":"username","password":"password"}}'
    JavaScript (@octokit/core.js)
    await octokit.request('POST /orgs/{org}/hooks', {
  org: 'org',
  name: 'name',
  config: {
    url: 'url',
    content_type: 'content_type',
    secret: 'secret',
    insecure_ssl: 'insecure_ssl',
    username: 'username',
    password: 'password'
  }
})

    Response

    Status: 201 Created
    {
  "id": 1,
  "url": "https://api.github.com/orgs/octocat/hooks/1",
  "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings",
  "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"
}

    Resource not found

    Status: 404 Not Found

    Validation failed

    Status: 422 Unprocessable Entity

    Notes

    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."

    get /orgs/{org}/hooks/{hook_id}

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    hook_id integer path

    Amostras de código

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42
    JavaScript (@octokit/core.js)
    await octokit.request('GET /orgs/{org}/hooks/{hook_id}', {
  org: 'org',
  hook_id: 42
})

    Response

    Status: 200 OK
    {
  "id": 1,
  "url": "https://api.github.com/orgs/octocat/hooks/1",
  "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings",
  "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"
}

    Resource not found

    Status: 404 Not Found

    Notes

    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."

    patch /orgs/{org}/hooks/{hook_id}

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    hook_id integer path
    config object body

    Key/value pairs to provide settings for this webhook. These are defined below.
    Properties of the config object
    url (string)

    Required. The URL to which the payloads will be delivered.
    content_type (string)

    The media type used to serialize the payloads. Supported values include json and form. The default is form.
    secret (string)

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
    insecure_ssl (string or number)

    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.
    events array of strings body

    Determines what events the hook is triggered for.

    Default: push
    active boolean body

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    Default: true
    name string body

    Amostras de código

    Shell
    curl \
  -X PATCH \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42 \
  -d '{"config":{"url":"url","content_type":"content_type","secret":"secret","insecure_ssl":"insecure_ssl"}}'
    JavaScript (@octokit/core.js)
    await octokit.request('PATCH /orgs/{org}/hooks/{hook_id}', {
  org: 'org',
  hook_id: 42,
  config: {
    url: 'url',
    content_type: 'content_type',
    secret: 'secret',
    insecure_ssl: 'insecure_ssl'
  }
})

    Response

    Status: 200 OK
    {
  "id": 1,
  "url": "https://api.github.com/orgs/octocat/hooks/1",
  "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings",
  "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"
}

    Resource not found

    Status: 404 Not Found

    Validation failed

    Status: 422 Unprocessable Entity

    Notes

    Delete an organization webhook 

    delete /orgs/{org}/hooks/{hook_id}

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    hook_id integer path

    Amostras de código

    Shell
    curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42
    JavaScript (@octokit/core.js)
    await octokit.request('DELETE /orgs/{org}/hooks/{hook_id}', {
  org: 'org',
  hook_id: 42
})

    Response

    Status: 204 No Content

    Resource not found

    Status: 404 Not Found

    Notes

    Ping an organization webhook

    This will trigger a ping event to be sent to the hook.

    post /orgs/{org}/hooks/{hook_id}/pings

    Parâmetros

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    org string path
    hook_id integer path

    Amostras de código

    Shell
    curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/orgs/ORG/hooks/42/pings
    JavaScript (@octokit/core.js)
    await octokit.request('POST /orgs/{org}/hooks/{hook_id}/pings', {
  org: 'org',
  hook_id: 42
})

    Response

    Status: 204 No Content

    Resource not found

    Status: 404 Not Found

    Notes