POST/v1/access-requests/{request_id}/grant

Zugriff auf eine Anfrage hin gewähren

grant_access_request

Verwendet die bestehenden Zugriffsmechanismen: collection_ids – die Rolle Leser für den Benutzer in den Sammlungen der Quellen (COLLECTION_MANAGE_PERMISSIONS für jede); data_profile – weist dem Benutzer ein Datenprofil zu (ORG_MANAGE_USERS); add_category – fügt die Kategorien der Quellen zum aktuellen Datenprofil des Benutzers hinzu (nur Administratoren; betrifft alle Benutzer des Profils – ihre Anzahl steht in profile_users). Die Quellen, auf die der Benutzer nach der Freigabe zugreifen kann, werden als freigegeben markiert; sind alle freigegeben, wird die Anfrage zu granted, und der Benutzer erhält eine Benachrichtigung. Hinzugefügt in 1.50.0.

Authentifizierung

Senden Sie einen API-Schlüssel im Header Authorization: Authorization: Bearer <Schlüssel>.

Pfadparameter

request_idintegererforderlich

Header-Parameter

X-View-Asstring
Nur für API-Schlüssel mit der Rolle admin. Führt die Anfrage mit dem Datenprofil <profile>[:viewer|verifier|editor] aus, zum Beispiel employee:viewer. Der Installationsschlüssel kann diesen Header nicht verwenden (403).
Idempotency-Keystring
Schlüssel für die sichere Wiederholung eines Schreibvorgangs: 1 bis 255 druckbare ASCII-Zeichen; empfohlen wird eine UUID v4 pro logischer Operation. Eine Wiederholung mit demselben Schlüssel innerhalb von 24 Stunden führt die Operation nicht erneut aus, sondern liefert die gespeicherte Antwort (Status, Header und Body) mit dem Header Idempotency-Replayed: true. Derselbe Schlüssel mit einer anderen Methode, einem anderen Pfad, Content-Type oder Body ergibt 409 api.idempotency_mismatch; solange die erste Anfrage noch läuft, 409 api.idempotency_in_progress mit Retry-After: 1. Nach einer 5xx- oder 429-Antwort wird der Schlüssel freigegeben, und eine Wiederholung führt die Operation erneut aus. Der Schlüssel gilt pro Organisation und Aufrufer (API-Schlüssel, Benutzer oder Schlüssel einer benutzerdefinierten Quelle).
length ≥ 1, length ≤ 255

Cookie-Parameter

kb_view_asstring
Cookie des Modus „Ansicht als“ für eine Sitzung. POST /auth/view-as setzt es, DELETE /auth/view-as entfernt es.

Anfragetext

application/json

Objekt: AccessRequestGrant

collection_idsarray of integer
data_profilestring
Schlüssel des Datenprofils, das dem Benutzer zugewiesen wird.
add_categoryboolean

Antworten

200Die Anfrage nach der Freigabe

Antwort-Header

RateLimit-Policy
Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist 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 Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.
RateLimit
Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).
X-RateLimit-Remaining
Verbleibende Anfragen unter dem strengsten Limit.
X-RateLimit-Reset
Sekunden bis zum Zurücksetzen des strengsten Limits.
Idempotency-Replayed
true bedeutet, dass die für diesen Idempotency-Key gespeicherte Antwort erneut geliefert wurde: Die Operation wurde nicht noch einmal ausgeführt.

application/json

Objekt: AccessRequest

idintegererforderlich
statusstringerforderlich
Zulässige Werte: opengranteddenied
answer_idstring
Die Antwort, für die der Zugriff angefordert wurde (leer, wenn die Antwort durch die Aufbewahrungsrichtlinie gelöscht wurde).
questionstringerforderlich
messagestringerforderlich
commentstring
Kommentar zur Ablehnung.
totalintegererforderlich
Anzahl der Quellen in der Anfrage (für eine entscheidende Person die für sie sichtbaren Quellen).
pendingintegererforderlich
Noch nicht freigegeben.
mergedboolean
In der Antwort auf eine Erstellungsanfrage: Die Anfrage wurde mit einer offenen zusammengeführt.
decided_atstring (date-time)
created_atstring (date-time)erforderlich
updated_atstring (date-time)erforderlich
userAccessRequestUser
sourcesarray of AccessRequestSource
Nur für eine entscheidende Person.
can_add_categoryboolean
profile_usersinteger
Aktive Benutzer des Datenprofils der anfragenden Person (eine Änderung des Profils betrifft alle).

400Die Anfrage ist ungültig: Ein Parameterwert oder der Zustand des Objekts lässt die Aktion nicht zu (`detail` ist eine Meldung).

Antwort-Header

RateLimit-Policy
Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist 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 Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.
RateLimit
Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).
X-RateLimit-Remaining
Verbleibende Anfragen unter dem strengsten Limit.
X-RateLimit-Reset
Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

401Es wurden keine Anmeldedaten gesendet (weder ein Sitzungscookie noch ein API-Schlüssel), oder der Schlüssel wurde nicht gefunden.

Antwort-Header

RateLimit-Policy
Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist 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 Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.
RateLimit
Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).
X-RateLimit-Remaining
Verbleibende Anfragen unter dem strengsten Limit.
X-RateLimit-Reset
Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

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-Policy
Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist 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 Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.
RateLimit
Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).
X-RateLimit-Remaining
Verbleibende Anfragen unter dem strengsten Limit.
X-RateLimit-Reset
Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

404Das Objekt existiert nicht oder ist für Sie nicht verfügbar. Die API bestätigt nicht, dass ein eingeschränktes Objekt existiert.

Antwort-Header

RateLimit-Policy
Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist 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 Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.
RateLimit
Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).
X-RateLimit-Remaining
Verbleibende Anfragen unter dem strengsten Limit.
X-RateLimit-Reset
Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

409Der Zustand des Objekts lässt die Aktion nicht zu, zum Beispiel bei einem Duplikat, einer laufenden Indexierung oder einem bereits verarbeiteten Job.

Antwort-Header

RateLimit-Policy
Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist 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 Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.
RateLimit
Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).
X-RateLimit-Remaining
Verbleibende Anfragen unter dem strengsten Limit.
X-RateLimit-Reset
Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

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-After
Anzahl der Sekunden, die Sie warten sollten, bevor Sie die Anfrage wiederholen.
RateLimit-Policy
Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist 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 Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.
RateLimit
Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).
X-RateLimit-Remaining
Verbleibende Anfragen unter dem strengsten Limit.
X-RateLimit-Reset
Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

Fehlercodes

Codes, die dieser Endpunkt in error.code zurückgeben kann, zusätzlich zu den allgemeinen Codes jeder Anfrage.

Sichere Wiederholungen

Senden Sie bei jedem POST und PATCH einen Header Idempotency-Key (zum Beispiel eine UUID). Eine Wiederholung mit demselben Schlüssel innerhalb von 24 Stunden gibt die gespeicherte Antwort zurück, statt die Anfrage erneut auszuführen.

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.

← access-requests · API-Referenz

curl -X POST 'https://api.sursa.com/v1/access-requests/1/grant' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"collection_ids":[1],"data_profile":"string","add_category":false}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Ausprobieren

API-Schlüssel

Der Schlüssel bleibt im Speicher dieses Tabs und wird nur an https://api.sursa.com gesendet.

Anfragen wirken auf die echten Daten Ihrer Organisation.

X-View-As header

request_id path *

Idempotency-Key header

Idempotency-Key

Ist das Feld leer, wird für jede Anfrage ein neuer Schlüssel erzeugt.

Anfragetext (JSON)