Obtenir les membres d’une organisation

Lister les membres de l’organisation. Ce point de terminaison est soumis à une cohérence éventuelle. Il se peut que les nouveaux utilisateurs ne soient pas immédiatement inclus dans la réponse et que les utilisateurs supprimés n’en soient pas immédiatement retirés.

• Utilisez le paramètre fields pour définir de manière facultative les détails précis des membres à récupérer. Si fields est laissé vide, tous les champs (sauf les rôles) sont renvoyés.
• Les rôles des membres ne sont pas renvoyés par défaut. Utilisez fields=roles pour récupérer les rôles attribués à chaque membre de la liste. Pour utiliser ce paramètre, vous devez inclure le scope read:organization_member_roles dans le jeton.

Ce point de terminaison prend en charge deux types de pagination :

• Pagination par offset
• Pagination par checkpoint

La pagination par checkpoint doit être utilisée si vous devez récupérer plus de 1000 membres de l’organisation.

Pagination par checkpoint

Pour effectuer une recherche par checkpoint, utilisez les paramètres suivants : - from : id facultatif à partir duquel commencer la sélection. - take : nombre total d’entrées à récupérer lors de l’utilisation du paramètre from. La valeur par défaut est 50. Remarque : la première fois que vous appelez ce point de terminaison à l’aide de la pagination par checkpoint, vous devez omettre le paramètre from. S’il y a d’autres résultats, une valeur next sera incluse dans la réponse. Vous pouvez l’utiliser pour les appels d’API suivants. Lorsque next n’est plus inclus dans la réponse, cela indique qu’il ne reste plus de pages.

GET https://{tenantDomain}/api/v2/organizations/{id}/members

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
    organizations "github.com/auth0/go-auth0/management/management/organizations"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &organizations.ListOrganizationMembersRequestParameters{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.Organizations.Members.List(
        context.TODO(),
        "id",
        request,
    )
}

200

[
  {
    "email": "[e-mail]",
    "name": "<string>",
    "picture": "<string>",
    "roles": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "user_id": "<string>"
  }
]

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

id · string · requis

Identifiant de l’organisation.

Maximum string length: 50

Paramètres de requête

page · integer

Indice de la page de résultats à renvoyer. La première page est 0.

Plage requise: 0 <= x <= 1000

per_page · integer

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

Plage requise: 1 <= x <= 100

include_totals · boolean

Renvoyer les résultats dans un objet contenant le nombre total de résultats (true) ou sous forme de tableau de résultats direct (false, valeur par défaut).

from · string

Id facultatif à partir duquel commencer la sélection.

take · integer

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

Plage requise: 1 <= x <= 100

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 ce champ vide pour récupérer tous les champs.

include_fields · boolean

Indique si les champs spécifiés doivent être inclus (true) ou exclus (false).

Réponse

200

application/json

Membres récupérés avec succès.

Option 1 · object[]

Option 2 · object

Option 3 · object

email · string<email> · défaut: [e-mail]

Adresse de courriel de cet utilisateur.

name · string

Nom de cet utilisateur.

picture · string

URL de l’image de cet utilisateur.

roles · object[]

Show child attributes

user_id · string

ID de cet utilisateur.