İçeriğe geç
Sursa Developers

GET/v1/groups

Kuruluşun gruplarını listeleme

list_groups

kind olmadan normal grupları, “All members” grubunu ve rol gruplarını döndürür. Kişisel gruplar (single_user) yalnızca açık bir kind=single_user ile döndürülür. all_members, role ve single_user gruplarının üyeliği kuruluşun kullanıcılarından hesaplanır; members_count değerleri de öyle.

Kimlik doğrulama

API anahtarını Authorization başlığında gönderin: Authorization: Bearer <anahtar>.

Sorgu parametreleri

  • kindGroupKind
  • limitinteger

    Sayfa boyutu. limit ve cursor olmadan listenin tamamı döndürülür; bu parametreyle en fazla limit öğe döner ve sonraki sayfa Link (rel="next") ve X-Next-Cursor başlıklarında verilir.

    ≥ 1, ≤ 200

  • cursorstring

    Sonraki sayfanın imleci: aynı filtrelerle alınan önceki yanıtın X-Next-Cursor başlığından ya da next_cursor alanından alınır; sayfa boyutunu da taşır. offset ile birlikte: 422 validation.failed; başka bir listeye ya da başka filtrelere ait veya bozuk bir imleç: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Senkronizasyon için yalnızca updated_at değeri bu anda ya da bu andan sonra olan nesneler (UTC farkı içeren RFC 3339). Bu parametreyle liste önce artan updated_at değerine, sonra id değerine göre sıralanır ve imleç bu sırayla devam eder. Silinen nesneler listelenmez: silinenler olay olarak gelir.

    length ≤ 512

Yanıtlar

200Başarılı yanıt

Yanıt başlıkları

  • Link

    Sonraki sayfanın adresi, <…>; rel="next". Başlık yoksa bu son sayfadır.

  • X-Next-Cursor

    cursor parametresi için sonraki sayfanın imleci. Başlık yoksa bu son sayfadır.

  • RateLimit-Policy

    Geçerli limitler, IETF taslağı draft-ietf-httpapi-ratelimit-headers biçiminde: virgülle ayrılmış "<name>";q=<quota>;w=<window in seconds> öğeleri. key, API anahtarının istek hızıdır (kota ani artış payıdır, zaman penceresi bu payın tamamen dolma süresidir; oturum için user, kimlik bilgisi olmadan ip); minute, day ve month, kuruluşun UTC’ye göre takvim dakikası, günü ve ayı için kotalarıdır.

  • RateLimit

    RateLimit-Policy içindeki her limitten kalan: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    RateLimit-Policy içindeki en sıkı girdinin limiti (en az istek hakkı kalan girdi).

  • X-RateLimit-Remaining

    En sıkı limitte kalan istek sayısı.

  • X-RateLimit-Reset

    En sıkı limitin sıfırlanmasına kalan saniye.

application/json

Nesne: GroupList

array of Group
  • idintegerzorunlu
  • org_idintegerzorunlu
  • keystringzorunlu

    Kalıcı anahtar: all, role:<role>, user:<id> ya da normal bir grubun anahtarı. Arayüz yerleşik grupları anahtara göre çevirir.

  • titlestringzorunlu
  • kindGroupKindzorunlu
  • user_idinteger | nullzorunlu

    Yalnızca kişisel gruplar.

  • role_keyRole | nullzorunlu

    Yalnızca rol grupları.

  • managed_byGroupManagedByzorunlu
  • members_countintegerzorunlu

    Etkin üye sayısı. Devre dışı bırakılmış kullanıcılar grup üyesi değildir.

  • disabledbooleanzorunlu

    Devre dışı bırakılmış bir kullanıcının kişisel grubu: atamaları korunur, ancak kullanıcı etkin olmadığı sürece etkisizdir. Diğer tüm gruplar için false.

  • created_atstring (date-time)zorunlu
  • updated_atstring (date-time)zorunlu
401Kimlik bilgisi gönderilmedi (ne oturum çerezi ne de API anahtarı) ya da anahtar bulunamadı.

Yanıt başlıkları

  • RateLimit-Policy

    Geçerli limitler, IETF taslağı draft-ietf-httpapi-ratelimit-headers biçiminde: virgülle ayrılmış "<name>";q=<quota>;w=<window in seconds> öğeleri. key, API anahtarının istek hızıdır (kota ani artış payıdır, zaman penceresi bu payın tamamen dolma süresidir; oturum için user, kimlik bilgisi olmadan ip); minute, day ve month, kuruluşun UTC’ye göre takvim dakikası, günü ve ayı için kotalarıdır.

  • RateLimit

    RateLimit-Policy içindeki her limitten kalan: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    RateLimit-Policy içindeki en sıkı girdinin limiti (en az istek hakkı kalan girdi).

  • X-RateLimit-Remaining

    En sıkı limitte kalan istek sayısı.

  • X-RateLimit-Reset

    En sıkı limitin sıfırlanmasına kalan saniye.

application/json

Nesne: Error

422Geçerlilik hatası: gövde ya da parametreler şemaya uymuyor (`detail` geçerlilik hatalarının listesidir) ya da bir parametre değeri aralığın dışında (`detail` bir iletidir).

Yanıt başlıkları

  • RateLimit-Policy

    Geçerli limitler, IETF taslağı draft-ietf-httpapi-ratelimit-headers biçiminde: virgülle ayrılmış "<name>";q=<quota>;w=<window in seconds> öğeleri. key, API anahtarının istek hızıdır (kota ani artış payıdır, zaman penceresi bu payın tamamen dolma süresidir; oturum için user, kimlik bilgisi olmadan ip); minute, day ve month, kuruluşun UTC’ye göre takvim dakikası, günü ve ayı için kotalarıdır.

  • RateLimit

    RateLimit-Policy içindeki her limitten kalan: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    RateLimit-Policy içindeki en sıkı girdinin limiti (en az istek hakkı kalan girdi).

  • X-RateLimit-Remaining

    En sıkı limitte kalan istek sayısı.

  • X-RateLimit-Reset

    En sıkı limitin sıfırlanmasına kalan saniye.

application/json

Nesne: Error

429Çok fazla istek (`api.rate_limited`), kuruluşun dakika, gün ya da ay kotası doldu (`api.quota_exceeded`; `error.details` alanında `quota`, `limit` ve `reset_at` bulunur), kuruluşun limitine ulaşıldı ya da yanıt hizmeti meşgul (`answers.engine_busy`). `Retry-After` başlığındaki süre kadar bekleyin.

Yanıt başlıkları

  • Retry-After

    İsteği yeniden denemeden önce beklenmesi gereken saniye sayısı.

  • RateLimit-Policy

    Geçerli limitler, IETF taslağı draft-ietf-httpapi-ratelimit-headers biçiminde: virgülle ayrılmış "<name>";q=<quota>;w=<window in seconds> öğeleri. key, API anahtarının istek hızıdır (kota ani artış payıdır, zaman penceresi bu payın tamamen dolma süresidir; oturum için user, kimlik bilgisi olmadan ip); minute, day ve month, kuruluşun UTC’ye göre takvim dakikası, günü ve ayı için kotalarıdır.

  • RateLimit

    RateLimit-Policy içindeki her limitten kalan: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    RateLimit-Policy içindeki en sıkı girdinin limiti (en az istek hakkı kalan girdi).

  • X-RateLimit-Remaining

    En sıkı limitte kalan istek sayısı.

  • X-RateLimit-Reset

    En sıkı limitin sıfırlanmasına kalan saniye.

application/json

Nesne: Error

Hata kodları

Bu uç noktanın, her isteğin genel kodlarının yanı sıra error.code alanında döndürebileceği kodlar.

Hız sınırları

Yanıtlarda RateLimit ve RateLimit-Policy başlıklarıyla birlikte daha eski X-RateLimit-Limit, X-RateLimit-Remaining ve X-RateLimit-Reset başlıkları bulunur. 429 yanıtında saniye cinsinden Retry-After başlığı vardır: bekleyin ve yeniden deneyin.

← groups · API başvurusu