Kuruluş önerilerimi listeleyin

GET /fapi/v1/me/organization-suggestions · environment'ın giriş ana bilgisayarından çağrılır

Kimliği doğrulanmış kullanıcının doğrulanmış e-posta adreslerinden birinin alan adı nedeniyle katılmaya davet edildiği kuruluşları listeler. Bir kuruluş; etkin olduğunda, o alan adını alan adı yakalaması suggest olarak ayarlanmış şekilde doğruladığında ve kullanıcının o kuruluşta üyeliği olmadığında önerilir (kaldırılmış veya ayrılmış üyelik de sayılır, bu yüzden bir daha önerilmez). Her kuruluş için bir öğe döndürülür; kuruluşlar slug sırasına göre listelenir ve en fazla 20 öğe gelir. Kullanıcının üç kez kapattığı bir kuruluş listelenmez. environment'ın varsayılan üye rolü alan adı yakalamasıyla verilemiyorsa (yönetici rolü, ayrıcalıklı bir rol veya kuruluşu ve üyelerini okumanın ötesinde sistem izinlerine sahip bir rol), liste boştur. Okuma hiçbir şeyi değiştirmez ve yakın zamanda doğrulanmış bir oturum gerektirmez. Kimliği doğrulanmış kullanıcının __Host-idp_session çerezi gereklidir; çerez yoksa, süresi dolmuşsa veya iptal edilmişse 401 unauthenticated döndürür. Farklı bir kökenden gelen birinci taraf uygulama, bunun yerine ön yüz API erişim belirtecini gönderebilir (DPoP kanıtıyla birlikte Authorization: DPoP <token>; bkz. Ön yüz API erişim belirteci).

@keenauth/js ile: await keenauth.organizations.suggestions().

İstek

Üstbilgiler:

Üstbilgi Zorunlu Açıklama
Idp-Client evet SDK tanımlayıcısı.

Sorgu parametresi yoktur. Gövde yoktur.

Yanıt

{"data": [...]} içeren 200 OK. Yanıt önbelleğe alınmaz (Cache-Control: no-store).

Her öğe: id (odm_…, doğrulanmış alan adı kaydı; katılmak veya kapatmak için kullanın), domain (eşleşen e-posta alan adı) ve organization nesnesi; bu nesne id (org_…), slug ve name alanlarını içerir (kontrol ve çift yönlü karakterleri kaldırılmış görünen ad; kuruluşun adı yoksa slug; düz metin olarak gösterin).

Hatalar

Durum Kod Ne zaman
401 unauthenticated Geçerli bir oturum çerezi veya ön yüz API erişim belirteci yoksa.
503 temporarily_unavailable Üyelik dizini yanıt vermediyse; daha sonra yeniden deneyin.

Örnek

curl https://example.keenauth.app/fapi/v1/me/organization-suggestions \
  -H "Idp-Client: my-app/1.0.0 (node/22.0.0)" \
  -b cookies.txt
{
  "data": [
    {
      "id": "odm_01j9a5c4000000000000000001",
      "domain": "acme.example",
      "organization": {
        "id": "org_01j9xxxxxxxxxxxxxxxxxxxxxx",
        "slug": "acme",
        "name": "Acme"
      }
    }
  ]
}

Kişisel veriler

Bu uç nokta kişisel veri içerir: kuruluş üyelikleri ve davetler. KeenAuth API'lerinde kişisel veriler neyin saklandığını, ne kadar süre tutulduğunu ve nasıl silindiğini açıklar. Hiçbir alanda özel nitelikli kişisel verileri (sağlık, biyometrik veriler, din, siyasi görüşler, cinsel yönelim) göndermeyin.