Mine sisu juurde
Sursa Developers

GET/v1/groups

Organisatsiooni rühmade loetlemine

list_groups

Ilma parameetrita kind tagastab tavalised rühmad, rühma „All members“ ja rollirühmad. Isiklikud rühmad (single_user) tagastatakse ainult selgesõnalise väärtusega kind=single_user. Rühmade all_members, role ja single_user liikmesus arvutatakse organisatsiooni kasutajate põhjal, samuti nende members_count.

Autentimine

Saatke API-võti päises Authorization: Authorization: Bearer <võti>.

Päringuparameetrid

  • kindGroupKind
  • limitinteger

    Lehe suurus. Kui limit ja cursor puuduvad, tagastatakse kogu loend; vastasel juhul kuni limit elementi ning järgmine leht antakse päistes Link (rel="next") ja X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Järgmise lehe kursor päisest X-Next-Cursor või eelmise sama filtritega vastuse väljast next_cursor; see sisaldab lehe suurust. Koos parameetriga offset: 422 validation.failed; teise loendi kursor, teiste filtritega või vigane kursor: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Ainult objektid, mille updated_at on sel hetkel või hiljem (RFC 3339 koos nihkega), sünkroonimiseks. Selle parameetriga sorditakse loend kasvavalt välja updated_at järgi, seejärel välja id järgi, ja kursor jätkab samas järjekorras. Kustutatud objekte ei loetleta: kustutamised tulevad sündmustena.

    length ≤ 512

Vastused

200Edukas vastus

Vastuse päised

  • Link

    Järgmise lehe aadress, <…>; rel="next". Päise puudumine tähendab, et see on viimane leht.

  • X-Next-Cursor

    Järgmise lehe kursor parameetri cursor jaoks. Päise puudumine tähendab, et see on viimane leht.

  • RateLimit-Policy

    Kehtivad piirangud IETF-i mustandi draft-ietf-httpapi-ratelimit-headers vormingus: komadega eraldatud elemendid "<name>";q=<quota>;w=<window in seconds>. key on API-võtme päringusagedus (kvoot on tipuvaru, ajaaken on aeg selle täielikuks taastumiseks; seansi puhul on see user, ilma autentimisandmeteta ip); minute, day ja month on organisatsiooni kvoodid kalendriminutile, -päevale ja -kuule UTC järgi.

  • RateLimit

    Iga päises RateLimit-Policy oleva piirangu jääk: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Päises RateLimit-Policy oleva rangeima kirje limiit (selle, millel on kõige vähem päringuid järel).

  • X-RateLimit-Remaining

    Rangeima piirangu järgi järelejäänud päringud.

  • X-RateLimit-Reset

    Sekundid rangeima piirangu lähtestumiseni.

application/json

Objekt: GroupList

array of Group
  • idintegerkohustuslik
  • org_idintegerkohustuslik
  • keystringkohustuslik

    Püsiv võti: all, role:<role>, user:<id> või tavalise rühma võti. Liides tõlgib sisseehitatud rühmad võtme järgi.

  • titlestringkohustuslik
  • kindGroupKindkohustuslik
  • user_idinteger | nullkohustuslik

    Ainult isiklikel rühmadel.

  • role_keyRole | nullkohustuslik

    Ainult rollirühmadel.

  • managed_byGroupManagedBykohustuslik
  • members_countintegerkohustuslik

    Aktiivsete liikmete arv. Deaktiveeritud kasutajad ei ole rühmade liikmed.

  • disabledbooleankohustuslik

    Deaktiveeritud kasutaja isiklik rühm: selle määramised säilivad, kuid ei mõju, kuni kasutaja on mitteaktiivne. Kõigil teistel rühmadel false.

  • created_atstring (date-time)kohustuslik
  • updated_atstring (date-time)kohustuslik
401Autentimisandmeid ei saadetud (ei seansiküpsist ega API-võtit) või võtit ei leitud.

Vastuse päised

  • RateLimit-Policy

    Kehtivad piirangud IETF-i mustandi draft-ietf-httpapi-ratelimit-headers vormingus: komadega eraldatud elemendid "<name>";q=<quota>;w=<window in seconds>. key on API-võtme päringusagedus (kvoot on tipuvaru, ajaaken on aeg selle täielikuks taastumiseks; seansi puhul on see user, ilma autentimisandmeteta ip); minute, day ja month on organisatsiooni kvoodid kalendriminutile, -päevale ja -kuule UTC järgi.

  • RateLimit

    Iga päises RateLimit-Policy oleva piirangu jääk: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Päises RateLimit-Policy oleva rangeima kirje limiit (selle, millel on kõige vähem päringuid järel).

  • X-RateLimit-Remaining

    Rangeima piirangu järgi järelejäänud päringud.

  • X-RateLimit-Reset

    Sekundid rangeima piirangu lähtestumiseni.

application/json

Objekt: Error

422Valideerimisviga: keha või parameetrid ei vasta skeemile (`detail` on valideerimisvigade loend) või parameetri väärtus on lubatud vahemikust väljas (`detail` on teade).

Vastuse päised

  • RateLimit-Policy

    Kehtivad piirangud IETF-i mustandi draft-ietf-httpapi-ratelimit-headers vormingus: komadega eraldatud elemendid "<name>";q=<quota>;w=<window in seconds>. key on API-võtme päringusagedus (kvoot on tipuvaru, ajaaken on aeg selle täielikuks taastumiseks; seansi puhul on see user, ilma autentimisandmeteta ip); minute, day ja month on organisatsiooni kvoodid kalendriminutile, -päevale ja -kuule UTC järgi.

  • RateLimit

    Iga päises RateLimit-Policy oleva piirangu jääk: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Päises RateLimit-Policy oleva rangeima kirje limiit (selle, millel on kõige vähem päringuid järel).

  • X-RateLimit-Remaining

    Rangeima piirangu järgi järelejäänud päringud.

  • X-RateLimit-Reset

    Sekundid rangeima piirangu lähtestumiseni.

application/json

Objekt: Error

429Liiga palju päringuid (`api.rate_limited`), organisatsiooni minuti-, päeva- või kuukvoot on ära kasutatud (`api.quota_exceeded`; `error.details` sisaldab välju `quota`, `limit` ja `reset_at`), organisatsiooni limiit on täis või vastuseteenus on hõivatud (`answers.engine_busy`). Oodake päises `Retry-After` antud aeg.

Vastuse päised

  • Retry-After

    Sekundite arv, mida oodata enne päringu kordamist.

  • RateLimit-Policy

    Kehtivad piirangud IETF-i mustandi draft-ietf-httpapi-ratelimit-headers vormingus: komadega eraldatud elemendid "<name>";q=<quota>;w=<window in seconds>. key on API-võtme päringusagedus (kvoot on tipuvaru, ajaaken on aeg selle täielikuks taastumiseks; seansi puhul on see user, ilma autentimisandmeteta ip); minute, day ja month on organisatsiooni kvoodid kalendriminutile, -päevale ja -kuule UTC järgi.

  • RateLimit

    Iga päises RateLimit-Policy oleva piirangu jääk: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Päises RateLimit-Policy oleva rangeima kirje limiit (selle, millel on kõige vähem päringuid järel).

  • X-RateLimit-Remaining

    Rangeima piirangu järgi järelejäänud päringud.

  • X-RateLimit-Reset

    Sekundid rangeima piirangu lähtestumiseni.

application/json

Objekt: Error

Veakoodid

Koodid, mida see lõpp-punkt võib lisaks iga päringu üldistele koodidele tagastada väljal error.code.

Sageduspiirangud

Vastustes on päised RateLimit ja RateLimit-Policy ning varasemad X-RateLimit-Limit, X-RateLimit-Remaining ja X-RateLimit-Reset. Vastuses 429 on päis Retry-After sekundites: oodake ja proovige uuesti.

← groups · API teatmik