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>"
  }
]

ロールのユーザーを取得

特定の role に関連付けられたユーザーの一覧を取得します。Auth0 Dashboard での手順については、View Users Assigned to Rolesを参照してください。

注: 直接 role が割り当てられているユーザーのみを返します。この role に割り当てられた group については、GET /api/v2/roles/{id}/groupsを使用してください。

この endpoint は、次の 2 種類のページネーションをサポートしています。

オフセットページネーション
checkpoint ページネーション

1000 件を超える organization のメンバーを取得する必要がある場合は、checkpoint ページネーションを使用する必要があります。

Checkpoint Pagination

checkpoint で検索するには、次のパラメーターを使用します。

from: 取得を開始する任意の ID。
take: from パラメーターを使用する際に取得するエントリー総数。デフォルトは 50 です。

注: checkpoint ページネーションを使用してこの endpoint を初めて呼び出すときは、fromパラメーターを省略してください。さらに結果がある場合は、レスポンスに next の値が含まれます。これは以降の API 呼び出しで使用できます。レスポンスに next が含まれなくなった場合、残りのページはありません。

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>"
  }
]

承認

Authorization

string

header

必須

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

パスパラメータ

string

必須

関連付けられたユーザーの一覧を取得する role の ID。

クエリパラメータ

per_page

integer

1 ページあたりの結果数。デフォルトは 50 です。

必須範囲: 1 <= x <= 100

page

integer

返される結果のページ index。最初のページは 0 です。

必須範囲: x >= 0

include_totals

boolean

結果を、合計件数を含むオブジェクト内に返す（true）か、結果の配列を直接返す（false、デフォルト）かを指定します。

from

string

取得を開始する任意の ID。

take

integer

1 ページあたりの結果数。既定値は 50 です。

必須範囲: 1 <= x <= 100

レスポンス

ロールに割り当てられたユーザーの取得に成功しました。

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

string<email>

デフォルト:john.doe@gmail.com

このユーザーのメールアドレス。

name

string

このユーザーの名前。

picture

string

このユーザーのプロフィール画像の URL。

user_id

string

このユーザーの ID。