사용자 상호 작용에 대한 REST API 엔드포인트

사용자 상호 작용 정보

REST API를 사용하여 퍼블릭 리포지토리에서 댓글을 달거나, 이슈를 열거나, 끌어오기 요청을 만들 수 있는 사용자 유형을 일시적으로 제한할 수 있습니다. 제한을 사용하도록 설정하면 지정된 유형의 GitHub 사용자만 상호 작용에 참여할 수 있습니다. 제한은 정의된 기간 후에 자동으로 만료됩니다. GitHub 사용자 유형에 대한 자세한 내용은 다음과 같습니다.

리포지토리와 상호 작용하지 않는 기존 사용자: 상호 작용을 existing_users로 제한하면 이전에 기여하지 않고 협력자가 아니며 계정이 생성된 지 24시간 미만인 신규 사용자가 일시적으로 제한됩니다..
리포지토리와 상호 작용하지 않는 기여자만: 상호 작용을 contributors_only로 제한할 때 이전에 기여하지 않았으며 협력자도 아닌 사용자는 일시적으로 제한됩니다..
리포지토리와 상호 작용하지 않는 협력자만 해당: 상호 작용을 collaborators_only으로 제한하면 협력자가 아닌 사용자가 일시적으로 제한됩니다..

사용자 수준에서 상호 작용 제한을 설정하면 사용자가 소유한 개별 리포지토리에 대해 설정된 모든 상호 작용 제한을 덮어씁니다. 사용자 소유의 개별 리포지토리에 대해 서로 다른 상호 작용 제한을 설정하려면 리포지토리 상호 작용 엔드포인트를 대신 사용합니다.

Get interaction restrictions for your public repositories

Shows which type of GitHub user can interact with your public repositories and when the restriction expires.

"Get interaction restrictions for your public repositories"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰에는 다음 권한 집합이 있어야 합니다.:

"Interaction limits" user permissions (read)

"Get interaction restrictions for your public repositories"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	Default response
`204`	Response when there are no restrictions

"Get interaction restrictions for your public repositories"에 대한 코드 샘플

요청 예제

get/user/interaction-limits

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/user/interaction-limits

Default response

Status: 200

{
  "limit": "collaborators_only",
  "origin": "organization",
  "expires_at": "2018-08-17T04:18:39Z"
}

Set interaction restrictions for your public repositories

Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.

"Set interaction restrictions for your public repositories"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰에는 다음 권한 집합이 있어야 합니다.:

"Interaction limits" user permissions (write)

"Set interaction restrictions for your public repositories"에 대한 매개 변수

머리글
속성, 형식, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

본문 매개 변수
속성, 형식, 설명
`limit` string Required The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. 다음 중 하나일 수 있습니다.: `existing_users`, `contributors_only`, `collaborators_only`
`expiry` string The duration of the interaction restriction. Default: `one_day`. 다음 중 하나일 수 있습니다.: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`

"Set interaction restrictions for your public repositories"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK
`422`	Validation failed, or the endpoint has been spammed.

"Set interaction restrictions for your public repositories"에 대한 코드 샘플

요청 예제

put/user/interaction-limits

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/user/interaction-limits \
  -d '{"limit":"collaborators_only","expiry":"one_month"}'

Response

Status: 200

{
  "limit": "collaborators_only",
  "origin": "user",
  "expires_at": "2018-08-17T04:18:39Z"
}

Remove interaction restrictions from your public repositories

Removes any interaction restrictions from your public repositories.

"Remove interaction restrictions from your public repositories"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰에는 다음 권한 집합이 있어야 합니다.:

"Interaction limits" user permissions (write)

"Remove interaction restrictions from your public repositories"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`204`	No Content

"Remove interaction restrictions from your public repositories"에 대한 코드 샘플

요청 예제

delete/user/interaction-limits

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/user/interaction-limits

Response

Status: 204