Benutzer

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

Alle GitHub-Dokumente sind Open Source-Dokumente. Ist dir etwas Falsches oder Unklares aufgefallen? Bitte sende einen Pull Request.

Hilf uns, diese Dokumente perfekt zu machen!

Aktionen

Gib einen Suchbegriff ein, um ihn in der GitHub-Dokumentation zu finden.

Benutzer - GitHub AE Docs

Verwende die REST-API, um öffentliche und private Informationen zu authentifizierten Benutzer*innen abzurufen.

Schnellstart

Vergleich der GitHub-APIs

Ressourcen in der REST-API

Rate limits

Medientypen

Authentifizierung

Schützen von API-Anmeldeinformationen

Problembehandlung

Libraries

Issue-Ereignistypen

GitHub-Ereignistypen

Endpunkt für GitHub-App-Installationszugriffstoken

Endpunkte für GitHub-App-Benutzertoken

Berechtigungen für GitHub-Apps

Übersicht

Verwenden der API

Erstellen von Skripts mit JavaScript

Skript mit Ruby

Ermitteln von Ressourcen für einzelne Benutzer*innen

Übermitteln von Bereitstellungen

Rendern von Daten als Graphen

Arbeiten mit Kommentaren

Paginierung

Erstellen eines CI-Servers

Bewährte Methoden

Erste Schritte: Git-Datenbank

Erste Schritte: Überprüfungen

Verschlüsseln von Geheimnissen

Anleitungen

Artifacts

Berechtigungen

Geheimnisse

Selbstgehostete Runnergruppen

Selbstgehostete Runner

Workflowaufträge

Workflowausführungen

Workflows

Events

Feeds

Benachrichtigungen

Versehen mit einem Stern

Watching (Überwachung)

Aktivität

GitHub Apps

Installationen

OAuth-Autorisierungen

webhooks

Apps

Branches

Geschützte Branches

Überprüfungsausführungen

Prüfsuiten

Prüfungen

Codeüberprüfung

Verhaltensregeln

Projektmitarbeiter

Einladungen

Commits

Commit-Kommentare

Commitstatus

Schlüssel bereitstellen

Richtlinien für Bereitstellungsbranches

Bereitstellungen

Umgebungen

Bereitstellungsstatus

Emojis

Administratorstatistiken

Ankündigung

Überwachungsprotokoll

Globale Webhooks

Lizenz

Organisationen

Pre-Receive-Umgebungen

Enterprise-Verwaltung

Gists

Kommentare

BLOBs

References

Strukturen

Git-Datenbank

Gitignore

Probleme

Bearbeiter

Ereignisse

Bezeichnungen

Meilensteine

Zeitachse

Lizenzen

Markdown

Statistik

Metriken

Migrationen

Member

Externe Mitwirkende

Seiten

Boards

Cards

Spalten

Project boards

Pulls

Rezensionskommentare

Reviewanfragen

Überprüfungen

Rate Limit

Reaktionen

Releases

Releaseressourcen

Autolinks

Inhalte

Radgabeln

Git LFS

Repositorys

Webhooks

Suchen,

Geheime Überprüfung

Teams

Diskussionskommentare

Diskussionen

Externe Gruppen

Follower

GPG-Schlüssel

Git-SSH-Schlüssel

REST-API

Response with public and private profile information

monalisa octocat

Medium

Private User

Public User

Response with public profile information

If the authenticated user is authenticated with an OAuth token with the <code>user</code> scope, then the response lists public and private profile information.
If the authenticated user is authenticated through OAuth without the <code>user</code> scope, then the response lists only public profile information.

Get the authenticated user

name

The publicly visible email address of the user.

email

blog

The new Twitter username of the user.

twitter_username

company

location

The new hiring availability of the user.

hireable

The new short biography of the user.

Note: If your email is set to private and you send an <code>email</code> parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.

Validation failed, or the endpoint has been spammed.

Update the authenticated user

Simple User

Lists all users, in the order that they signed up on GitHub AE. This list includes personal user accounts and organization accounts.
Note: Pagination is powered exclusively by the <code>since</code> parameter. Use the <a href="https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers">Link header</a> to get the URL for the next page of users.

A user ID. Only return users with an ID greater than this ID.

since

The number of results per page (max 100).

per_page

List users

Response with GitHub plan information

Provides publicly available information about someone with a GitHub account.
GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub AE plan. The GitHub App must be authenticated as a user. See "<a href="https://docs.github.com/github-ae@latest/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/">Identifying and authorizing users for GitHub Apps</a>" for details about authentication. For an example response, see 'Response with GitHub AE plan information' below"
The <code>email</code> key in the following response is the publicly visible email address from your GitHub AE <a href="https://github.com/settings/profile">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub AE. For more information, see <a href="https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#authentication">Authentication</a>.
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "<a href="https://docs.github.com/github-ae@latest/rest/users/emails">Emails API</a>".

The handle for the GitHub user account.

username

Get a user

Hovercard

Provides hovercard information when authenticated through basic auth or OAuth with the <code>repo</code> scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
The <code>subject_type</code> and <code>subject_id</code> parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about <code>octocat</code> who owns the <code>Spoon-Knife</code> repository via cURL, it would look like this:
<pre><code class="hljs language-shell"> curl -u username:token
 https://api.github.com/users/octocat/hovercard?subject_type=repository&#x26;subject_id=1300192
</code></pre>

Identifies which additional information you'd like to receive about the person's hovercard. Can be <code>organization</code>, <code>repository</code>, <code>issue</code>, <code>pull_request</code>. Required when using <code>subject_id</code>.

subject_type

Uses the ID for the <code>subject_type</code> you specified. Required when using <code>subject_type</code>.