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

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.Roles.Users.ListAsync(
            id: "id",
            request: new ListRoleUsersRequestParameters {
                From = "from",
                Take = 1
            }
        );
    }

}

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.ListRoleUsersRequestParameters{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
    }
    mgmt.Roles.Users.List(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.roles.types.ListRoleUsersRequestParameters;

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

        client.roles().users().list(
            "id",
            ListRoleUsersRequestParameters
                .builder()
                .from("from")
                .take(1)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Roles\Users\Requests\ListRoleUsersRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->roles->users->list(
    'id',
    new ListRoleUsersRequestParameters([
        'from' => 'from',
        'take' => 1,
    ]),
);

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

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

Obtenir les utilisateurs du rôle

deprecated

Récupérer la liste des utilisateurs associés à un rôle précis. Pour obtenir des instructions dans le Dashboard, consultez View Users Assigned to Roles.

Remarque : renvoie uniquement les utilisateurs auxquels des rôles sont directement attribués. Pour les groupes attribués à ce rôle, utilisez GET /api/v2/roles/{id}/groups.

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

Pagination par décalage
Pagination par checkpoint

La pagination par checkpoint doit être utilisée si vous devez récupérer plus de 1 000 membres d’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 de 50.

Remarque : la première fois que vous appelez ce point de terminaison en utilisant la pagination par checkpoint, omettez le paramètre from. S’il y a d’autres résultats, une valeur next est 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 signifie qu’il ne reste plus de pages.

GET

https://{tenantDomain}/api/v2

roles

{id}

users

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

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.Roles.Users.ListAsync(
            id: "id",
            request: new ListRoleUsersRequestParameters {
                From = "from",
                Take = 1
            }
        );
    }

}

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.ListRoleUsersRequestParameters{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
    }
    mgmt.Roles.Users.List(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.roles.types.ListRoleUsersRequestParameters;

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

        client.roles().users().list(
            "id",
            ListRoleUsersRequestParameters
                .builder()
                .from("from")
                .take(1)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Roles\Users\Requests\ListRoleUsersRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->roles->users->list(
    'id',
    new ListRoleUsersRequestParameters([
        'from' => 'from',
        'take' => 1,
    ]),
);

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

[
  {
    "email": "john.doe@gmail.com",
    "name": "<string>",
    "picture": "<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

ID du rôle pour lequel récupérer la liste des utilisateurs associés.

Paramètres de requête

per_page

integer

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

Plage requise: 1 <= x <= 100

page

integer

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

Plage requise: x >= 0

include_totals

boolean

Renvoyer les résultats dans un objet contenant le nombre total de résultats (true) ou directement sous forme de tableau 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

Réponse

Les utilisateurs associés au rôle ont été 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 profil de cet utilisateur.

user_id

string

ID de cet utilisateur.