E-Mails
Verwende die REST-API, um die E-Mail-Adressen authentifizierter Benutzer*innen zu verwalten.
Informationen zur E-Mail-Verwaltung
Wenn eine Anforderungs-URL keinen {username}
-Parameter enthält, ist die Antwort für die angemeldete Benutzerin bzw. den angemeldeten Benutzer bestimmt (Übergeben von Authentifizierungsinformationen mit der Anforderung erforderlich). Zusätzliche private Informationen (z. B. ob die Zwei-Faktor-Authentifizierung für einen Benutzerin aktiviert ist) sind enthalten, wenn die Authentifizierung über die Standardmethode oder OAuth mit dem user
-Bereich erfolgt.
List email addresses for the authenticated user
Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the user:email
scope.
Parameter für „List email addresses for the authenticated user“
Name, type, BESCHREIBUNG |
---|
accept string Setting to |
Name, type, BESCHREIBUNG |
---|
per_page integer The number of results per page (max 100). Standard: |
page integer Page number of the results to fetch. Standard: |
HTTP-Antwortstatuscodes für „List email addresses for the authenticated user“
Statuscode | BESCHREIBUNG |
---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
Codebeispiele für „List email addresses for the authenticated user“
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/user/emails
Response
Status: 200
[
{
"email": "octocat@github.com",
"verified": true,
"primary": true,
"visibility": "public"
}
]
Add an email address for the authenticated user
This endpoint is accessible with the user
scope.
Parameter für „Add an email address for the authenticated user“
Name, type, BESCHREIBUNG |
---|
accept string Setting to |
Name, type, BESCHREIBUNG |
---|
emails array of strings ErforderlichAdds 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 |
HTTP-Antwortstatuscodes für „Add an email address for the authenticated user“
Statuscode | BESCHREIBUNG |
---|---|
201 | Created |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Codebeispiele für „Add an email address for the authenticated user“
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/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
This endpoint is accessible with the user
scope.
Parameter für „Delete an email address for the authenticated user“
Name, type, BESCHREIBUNG |
---|
accept string Setting to |
Name, type, BESCHREIBUNG |
---|
emails array of strings ErforderlichEmail addresses associated with the GitHub user account. |
HTTP-Antwortstatuscodes für „Delete an email address for the authenticated user“
Statuscode | BESCHREIBUNG |
---|---|
204 | No Content |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Codebeispiele für „Delete an email address for the authenticated user“
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/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. This endpoint is accessible with the user:email
scope.
Parameter für „List public email addresses for the authenticated user“
Name, type, BESCHREIBUNG |
---|
accept string Setting to |
Name, type, BESCHREIBUNG |
---|
per_page integer The number of results per page (max 100). Standard: |
page integer Page number of the results to fetch. Standard: |
HTTP-Antwortstatuscodes für „List public email addresses for the authenticated user“
Statuscode | BESCHREIBUNG |
---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
Codebeispiele für „List public email addresses for the authenticated user“
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/user/public_emails
Response
Status: 200
[
{
"email": "octocat@github.com",
"verified": true,
"primary": true,
"visibility": "public"
}
]