GET/v1/me
Aufrufer der API abrufen
get_me
Gibt Informationen über den Aufrufer zurück: die Organisation, wie sich der Aufrufer angemeldet hat (API-Schlüssel oder Sitzung), den Schlüssel (ID, Name, Präfix, Rolle), die Rolle, die Scopes des Schlüssels, das Datenprofil, den Ablaufzeitpunkt und das Ratenlimit. Die Operation funktioniert mit jedem gültigen Schlüssel unabhängig von seinen Scopes, sodass eine Integration damit einen Schlüssel prüfen kann. Die API-Adresse (api.<domain>) akzeptiert nur Schlüssel. Bei einer Sitzung auf der Hauptadresse sind key und scopes null, und user ist der Benutzer der Sitzung. Hinzugefügt in 1.62.0.
Authentifizierung
Senden Sie einen API-Schlüssel im Header Authorization: Authorization: Bearer <Schlüssel>.
Antworten
200Erfolgreiche Antwort
Antwort-Header
RateLimit-PolicyGeltende Limits im Format des IETF-Entwurfs
draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge"<name>";q=<quota>;w=<window in seconds>.keyist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintraguser, ohne Anmeldedatenip);minute,dayundmonthsind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.RateLimitWas von jedem Limit in
RateLimit-Policyübrig ist:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitLimit des strengsten Eintrags in
RateLimit-Policy(des Eintrags mit den wenigsten verbleibenden Anfragen).X-RateLimit-RemainingVerbleibende Anfragen unter dem strengsten Limit.
X-RateLimit-ResetSekunden bis zum Zurücksetzen des strengsten Limits.
application/json
principalstringerforderlichWie sich der Aufrufer angemeldet hat: mit einem API-Schlüssel der Organisation, mit einer Benutzersitzung oder mit einem Token einer OAuth-App (
oauth_token, seit 1.62.0). Dies ist eine erweiterbare Aufzählung: Clients müssen unbekannte Werte überspringen.Zulässige Werte:
api_keysessionoauth_tokenappCallerAppDie OAuth-App des Tokens; fehlt, wenn sich der Aufrufer mit einem API-Schlüssel oder einer Sitzung anmeldet. Hinzugefügt in 1.62.0.
Der API-Schlüssel der Anfrage;
nullbei einer Sitzung.Der Benutzer der Sitzung;
nullbei einem API-Schlüssel.scopesarray of string | nullerforderlichDie effektiven Scopes des Schlüssels (explizit festgelegt oder aus der Rolle des Schlüssels abgeleitet);
nullbei einer Sitzung, die keine Scopes hat.Das Datenprofil, mit dem die Anfrage ausgeführt wird;
null, wenn es keines gibt.expires_atstring (date-time) | nullerforderlichWann der Schlüssel oder die Sitzung abläuft (RFC 3339, UTC);
null, wenn kein Ablauf festgelegt ist.
401Es wurden keine Anmeldedaten gesendet (weder ein Sitzungscookie noch ein API-Schlüssel), oder der Schlüssel wurde nicht gefunden.
Antwort-Header
RateLimit-PolicyGeltende Limits im Format des IETF-Entwurfs
draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge"<name>";q=<quota>;w=<window in seconds>.keyist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintraguser, ohne Anmeldedatenip);minute,dayundmonthsind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.RateLimitWas von jedem Limit in
RateLimit-Policyübrig ist:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitLimit des strengsten Eintrags in
RateLimit-Policy(des Eintrags mit den wenigsten verbleibenden Anfragen).X-RateLimit-RemainingVerbleibende Anfragen unter dem strengsten Limit.
X-RateLimit-ResetSekunden bis zum Zurücksetzen des strengsten Limits.
application/json
403Die Aktion ist nicht erlaubt: Die Rolle reicht nicht aus, es besteht kein Zugriff auf die Sammlung oder Karte, die Anfrage läuft im Modus „Ansicht als“, oder die Organisation ist gesperrt oder gelöscht (`detail` ist ein Objekt mit `code: org_suspended | org_deleted`).
Antwort-Header
RateLimit-PolicyGeltende Limits im Format des IETF-Entwurfs
draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge"<name>";q=<quota>;w=<window in seconds>.keyist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintraguser, ohne Anmeldedatenip);minute,dayundmonthsind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.RateLimitWas von jedem Limit in
RateLimit-Policyübrig ist:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitLimit des strengsten Eintrags in
RateLimit-Policy(des Eintrags mit den wenigsten verbleibenden Anfragen).X-RateLimit-RemainingVerbleibende Anfragen unter dem strengsten Limit.
X-RateLimit-ResetSekunden bis zum Zurücksetzen des strengsten Limits.
application/json
429Zu viele Anfragen (`api.rate_limited`), das Kontingent der Organisation für die Minute, den Tag oder den Monat ist aufgebraucht (`api.quota_exceeded`; `error.details` enthält `quota`, `limit` und `reset_at`), das Limit der Organisation ist erreicht, oder der Antwortdienst ist ausgelastet (`answers.engine_busy`). Warten Sie die im Header `Retry-After` angegebene Zeit ab.
Antwort-Header
Retry-AfterAnzahl der Sekunden, die Sie warten sollten, bevor Sie die Anfrage wiederholen.
RateLimit-PolicyGeltende Limits im Format des IETF-Entwurfs
draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge"<name>";q=<quota>;w=<window in seconds>.keyist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintraguser, ohne Anmeldedatenip);minute,dayundmonthsind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.RateLimitWas von jedem Limit in
RateLimit-Policyübrig ist:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitLimit des strengsten Eintrags in
RateLimit-Policy(des Eintrags mit den wenigsten verbleibenden Anfragen).X-RateLimit-RemainingVerbleibende Anfragen unter dem strengsten Limit.
X-RateLimit-ResetSekunden bis zum Zurücksetzen des strengsten Limits.
application/json
Fehlercodes
Codes, die dieser Endpunkt in error.code zurückgeben kann, zusätzlich zu den allgemeinen Codes jeder Anfrage.
Ratenlimits
Antworten enthalten die Header RateLimit und RateLimit-Policy sowie die älteren X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset. Eine Antwort 429 enthält Retry-After in Sekunden: Warten Sie und versuchen Sie es dann erneut.