組織のメンバーを取得

組織メンバーを一覧表示します。 このエンドポイントは結果整合性の遅延の影響を受けます。新しいユーザーがレスポンスにすぐ含まれない場合や、削除されたユーザーがレスポンスからすぐ削除されない場合があります。

• fields パラメーターを使用すると、取得するメンバーの詳細を必要に応じて指定できます。fields を空のままにすると、すべてのフィールド（ロールを除く）が返されます。
• メンバーのロールはデフォルトでは返されません。一覧に含まれる各メンバーに割り当てられたロールを取得するには、fields=roles を使用します。このパラメーターを使用するには、トークンに read:organization_member_roles スコープを含める必要があります。

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

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

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

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

チェックポイントページネーションで検索するには、次のパラメーターを使用します。 - from: 選択を開始する位置を示す省略可能な id。 - take: from パラメーターを使用する場合に取得するエントリーの総数。デフォルトは 50 です。注: チェックポイントページネーションを使用してこのエンドポイントを初めて呼び出すときは、from パラメーターを省略してください。さらに結果がある場合は、レスポンスに next 値が含まれます。これは後続の API 呼び出しで使用できます。レスポンスに next が含まれなくなった場合は、残りのページがないことを示します。

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,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        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({
        token: "<token>",
    });
    await client.organizations.members.list("id", {
        from: "from",
        take: 1,
        fields: "fields",
        includeFields: true,
    });
}
main();

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

import requests

url = "https://{tenantDomain}/api/v2/organizations/{id}/members"

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/organizations/{id}/members",
  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/organizations/{id}/members")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/organizations/{id}/members")

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>",
    "roles": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "user_id": "<string>"
  }
]

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

組織の識別子。

Maximum string length: 50

クエリパラメータ

page · integer

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

必須範囲: 0 <= x <= 1000

per_page · integer

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

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

include_totals · boolean

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

from · string

選択を開始する位置を示す省略可能な id。

take · integer

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

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

fields · string

結果に含める、または結果から除外するフィールドのカンマ区切りリストです（include_fields に指定した値に基づきます）。すべてのフィールドを取得するには、空のままにします。

include_fields · boolean

指定したフィールドを含める（true）か、除外する（false）かを指定します。

レスポンス

200

application/json

メンバーを正常に取得しました。

Option 1 · object[]

Option 2 · object

Option 3 · object

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

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

name · string

このユーザーの名前。

picture · string

このユーザーの画像の URL。

roles · object[]

Show child attributes

user_id · string

このユーザーの ID。