사용자 차단

REST API를 사용하여 조직의 사용자를 차단 및 차단 해제합니다.

사용자 차단 정보

조직에 대한 차단 호출을 수행하기 위해 호출을 인증하는 데 사용되는 토큰에는 admin:org 범위가 있어야 합니다. 그렇지 않으면 응답에서 HTTP 404가 반환됩니다.

List users blocked by an organization

List the users blocked by an organization.

"List users blocked by an organization"에 대한 매개 변수

헤더
속성, 형식, Description
`accept` string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
속성, 형식, Description
`org` string 필수 The organization name. The name is not case sensitive.
쿼리 매개 변수
속성, 형식, Description
`per_page` integer The number of results per page (max 100). 기본값: `30`
`page` integer Page number of the results to fetch. 기본값: `1`

"List users blocked by an organization"에 대한 HTTP 응답 상태 코드

상태 코드	Description
`200`	OK

"List users blocked by an organization"에 대한 코드 샘플

get/orgs/{org}/blocks

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/blocks

Response

Status: 200

[
  {
    "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
  }
]

Check if a user is blocked by an organization

에서 작동 GitHub Apps

"Check if a user is blocked by an organization"에 대한 매개 변수

헤더
속성, 형식, Description
`accept` string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
속성, 형식, Description
`org` string 필수 The organization name. The name is not case sensitive.
`username` string 필수 The handle for the GitHub user account.

"Check if a user is blocked by an organization"에 대한 HTTP 응답 상태 코드

상태 코드	Description
`204`	If the user is blocked
`404`	If the user is not blocked

"Check if a user is blocked by an organization"에 대한 코드 샘플

get/orgs/{org}/blocks/{username}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/blocks/USERNAME

If the user is blocked

Status: 204

Block a user from an organization

에서 작동 GitHub Apps

"Block a user from an organization"에 대한 매개 변수

헤더
속성, 형식, Description
`accept` string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
속성, 형식, Description
`org` string 필수 The organization name. The name is not case sensitive.
`username` string 필수 The handle for the GitHub user account.

"Block a user from an organization"에 대한 HTTP 응답 상태 코드

상태 코드	Description
`204`	No Content
`422`	Validation failed, or the endpoint has been spammed.

"Block a user from an organization"에 대한 코드 샘플

put/orgs/{org}/blocks/{username}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/blocks/USERNAME

Response

Status: 204

Unblock a user from an organization

에서 작동 GitHub Apps

"Unblock a user from an organization"에 대한 매개 변수

헤더
속성, 형식, Description
`accept` string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
속성, 형식, Description
`org` string 필수 The organization name. The name is not case sensitive.
`username` string 필수 The handle for the GitHub user account.

"Unblock a user from an organization"에 대한 HTTP 응답 상태 코드

상태 코드	Description
`204`	No Content

"Unblock a user from an organization"에 대한 코드 샘플

delete/orgs/{org}/blocks/{username}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/blocks/USERNAME

Response

Status: 204