ユーザーのグループを取得

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.groups.get("id", {
        fields: "fields",
        include_fields: true,
        include_totals: true,
        from: "from",
        take: 1,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.groups.get("id", {
        fields: "fields",
        include_fields: true,
        include_totals: true,
        from: "from",
        take: 1,
    });
}
main();

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.GetUserGroupsRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
    }
    mgmt.Users.Groups.Get(
        context.TODO(),
        "id",
        request,
    )
}

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

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.Users.Groups.GetAsync(
            id: "id",
            request: new GetUserGroupsRequestParameters {
                Fields = "fields",
                IncludeFields = true,
                IncludeTotals = true,
                From = "from",
                Take = 1
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.users.types.GetUserGroupsRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.users().groups().get(
            "id",
            GetUserGroupsRequestParameters
                .builder()
                .fields("fields")
                .includeFields(true)
                .includeTotals(true)
                .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\Users\Groups\Requests\GetUserGroupsRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->groups->get(
    'id',
    new GetUserGroupsRequestParameters([
        'fields' => 'fields',
        'includeFields' => true,
        'includeTotals' => true,
        'from' => 'from',
        'take' => 1,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.users.groups.get(
    id="id",
    fields="fields",
    include_fields=True,
    include_totals=True,
    from_="from",
    take=1,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.users.groups.get(
  id: "id",
  fields: "fields",
  include_fields: true,
  include_totals: true,
  from: "from",
  take: 1
)

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

GET

https://{tenantDomain}/api/v2

users

{id}

groups

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.groups.get("id", {
        fields: "fields",
        include_fields: true,
        include_totals: true,
        from: "from",
        take: 1,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.groups.get("id", {
        fields: "fields",
        include_fields: true,
        include_totals: true,
        from: "from",
        take: 1,
    });
}
main();

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.GetUserGroupsRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
    }
    mgmt.Users.Groups.Get(
        context.TODO(),
        "id",
        request,
    )
}

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

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.Users.Groups.GetAsync(
            id: "id",
            request: new GetUserGroupsRequestParameters {
                Fields = "fields",
                IncludeFields = true,
                IncludeTotals = true,
                From = "from",
                Take = 1
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.users.types.GetUserGroupsRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.users().groups().get(
            "id",
            GetUserGroupsRequestParameters
                .builder()
                .fields("fields")
                .includeFields(true)
                .includeTotals(true)
                .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\Users\Groups\Requests\GetUserGroupsRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->groups->get(
    'id',
    new GetUserGroupsRequestParameters([
        'fields' => 'fields',
        'includeFields' => true,
        'includeTotals' => true,
        'from' => 'from',
        'take' => 1,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.users.groups.get(
    id="id",
    fields="fields",
    include_fields=True,
    include_totals=True,
    from_="from",
    take=1,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.users.groups.get(
  id: "id",
  fields: "fields",
  include_fields: true,
  include_totals: true,
  from: "from",
  take: 1
)

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

承認

Authorization

string

header

必須

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

パスパラメータ

string

必須

グループを一覧表示するユーザーの ID。

クエリパラメータ

fields

string

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

Maximum string length: 256

include_fields

boolean

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

page

integer

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

レスポンス

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

object[]
object

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

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]+$

external_id

string

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

Maximum string length: 256

connection_id

string<connection-id>

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

tenant_name

string

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

Minimum string length: 3

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

created_at

string<date-time>

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

updated_at

string<date-time>

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

membership_created_at

string<date-time>

groupのメンバーシップが追加された日時。