ロールに属するユーザーを取得

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

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

• オフセットページネーション
• チェックポイントページネーション

1000 を超える組織メンバーを取得する必要がある場合は、チェックポイントページネーションを使用する必要があります。

チェックポイントページネーション

チェックポイントページネーションを使用するには、次のパラメーターを使用します。

• from: 取得を開始する位置を示す省略可能な id。
• take: from パラメーターを使用する場合に取得するエントリーの総数。既定値は 50 です。

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

GET https://{tenantDomain}/api/v2/roles/{id}/users

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"
    roles "github.com/auth0/go-auth0/management/management/roles"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &roles.ListRoleUsersRequestParameters{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
    }
    client.Roles.Users.List(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

curl --request GET \
  --url https://{tenantDomain}/api/v2/roles/{id}/users \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/roles/{id}/users"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/roles/{id}/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/roles/{id}/users")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/roles/{id}/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

関連付けられているユーザーの一覧を取得するロールの ID。

クエリパラメータ

per_page · integer

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

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

page · integer

返される結果のページインデックス。最初のページは 0 です。

必須範囲: x >= 0

include_totals · boolean

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

from · string

取得を開始する位置を示す省略可能な id。

take · integer

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

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

レスポンス

200

application/json

ロールに関連付けられたユーザーを正常に取得しました。

Option 1 · object[]

Option 2 · object

Option 3 · object

email · string<email> · デフォルト: [e-mail]

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

name · string

このユーザーの名前。

picture · string

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

user_id · string

このユーザーのID。