Skip to main content
GET
Lister les membres

Autorisations

Authorization
string
header
requis

The access token received from the authorization server in the OAuth 2.0 flow.

Paramètres de requête

fields
string

Liste de champs séparés par des virgules à inclure ou à exclure (selon la valeur fournie pour include_fields) dans le résultat. Laissez vide pour récupérer tous les champs. Le champ 'roles' n’est pas renvoyé par défaut ; il n’est inclus que lorsque 'roles' est explicitement demandé dans la liste des champs (mode inclusion) et que le jeton contient aussi la portée read:my_org:member_roles. Si 'roles' est demandé sans cette portée, il est silencieusement omis de la réponse.

Required string length: 1 - 255
include_fields
boolean
défaut:true

Indique si les champs spécifiés doivent être inclus (true) ou exclus (false). La valeur par défaut est true

from
string

Curseur facultatif à partir duquel commencer la sélection (exclusif).

Required string length: 1 - 1000
take
integer
défaut:50

Nombre de résultats par page. La valeur par défaut est 50.

Plage requise: 1 <= x <= 100
include_totals
boolean
défaut:false

Lorsque true, la réponse inclut un décompte 'total' des éléments de l'ensemble de résultats (tenant compte des filtres actifs), ainsi qu'un indicateur 'total_is_capped'. Ce décompte est approximatif et plafonné à 1000 ; si la taille réelle peut être supérieure, 'total_is_capped' est true et 'total' constitue une borne inférieure. Omis s'il n'est pas demandé.

Réponse

Lister les membres d’une organisation.

next
string

Curseur de pagination pour la page de résultats suivante.

total
integer
read-only

Nombre approximatif de membres dans l'ensemble de résultats (tenant compte des filtres actifs). Présent uniquement lorsque include_totals=true. Plafonné à 1000.

total_is_capped
boolean
read-only

Indique si le décompte s'est arrêté avant d'atteindre la taille réelle de l'ensemble de résultats. Lorsque true, 'total' constitue une borne inférieure (la taille réelle est égale ou supérieure à 'total') ; lorsque false, 'total' reflète l'ensemble complet de résultats tel qu'il a été décompté. Présent uniquement lorsque 'total' est présent.

members
object[]