組織メンバーを取得

organization のメンバーを一覧表示します。 この endpoint は結果整合性の影響を受けます。新しいユーザーがレスポンスにすぐ反映されない場合や、削除されたユーザーがレスポンスからすぐ削除されない場合があります。

• fields パラメーターを使用すると、取得するメンバーの詳細項目を任意で指定できます。fields を空のままにすると、すべてのフィールド（roles を除く）が返されます。
• メンバーの roles はデフォルトでは返されません。一覧に表示された各メンバーに割り当てられている roles を取得するには、fields=roles を使用します。このパラメーターを使用するには、トークンに read:organization_member_roles scope を含める必要があります。直接割り当てられた roles のみが返されます。グループベースの role 割り当ても含めるには、GET /api/v2/organizations/{id}/members/{user_id}/effective-roles を使用します。

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

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

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

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

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

GET https://{tenantDomain}/api/v2/organizations/{id}/members

C#

C#

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

}

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 · 必須

organization の識別子。

Maximum string length: 50

クエリパラメータ

page · integer

返す結果のページ index。最初のページは 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です。