Siirry sisältöön
Sursa Developers

GET/v1/groups

Listaa organisaation ryhmät

list_groups

Ilman kind-parametria palauttaa tavalliset ryhmät, ”All members” -ryhmän ja rooliryhmät. Henkilökohtaiset ryhmät (single_user) palautetaan vain, kun annetaan nimenomaisesti kind=single_user. all_members-, role- ja single_user-ryhmien jäsenyys lasketaan organisaation käyttäjistä, samoin niiden members_count.

Todennus

Lähetä API-avain Authorization-otsakkeessa: Authorization: Bearer <avain>.

Kyselyparametrit

  • kindGroupKind
  • limitinteger

    Sivukoko. Ilman limit- ja cursor-parametreja palautetaan koko lista; parametrin kanssa enintään limit kohdetta, ja seuraavan sivun osoite on Link-otsakkeessa (rel="next") ja X-Next-Cursor-otsakkeessa.

    ≥ 1, ≤ 200

  • cursorstring

    Seuraavan sivun kursori X-Next-Cursor-otsakkeesta tai edellisen, samoilla suodattimilla tehdyn vastauksen next_cursor-kentästä; se sisältää sivukoon. Yhdessä offset-parametrin kanssa: 422 validation.failed; toisen listan kursori, eri suodattimet tai virheellinen kursori: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Vain objektit, joiden updated_at on tämä hetki tai sen jälkeen (RFC 3339 -muodossa aikavyöhykkeen siirtymän kanssa), synkronointia varten. Sen kanssa lista lajitellaan updated_at-kentän mukaan nousevasti ja sitten id-kentän mukaan, ja kursori jatkaa samassa järjestyksessä. Poistettuja objekteja ei listata: poistot tulevat tapahtumina.

    length ≤ 512

Vastaukset

200Onnistunut vastaus

Vastausotsakkeet

  • Link

    Seuraavan sivun osoite, <…>; rel="next". Jos otsaketta ei ole, tämä on viimeinen sivu.

  • X-Next-Cursor

    Seuraavan sivun kursori cursor-parametria varten. Jos otsaketta ei ole, tämä on viimeinen sivu.

  • RateLimit-Policy

    Voimassa olevat rajat IETF-luonnoksen draft-ietf-httpapi-ratelimit-headers muodossa: pilkuin erotetut kohteet "<name>";q=<quota>;w=<window in seconds>. key on API-avaimen pyyntönopeus (kiintiö on purske, aikaikkuna on aika, jossa se täyttyy kokonaan; istunnolle se on user, ilman tunnistetietoja ip); minute, day ja month ovat organisaation kiintiöt UTC-ajan kalenteriminuutille, -päivälle ja -kuukaudelle.

  • RateLimit

    Mitä kustakin RateLimit-Policy-otsakkeen rajasta on jäljellä: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    RateLimit-Policy-otsakkeen tiukimman kohteen raja (sen, jossa pyyntöjä on jäljellä vähiten).

  • X-RateLimit-Remaining

    Tiukimman rajan puitteissa jäljellä olevat pyynnöt.

  • X-RateLimit-Reset

    Sekunteja siihen, kun tiukin raja nollautuu.

application/json

Objekti: GroupList

array of Group
  • idintegerpakollinen
  • org_idintegerpakollinen
  • keystringpakollinen

    Pysyvä avain: all, role:<role>, user:<id> tai tavallisen ryhmän avain. Käyttöliittymä kääntää sisäänrakennetut ryhmät avaimen mukaan.

  • titlestringpakollinen
  • kindGroupKindpakollinen
  • user_idinteger | nullpakollinen

    Vain henkilökohtaiset ryhmät.

  • role_keyRole | nullpakollinen

    Vain rooliryhmät.

  • managed_byGroupManagedBypakollinen
  • members_countintegerpakollinen

    Aktiivisten jäsenten määrä. Käytöstä poistetut käyttäjät eivät ole ryhmien jäseniä.

  • disabledbooleanpakollinen

    Käytöstä poistetun käyttäjän henkilökohtainen ryhmä: sen määritykset säilyvät, mutta ne eivät vaikuta, kun käyttäjä ei ole aktiivinen. false kaikilla muilla ryhmillä.

  • created_atstring (date-time)pakollinen
  • updated_atstring (date-time)pakollinen
401Tunnistetietoja ei lähetetty (ei istuntoevästettä eikä API-avainta), tai avainta ei löytynyt.

Vastausotsakkeet

  • RateLimit-Policy

    Voimassa olevat rajat IETF-luonnoksen draft-ietf-httpapi-ratelimit-headers muodossa: pilkuin erotetut kohteet "<name>";q=<quota>;w=<window in seconds>. key on API-avaimen pyyntönopeus (kiintiö on purske, aikaikkuna on aika, jossa se täyttyy kokonaan; istunnolle se on user, ilman tunnistetietoja ip); minute, day ja month ovat organisaation kiintiöt UTC-ajan kalenteriminuutille, -päivälle ja -kuukaudelle.

  • RateLimit

    Mitä kustakin RateLimit-Policy-otsakkeen rajasta on jäljellä: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    RateLimit-Policy-otsakkeen tiukimman kohteen raja (sen, jossa pyyntöjä on jäljellä vähiten).

  • X-RateLimit-Remaining

    Tiukimman rajan puitteissa jäljellä olevat pyynnöt.

  • X-RateLimit-Reset

    Sekunteja siihen, kun tiukin raja nollautuu.

application/json

Objekti: Error

422Validointivirhe: runko tai parametrit eivät vastaa skeemaa (`detail` on validointivirheiden lista), tai parametrin arvo on sallitun alueen ulkopuolella (`detail` on viesti).

Vastausotsakkeet

  • RateLimit-Policy

    Voimassa olevat rajat IETF-luonnoksen draft-ietf-httpapi-ratelimit-headers muodossa: pilkuin erotetut kohteet "<name>";q=<quota>;w=<window in seconds>. key on API-avaimen pyyntönopeus (kiintiö on purske, aikaikkuna on aika, jossa se täyttyy kokonaan; istunnolle se on user, ilman tunnistetietoja ip); minute, day ja month ovat organisaation kiintiöt UTC-ajan kalenteriminuutille, -päivälle ja -kuukaudelle.

  • RateLimit

    Mitä kustakin RateLimit-Policy-otsakkeen rajasta on jäljellä: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    RateLimit-Policy-otsakkeen tiukimman kohteen raja (sen, jossa pyyntöjä on jäljellä vähiten).

  • X-RateLimit-Remaining

    Tiukimman rajan puitteissa jäljellä olevat pyynnöt.

  • X-RateLimit-Reset

    Sekunteja siihen, kun tiukin raja nollautuu.

application/json

Objekti: Error

429Liian monta pyyntöä (`api.rate_limited`), organisaation minuutti-, päivä- tai kuukausikiintiö on käytetty (`api.quota_exceeded`; `error.details` sisältää kentät `quota`, `limit` ja `reset_at`), organisaation raja on saavutettu tai vastauspalvelu on kuormitettu (`answers.engine_busy`). Odota `Retry-After`-otsakkeen ilmoittama aika.

Vastausotsakkeet

  • Retry-After

    Kuinka monta sekuntia odotetaan ennen pyynnön uusintayritystä.

  • RateLimit-Policy

    Voimassa olevat rajat IETF-luonnoksen draft-ietf-httpapi-ratelimit-headers muodossa: pilkuin erotetut kohteet "<name>";q=<quota>;w=<window in seconds>. key on API-avaimen pyyntönopeus (kiintiö on purske, aikaikkuna on aika, jossa se täyttyy kokonaan; istunnolle se on user, ilman tunnistetietoja ip); minute, day ja month ovat organisaation kiintiöt UTC-ajan kalenteriminuutille, -päivälle ja -kuukaudelle.

  • RateLimit

    Mitä kustakin RateLimit-Policy-otsakkeen rajasta on jäljellä: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    RateLimit-Policy-otsakkeen tiukimman kohteen raja (sen, jossa pyyntöjä on jäljellä vähiten).

  • X-RateLimit-Remaining

    Tiukimman rajan puitteissa jäljellä olevat pyynnöt.

  • X-RateLimit-Reset

    Sekunteja siihen, kun tiukin raja nollautuu.

application/json

Objekti: Error

Virhekoodit

Koodit, jotka tämä päätepiste voi palauttaa error.code-kentässä kaikkien pyyntöjen yleisten koodien lisäksi.

Nopeusrajoitukset

Vastauksissa ovat RateLimit- ja RateLimit-Policy-otsakkeet sekä aiemmat X-RateLimit-Limit, X-RateLimit-Remaining ja X-RateLimit-Reset. 429-vastauksessa on Retry-After sekunteina: odota ja yritä uudelleen.

← groups · API-viite