Belgelere geç
API

Bir alan adı yetkisi ver ve geri al

Bütün bir alan adı tek seferde: üzerindeki her adres, sonradan eklenenler dahil.

POST/members/{userId}/domains

2 çağrıdan herhangi birini çalışma alanınızda çalıştırır.

POST /members/{userId}/domains

Bütün bir alan adı tek seferde: üzerindeki her adres, sonradan eklenenler dahil.

Bir alan adı yetkisi ver

members:write gerektirir. { domainId, access } ile POST /members/{userId}/domains; access varsayılan olarak member'dır. Üyenin güncel hâlinin tamamını, yetki domains içinde olacak şekilde döndürür.

curl
curl -X POST "$OE/members/nQ8vBz1aRd4tYwKx7fQ2mN8vBz1aRd4t/domains" -H "$AUTH" \    -H "Content-Type: application/json" \    -d '{ "domainId": "7d2a9c41-5b3e-4f8a-9c06-1e2b3c4d5e6f", "access": "viewer" }'
Yanıt
{    "object": "member",    "userId": "nQ8vBz1aRd4tYwKx7fQ2mN8vBz1aRd4t",    "email": "[email protected]",    "role": { "id": "role_2b81de079c1f0a4b7e05d386", "name": "Support", "builtin": null },    "addresses": [],    "domains": [      {        "domainId": "7d2a9c41-5b3e-4f8a-9c06-1e2b3c4d5e6f",        "domain": "acme.com",        "access": "viewer"      }    ]  }

Adres yetkisi gibi bir upsert'tir: farklı bir access ile yeniden POST etmek, ikinci bir yetki eklemek yerine yetkiyi değiştirir.

Bir alan adı yetkisi, alan adındaki her adrese, yetkiden sonra eklenen adresler dahil erişir; bu yüzden bütün bir alan adıyla ilgilenen biri için verilecek yetki budur. Tek tek yetki verilen adresler onun yanında olduğu gibi kalır.

Kişinin zaten çalışma alanında olması gerekir; bu yüzden onu önce POST /members ile davet edin. Sahip her alan adına eriştiği için member_is_owner ile reddedilir; planında ekip erişimi olmayan bir çalışma alanı ise 403 plan_required ile reddedilir.

Belirli adreslerle ya da alan adlarıyla sınırlı bir anahtar ya da uygulama 422 capability_unsupported ile reddedilir; bir üye adına çalışan bir uygulama ise yalnızca o üyenin erişebildiği bir alan adını verebilir.

Bir OAuth erişim tokenı bu çağrı için bir doğrulama kodu gerektirir. Uygulama son 60 dakika içinde bir kod doğrulayana kadar çağrı 403 step_up_required yanıtını verir ve hiçbir şeyi değiştirmez. Bir API anahtarından asla istenmez. Kimlik doğrulama sayfası bir kodun nasıl isteneceğini ve doğrulanacağını gösterir.

Bir alan adı yetkisini geri al

members:write gerektirir. DELETE /members/{userId}/domains/{domainId}. Üyeyi, o alan adı çıkarılmış hâliyle döndürür.

curl
curl -X DELETE \    "$OE/members/nQ8vBz1aRd4tYwKx7fQ2mN8vBz1aRd4t/domains/7d2a9c41-5b3e-4f8a-9c06-1e2b3c4d5e6f" \    -H "$AUTH"
Yanıt
{    "object": "member",    "userId": "nQ8vBz1aRd4tYwKx7fQ2mN8vBz1aRd4t",    "email": "[email protected]",    "role": { "id": "role_2b81de079c1f0a4b7e05d386", "name": "Support", "builtin": null },    "addresses": [],    "domains": []  }

Alan adında tek tek yetki verilmiş adreslerin yetkisi sürer ve kişi rolünü korur.

Bu çalışma alanında olmayan bir alan adı sessizce yok sayılmaz, 422 member_not_found ile reddedilir.

Bir OAuth erişim tokenı bu çağrı için bir doğrulama kodu gerektirir. Uygulama son 60 dakika içinde bir kod doğrulayana kadar çağrı 403 step_up_required yanıtını verir ve hiçbir şeyi değiştirmez. Bir API anahtarından asla istenmez. Kimlik doğrulama sayfası bir kodun nasıl isteneceğini ve doğrulanacağını gösterir.

Referans