Pāriet uz saturu
Sursa Developers

GET/v1/groups

Iegūt organizācijas grupu sarakstu

list_groups

Bez kind atgriež parastās grupas, „All members“ (visi dalībnieki) un lomu grupas. Personīgās grupas (single_user) tiek atgrieztas tikai ar tieši norādītu kind=single_user. Grupu all_members, role un single_user dalība tiek aprēķināta no organizācijas lietotājiem, tāpat arī to members_count.

Autentifikācija

Nosūtiet API atslēgu galvenē Authorization: Authorization: Bearer <atslēga>.

Vaicājuma parametri

  • kindGroupKind
  • limitinteger

    Lapas izmērs. Bez limit un cursor tiek atgriezts viss saraksts; ar to – ne vairāk kā limit elementu, un nākamā lapa ir norādīta galvenēs Link (rel="next") un X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Nākamās lapas kursors no X-Next-Cursor vai next_cursor iepriekšējā atbildē ar tiem pašiem filtriem; tas ietver lapas izmēru. Kopā ar offset – 422 validation.failed; cita saraksta kursors, kursors ar citiem filtriem vai bojāts kursors – 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Tikai objekti, kuru updated_at ir šis brīdis vai vēlāks (RFC 3339 ar laika joslas nobīdi), sinhronizācijai. Ar to saraksts tiek kārtots pēc updated_at augošā secībā, pēc tam pēc id, un kursors turpina šajā secībā. Dzēstie objekti sarakstā neparādās: par dzēšanu ziņo notikumi.

    length ≤ 512

Atbildes

200Veiksmīga atbilde

Atbildes galvenes

  • Link

    Nākamās lapas adrese, <…>; rel="next". Ja galvenes nav, šī ir pēdējā lapa.

  • X-Next-Cursor

    Nākamās lapas kursors parametram cursor. Ja galvenes nav, šī ir pēdējā lapa.

  • RateLimit-Policy

    Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.

  • RateLimit

    Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).

  • X-RateLimit-Remaining

    Atlikušo pieprasījumu skaits stingrākā limita ietvaros.

  • X-RateLimit-Reset

    Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: GroupList

array of Group
  • idintegerobligāts
  • org_idintegerobligāts
  • keystringobligāts

    Stabila atslēga: all, role:<role>, user:<id> vai parastas grupas atslēga. Saskarne iebūvētās grupas tulko pēc atslēgas.

  • titlestringobligāts
  • kindGroupKindobligāts
  • user_idinteger | nullobligāts

    Tikai personīgās grupas.

  • role_keyRole | nullobligāts

    Tikai lomu grupas.

  • managed_byGroupManagedByobligāts
  • members_countintegerobligāts

    Aktīvo dalībnieku skaits. Deaktivizēti lietotāji nav grupu dalībnieki.

  • disabledbooleanobligāts

    Deaktivizēta lietotāja personīgā grupa: tās piešķīrumi tiek saglabāti, bet nedarbojas, kamēr lietotājs nav aktīvs. Visām citām grupām – false.

  • created_atstring (date-time)obligāts
  • updated_atstring (date-time)obligāts
401Nav nosūtīti akreditācijas dati (ne sesijas sīkdatne, ne API atslēga), vai atslēga nav atrasta.

Atbildes galvenes

  • RateLimit-Policy

    Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.

  • RateLimit

    Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).

  • X-RateLimit-Remaining

    Atlikušo pieprasījumu skaits stingrākā limita ietvaros.

  • X-RateLimit-Reset

    Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: Error

422Validācijas kļūda: saturs vai parametri neatbilst shēmai (`detail` ir validācijas kļūdu saraksts), vai parametra vērtība ir ārpus pieļaujamā diapazona (`detail` ir ziņojums).

Atbildes galvenes

  • RateLimit-Policy

    Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.

  • RateLimit

    Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).

  • X-RateLimit-Remaining

    Atlikušo pieprasījumu skaits stingrākā limita ietvaros.

  • X-RateLimit-Reset

    Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: Error

429Pārāk daudz pieprasījumu (`api.rate_limited`), organizācijas minūtes, dienas vai mēneša kvota ir izlietota (`api.quota_exceeded`; `error.details` satur `quota`, `limit` un `reset_at`), sasniegts organizācijas limits vai atbilžu pakalpojums ir aizņemts (`answers.engine_busy`). Pagaidiet galvenē `Retry-After` norādīto laiku.

Atbildes galvenes

  • Retry-After

    Sekunžu skaits, kas jāpagaida, pirms atkārtojat pieprasījumu.

  • RateLimit-Policy

    Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.

  • RateLimit

    Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).

  • X-RateLimit-Remaining

    Atlikušo pieprasījumu skaits stingrākā limita ietvaros.

  • X-RateLimit-Reset

    Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: Error

Kļūdu kodi

Kodi, ko šī operācija var atgriezt laukā error.code papildus vispārīgajiem kodiem, kas iespējami jebkuram pieprasījumam.

Pieprasījumu biežuma limiti

Atbildēs ir galvenes RateLimit un RateLimit-Policy, kā arī agrākās X-RateLimit-Limit, X-RateLimit-Remaining un X-RateLimit-Reset. Atbildē 429 ir galvene Retry-After sekundēs: nogaidiet un atkārtojiet pieprasījumu.

← groups · API rokasgrāmata