Gå til indholdet
Sursa Developers

GET/v1/groups

Vis organisationens grupper

list_groups

Uden kind returneres almindelige grupper, »All members« og rollegrupper. Personlige grupper (single_user) returneres kun med et eksplicit kind=single_user. Medlemskab af grupper af typen all_members, role og single_user beregnes ud fra organisationens brugere, og det samme gælder deres members_count.

Autentificering

Send en API-nøgle i headeren Authorization: Authorization: Bearer <nøgle>.

Forespørgselsparametre

  • kindGroupKind
  • limitinteger

    Sidestørrelse. Uden limit og cursor returneres hele listen; med den højst limit elementer, og næste side angives i headerne Link (rel="next") og X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Cursor for næste side fra X-Next-Cursor eller next_cursor i det forrige svar med de samme filtre; den indeholder sidestørrelsen. Sammen med offset: 422 validation.failed; en cursor fra en anden liste, med andre filtre eller i et ugyldigt format: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Kun objekter med updated_at på eller efter dette tidspunkt (RFC 3339 med tidszoneforskydning), til synkronisering. Med den sorteres listen stigende efter updated_at og derefter efter id, og cursoren fortsætter i samme rækkefølge. Slettede objekter vises ikke: Sletninger kommer som hændelser.

    length ≤ 512

Svar

200Vellykket svar

Svarets headere

  • Link

    Adressen på næste side, <…>; rel="next". Ingen header betyder, at dette er den sidste side.

  • X-Next-Cursor

    Cursor for næste side til parameteren cursor. Ingen header betyder, at dette er den sidste side.

  • RateLimit-Policy

    Gældende grænser i formatet fra IETF-udkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerede elementer "<name>";q=<quota>;w=<window in seconds>. key er API-nøglens anmodningshastighed (kvoten er burst, vinduet er tiden til fuld genopfyldning; for en session er det user, uden legitimationsoplysninger ip); minute, day og month er organisationens kvoter for kalenderminuttet, kalenderdagen og kalendermåneden i UTC.

  • RateLimit

    Hvad der er tilbage af hver grænse i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Grænsen for den strengeste post i RateLimit-Policy (den med færrest resterende anmodninger).

  • X-RateLimit-Remaining

    Resterende anmodninger under den strengeste grænse.

  • X-RateLimit-Reset

    Sekunder, til den strengeste grænse nulstilles.

application/json

Objekt: GroupList

array of Group
  • idintegerpåkrævet
  • org_idintegerpåkrævet
  • keystringpåkrævet

    Stabil nøgle: all, role:<role>, user:<id> eller nøglen for en almindelig gruppe. Brugerfladen oversætter indbyggede grupper efter nøgle.

  • titlestringpåkrævet
  • kindGroupKindpåkrævet
  • user_idinteger | nullpåkrævet

    Kun personlige grupper.

  • role_keyRole | nullpåkrævet

    Kun rollegrupper.

  • managed_byGroupManagedBypåkrævet
  • members_countintegerpåkrævet

    Antal aktive medlemmer. Deaktiverede brugere er ikke medlemmer af grupper.

  • disabledbooleanpåkrævet

    En deaktiveret brugers personlige gruppe: dens tildelinger bevares, men har ingen virkning, så længe brugeren er inaktiv. false for alle andre grupper.

  • created_atstring (date-time)påkrævet
  • updated_atstring (date-time)påkrævet
401Der blev ikke sendt legitimationsoplysninger (hverken en sessionscookie eller en API-nøgle), eller nøglen blev ikke fundet.

Svarets headere

  • RateLimit-Policy

    Gældende grænser i formatet fra IETF-udkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerede elementer "<name>";q=<quota>;w=<window in seconds>. key er API-nøglens anmodningshastighed (kvoten er burst, vinduet er tiden til fuld genopfyldning; for en session er det user, uden legitimationsoplysninger ip); minute, day og month er organisationens kvoter for kalenderminuttet, kalenderdagen og kalendermåneden i UTC.

  • RateLimit

    Hvad der er tilbage af hver grænse i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Grænsen for den strengeste post i RateLimit-Policy (den med færrest resterende anmodninger).

  • X-RateLimit-Remaining

    Resterende anmodninger under den strengeste grænse.

  • X-RateLimit-Reset

    Sekunder, til den strengeste grænse nulstilles.

application/json

Objekt: Error

422Valideringsfejl: brødteksten eller parametrene svarer ikke til skemaet (`detail` er en liste over valideringsfejl), eller en parameterværdi ligger uden for det tilladte interval (`detail` er en meddelelse).

Svarets headere

  • RateLimit-Policy

    Gældende grænser i formatet fra IETF-udkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerede elementer "<name>";q=<quota>;w=<window in seconds>. key er API-nøglens anmodningshastighed (kvoten er burst, vinduet er tiden til fuld genopfyldning; for en session er det user, uden legitimationsoplysninger ip); minute, day og month er organisationens kvoter for kalenderminuttet, kalenderdagen og kalendermåneden i UTC.

  • RateLimit

    Hvad der er tilbage af hver grænse i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Grænsen for den strengeste post i RateLimit-Policy (den med færrest resterende anmodninger).

  • X-RateLimit-Remaining

    Resterende anmodninger under den strengeste grænse.

  • X-RateLimit-Reset

    Sekunder, til den strengeste grænse nulstilles.

application/json

Objekt: Error

429For mange anmodninger (`api.rate_limited`), organisationens kvote for minuttet, dagen eller måneden er brugt op (`api.quota_exceeded`; `error.details` indeholder `quota`, `limit` og `reset_at`), organisationens grænse er nået, eller svartjenesten er optaget (`answers.engine_busy`). Vent den tid, der står i headeren `Retry-After`.

Svarets headere

  • Retry-After

    Antal sekunder, du skal vente, før du prøver anmodningen igen.

  • RateLimit-Policy

    Gældende grænser i formatet fra IETF-udkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerede elementer "<name>";q=<quota>;w=<window in seconds>. key er API-nøglens anmodningshastighed (kvoten er burst, vinduet er tiden til fuld genopfyldning; for en session er det user, uden legitimationsoplysninger ip); minute, day og month er organisationens kvoter for kalenderminuttet, kalenderdagen og kalendermåneden i UTC.

  • RateLimit

    Hvad der er tilbage af hver grænse i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Grænsen for den strengeste post i RateLimit-Policy (den med færrest resterende anmodninger).

  • X-RateLimit-Remaining

    Resterende anmodninger under den strengeste grænse.

  • X-RateLimit-Reset

    Sekunder, til den strengeste grænse nulstilles.

application/json

Objekt: Error

Fejlkoder

Koder, som denne operation kan returnere i error.code, ud over de generelle koder for alle anmodninger.

Hastighedsgrænser

Svarene har headerne RateLimit og RateLimit-Policy samt de tidligere X-RateLimit-Limit, X-RateLimit-Remaining og X-RateLimit-Reset. Et 429-svar har Retry-After i sekunder: Vent, og forsøg igen.

← groups · API-reference