using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Organizations;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Organizations.Members.ListAsync(
            id: "id",
            request: new ListOrganizationMembersRequestParameters {
                From = "from",
                Take = 1,
                Fields = "fields",
                IncludeFields = true
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.ListOrganizationMembersRequestParameters{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    mgmt.Organizations.Members.List(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.organizations.types.ListOrganizationMembersRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.organizations().members().list(
            "id",
            ListOrganizationMembersRequestParameters
                .builder()
                .from("from")
                .take(1)
                .fields("fields")
                .includeFields(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Organizations\Members\Requests\ListOrganizationMembersRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->members->list(
    'id',
    new ListOrganizationMembersRequestParameters([
        'from' => 'from',
        'take' => 1,
        'fields' => 'fields',
        'includeFields' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.organizations.members.list(
    id="id",
    from="from",
    take=1,
    fields="fields",
    include_fields=True,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.organizations.members.list(
  id: "id",
  from: "from",
  take: 1,
  fields: "fields",
  include_fields: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.members.list("id", {
        from: "from",
        take: 1,
        fields: "fields",
        includeFields: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.members.list("id", {
        from: "from",
        take: 1,
        fields: "fields",
        includeFields: true,
    });
}
main();

[
  {
    "email": "john.doe@gmail.com",
    "name": "<string>",
    "picture": "<string>",
    "roles": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "user_id": "<string>"
  }
]

Obtenir les membres de l’organisation

deprecated

Liste des membres de l’organisation. Ce endpoint 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, au besoin, 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 envoyés par défaut. Utilisez fields=roles pour récupérer les rôles attribués à chaque membre répertorié. Pour utiliser ce paramètre, vous devez inclure la portée read:organization_member_roles dans le token. Seuls les rôles directement attribués sont renvoyés. Pour inclure également les attributions de rôles basées sur les groupes, utilisez GET /api/v2/organizations/{id}/members/{user_id}/effective-roles.

Ce endpoint 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 1 000 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 lorsque le paramètre from est utilisé. La valeur par défaut est 50. Remarque : la première fois que vous appelez ce endpoint à 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

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Organizations;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Organizations.Members.ListAsync(
            id: "id",
            request: new ListOrganizationMembersRequestParameters {
                From = "from",
                Take = 1,
                Fields = "fields",
                IncludeFields = true
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.ListOrganizationMembersRequestParameters{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    mgmt.Organizations.Members.List(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.organizations.types.ListOrganizationMembersRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.organizations().members().list(
            "id",
            ListOrganizationMembersRequestParameters
                .builder()
                .from("from")
                .take(1)
                .fields("fields")
                .includeFields(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Organizations\Members\Requests\ListOrganizationMembersRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->members->list(
    'id',
    new ListOrganizationMembersRequestParameters([
        'from' => 'from',
        'take' => 1,
        'fields' => 'fields',
        'includeFields' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.organizations.members.list(
    id="id",
    from="from",
    take=1,
    fields="fields",
    include_fields=True,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.organizations.members.list(
  id: "id",
  from: "from",
  take: 1,
  fields: "fields",
  include_fields: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.members.list("id", {
        from: "from",
        take: 1,
        fields: "fields",
        includeFields: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.members.list("id", {
        from: "from",
        take: 1,
        fields: "fields",
        includeFields: true,
    });
}
main();

[
  {
    "email": "john.doe@gmail.com",
    "name": "<string>",
    "picture": "<string>",
    "roles": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "user_id": "<string>"
  }
]

Autorisations

Authorization

string

header

requis

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

Paramètres de chemin

string

requis

Identifiant de l’organisation.

Maximum string length: 50

Paramètres de requête

page

integer

Index 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 array directe de résultats (false, 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 vide pour récupérer tous les champs.

include_fields

boolean

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

Réponse

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

Option 1 · object[]
Option 2 · object
Option 3 · object

string<email>

défaut:john.doe@gmail.com

Adresse 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.