Belgelere geç
API

Bir rolü güncelle

Her alan isteğe bağlıdır ve `permissions` tüm listenin yerine geçer.

PATCHapi.openemail.uk/roles/{id}

Gerçek çağrıyı kendi anahtarınızla çalışma alanınıza karşı çalıştırır.

PATCH /roles/{id}

Her alan isteğe bağlıdır ve permissions tüm listenin yerine geçer.

Örnek

roles:write gerektirir. Bir alanı atlamak onu olduğu gibi bırakır; PATCH'in anlamı da budur.

curl
curl -X PATCH "$OE/roles/role_2b81de079c1f0a4b7e05d386" -H "$AUTH" \  -H "Content-Type: application/json" \  -d '{ "permissions": ["emails:read", "threads:read", "labels:read", "contacts:read"] }'
Yanıt
{  "object": "role",  "id": "role_2b81de079c1f0a4b7e05d386",  "name": "Support",  "description": "Answers the shared inboxes and nothing else.",  "permissions": ["emails:read", "threads:read", "labels:read", "contacts:read"],  "builtin": null,  "editable": true,  "deletable": true,  "members": 3,  "apiKeys": 1,  "createdAt": "2026-08-30T10:41:02.000Z",  "updatedAt": "2026-08-30T13:02:19.000Z"}

permissions tüm listenin YERİNE GEÇER. Tek bir izin veren bir çağrı yoktur ve olmayacaktır: denetlenen şey listedir ve indekse göre adreslenen bir patch, iki sekme açık olduğu anda kaybolan bir güncellemedir. Rolü okuyun, kastettiğiniz girişi değiştirin ve hepsini geri gönderin. Tek bir izin göndermek izin eklemez; rolü tam olarak o izin ve onun ima ettikleriyle bırakır.

description isteğe bağlı olduğu gibi null da olabilir ve bu fark bir patch'in bütün amacıdır: atlamak saklanan cümleyi korur, null göndermek onu temizler. Null olabilme özelliği olmasaydı, bir açıklamayı kaldırmanın boşlukla değiştirmek dışında bir yolu olmazdı.

PATCH'in reddettiği tek rol owner'dır ve onun her alanını reddeder: param: "roleId" ile bir 409, role_immutable. Hazır gelenler dahil diğer her rol yeni bir adı, yeni bir izin listesi kadar kolay kabul eder. builtin bir rolün nereden geldiğini kaydeder, ona ne yapılabileceğini değil. Başka bir rolün zaten kullandığı bir ad ise param: "name" ile bir 409 olan role_name_taken döner.

Düzenleme, API anahtarları dahil rolü taşıyan herkesin BİR SONRAKİ isteğinde yürürlüğe girer, çünkü tavan önbelleğe alınmaz, istek başına çözümlenir. Bu nedenle bir rolü daraltmak, altındaki anahtarlar döndürülmeden yürürlüğe giren canlı bir geri almadır. Genişletmek de aynı şekilde canlıdır; hatırlanmaya değer yarısı budur.