グループを取得

テナント内のすべてのグループを一覧表示します。

GET https://{tenantDomain}/api/v2/groups

C#

C#

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

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.Groups.ListAsync(
            new ListGroupsRequestParameters {
                ConnectionId = "connection_id",
                Name = "name",
                ExternalId = "external_id",
                Search = "search",
                Fields = "fields",
                IncludeFields = true,
                From = "from",
                Take = 1
            }
        );
    }

}

200

[
  {
    "connection_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "external_id": "<string>",
    "id": "<string>",
    "name": "<string>",
    "tenant_name": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

クエリパラメータ

connection_id · string

接続 ID でグループを絞り込みます。

name · string

名前でグループを絞り込みます。

Required string length: 1 - 128

external_id · string

外部 ID でグループを絞り込みます。

Maximum string length: 256

search · string

名前または外部 ID でグループを検索します。

Required string length: 1 - 256

fields · string

結果に含める、または除外する（include_fields に応じて）フィールドのカンマ区切りリストです。空の場合はすべてのフィールドを取得します。

Maximum string length: 256

include_fields · boolean

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

page · integer

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

必須範囲: x >= 0

per_page · integer

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

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

include_totals · boolean

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

from · string

選択を開始する起点となる省略可能な ID。

take · integer

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

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

レスポンス

200

application/json

グループを正常に取得しました。

object[]

object

グループのメタデータを表します。メンバー一覧は別のendpointで取得します。

connection_id · string<connection-id>

このグループが属する接続の識別子（接続グループの場合）。

created_at · string<date-time>

グループが作成された日時を示すタイムスタンプ。

external_id · string

グループの外部識別子。SCIM同期でよく使用されます。最大長は256文字です。

Maximum string length: 256

id · string

グループの一意の識別子（サービスによって生成）。

Required string length: 18 - 26

Pattern: ^grp_[1-9a-km-zA-HJ-NP-Z]{14,22}$

name · string

グループ名。その接続内で一意である必要があります。1〜128文字の表示可能なASCII文字を含める必要があります。

Required string length: 1 - 128

Pattern: ^[\x20-\x7E]+$

tenant_name · string

このグループが属するtenantの識別子。

Minimum string length: 3

Pattern: ^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$

updated_at · string<date-time>

グループが最後に更新された日時を示すタイムスタンプ。