이메일에 대한 REST API 엔드포인트

이메일 관리 정보

요청 URL에 {username} 매개 변수가 포함되어 있지 않으면 응답은 로그인한 사용자에 대한 것입니다(요청과 함께 인증 정보를 전달해야 함). 사용자가 2단계 인증을 사용하도록 설정했는지 여부와 같은 추가 개인 정보는 user 범위로 OAuth를 통해 인증될 때 포함됩니다.

Set primary email visibility for the authenticated user

Sets the visibility for your primary email addresses.

"Set primary email visibility for the authenticated user"에 대한 세분화된 액세스 토큰

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

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

"Email addresses" user permissions (write)

"Set primary email visibility for the authenticated user"에 대한 매개 변수

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

본문 매개 변수
속성, 형식, 설명
`visibility` string Required Denotes whether an email is publicly visible. 다음 중 하나일 수 있습니다.: `public`, `private`

"Set primary email visibility for the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

"Set primary email visibility for the authenticated user"에 대한 코드 샘플

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

요청 예제

patch/user/email/visibility

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/user/email/visibility \
  -d '{"visibility":"private"}'

Response

Status: 200

[
  {
    "email": "octocat@github.com",
    "primary": true,
    "verified": true,
    "visibility": "private"
  }
]

List email addresses for the authenticated user

Lists all of your email addresses, and specifies which one is visible to the public.

OAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.

"List email addresses for the authenticated user"에 대한 세분화된 액세스 토큰

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

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

"Email addresses" user permissions (read)

"List email addresses for the authenticated user"에 대한 매개 변수

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

쿼리 매개 변수
속성, 형식, 설명
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 기본값: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 기본값: `1`

"List email addresses for the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

"List email addresses for the authenticated user"에 대한 코드 샘플

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

요청 예제

get/user/emails

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/emails

Response

Status: 200

[
  {
    "email": "octocat@github.com",
    "verified": true,
    "primary": true,
    "visibility": "public"
  }
]

Add an email address for the authenticated user

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

"Add an email address for the authenticated user"에 대한 세분화된 액세스 토큰

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

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

"Email addresses" user permissions (write)

"Add an email address for the authenticated user"에 대한 매개 변수

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

본문 매개 변수
속성, 형식, 설명
`emails` array of strings Required Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.

"Add an email address for the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`201`	Created
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

"Add an email address for the authenticated user"에 대한 코드 샘플

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

요청 예제

post/user/emails

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/user/emails \
  -d '{"emails":["octocat@github.com","mona@github.com","octocat@octocat.org"]}'

Response

Status: 201

[
  {
    "email": "octocat@octocat.org",
    "primary": false,
    "verified": false,
    "visibility": "public"
  },
  {
    "email": "octocat@github.com",
    "primary": false,
    "verified": false,
    "visibility": null
  },
  {
    "email": "mona@github.com",
    "primary": false,
    "verified": false,
    "visibility": null
  }
]

Delete an email address for the authenticated user

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

"Delete an email address for the authenticated user"에 대한 세분화된 액세스 토큰

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

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

"Email addresses" user permissions (write)

"Delete an email address for the authenticated user"에 대한 매개 변수

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

본문 매개 변수
속성, 형식, 설명
`emails` array of strings Required Email addresses associated with the GitHub user account.

"Delete an email address for the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

"Delete an email address for the authenticated user"에 대한 코드 샘플

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

요청 예제

delete/user/emails

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/emails \
  -d '{"emails":["octocat@github.com","mona@github.com"]}'

Response

Status: 204

List public email addresses for the authenticated user

Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint.

OAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.

"List public email addresses for the authenticated user"에 대한 세분화된 액세스 토큰

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

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

"Email addresses" user permissions (read)

공용 리소스만 요청되는 경우 인증 또는 앞서 언급한 권한 없이 이 엔드포인트를 사용할 수 있습니다.

"List public email addresses for the authenticated user"에 대한 매개 변수

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

쿼리 매개 변수
속성, 형식, 설명
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 기본값: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 기본값: `1`

"List public email addresses for the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

"List public email addresses for the authenticated user"에 대한 코드 샘플

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

요청 예제

get/user/public_emails

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/public_emails

Response

Status: 200

[
  {
    "email": "octocat@github.com",
    "verified": true,
    "primary": true,
    "visibility": "public"
  }
]