ドキュメント本文へスキップ
API

メンバーを削除する

2 つの軸を同時に扱います。ロールと、その人がここで持つすべてのアドレス付与です。

DELETEapi.openemail.uk/members/{userId}

実際の呼び出しを、ご自身のキーで自分のワークスペースに対して実行します。

DELETE /members/{userId}

2 つの軸を同時に扱います。ロールと、その人がここで持つすべてのアドレス付与です。

members:write が必要です。

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

2 つの付与はまとめて削除されます。メンバー行だけを削除するのは、両方の結果の悪いとこ取りです。この一覧からは消えたのに、メールはまだ読める状態になります。

メンバーでない相手に対して 404 を返しません。これは id の扱いがいい加減なのではありません。このエンドポイントが最も届く必要のある集団は、アドレス付与だけを持ちメンバー行をまったく持たないレガシーな付与保持者であり、「メンバー行はあるか」という事前チェックは、まさに最も取り消したいアクセス権を持つ人たちを拒否してしまいます。addressesRevoked が実際に起きたことであり、そこがゼロなら、何も起きなかったという正直な報告です。

これは 1 つのワークスペースからの削除です。その人の OpenEmail アカウントには手を触れず、他の場所で持っているアクセス権にも影響しません。

アドレスを 1 つだけ取り上げて本人は残すには、代わりに DELETE /members/{userId}/addresses/{addressId} を使ってください。それは退職した人ではなく、チームを移った人のための呼び出しです。