Zur Dokumentation springen
API

Ein Mitglied entfernen

Beide Achsen auf einmal: die Rolle und jeden Adress-Grant, den sie hier halten.

DELETEapi.openemail.uk/members/{userId}

Führt den echten Aufruf gegen Ihren Workspace aus, mit Ihrem eigenen Schlüssel.

DELETE /members/{userId}

Beide Achsen auf einmal: die Rolle und jeden Adress-Grant, den sie hier halten.

Beispiel

Benötigt members:write.

curl
curl -X DELETE "$OE/members/7fQ2mN8vBz1aRd4tYwKx7fQ2mN8vBz1a" -H "$AUTH"
Antwort
{  "object": "member",  "userId": "7fQ2mN8vBz1aRd4tYwKx7fQ2mN8vBz1a",  "deleted": true,  "addressesRevoked": 2}

Beide Grants gehen gemeinsam. Nur die Mitgliederzeile zu entfernen wäre das schlechteste beider Ergebnisse: aus dieser Liste verschwunden und weiterhin die Post lesend.

Es gibt KEIN 404 für jemanden, der kein Mitglied ist, und das ist keine Nachlässigkeit bei IDs. Die Gruppe, die dieser Endpunkt am dringendsten erreichen muss, sind die Altbestands-Grant-Inhaber, die Adress-Grants und überhaupt keine Mitgliederzeile haben, sodass eine Vorprüfung „gibt es eine Mitgliederzeile“ genau die Personen abweisen würde, deren Zugriff am dringendsten zu entziehen ist. addressesRevoked ist das, was tatsächlich geschehen ist, und eine Null darin ist der ehrliche Bericht über eine wirkungslose Operation.

Es entfernt sie aus EINEM Workspace. Ihr OpenEmail-Konto bleibt unangetastet, ebenso jeder Zugriff, den sie anderswo halten.

Um eine Adresse zurückzunehmen und die Person zu belassen, verwenden Sie stattdessen DELETE /members/{userId}/addresses/{addressId}. Das ist der Aufruf für jemanden, der das Team gewechselt hat, und nicht für jemanden, der gegangen ist.