import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.groups.list({
connection_id: "connection_id",
name: "name",
external_id: "external_id",
search: "search",
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.groups.list({
connection_id: "connection_id",
name: "name",
external_id: "external_id",
search: "search",
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.ListGroupsRequestParameters{
ConnectionID: management.String(
"connection_id",
),
Name: management.String(
"name",
),
ExternalID: management.String(
"external_id",
),
Search: management.String(
"search",
),
Fields: management.String(
"fields",
),
IncludeFields: management.Bool(
true,
),
IncludeTotals: management.Bool(
true,
),
From: management.String(
"from",
),
Take: management.Int(
1,
),
}
mgmt.Groups.List(
context.TODO(),
request,
)
}
# Ensure you're logged in: auth0 login
auth0 api get "groups" --query "connection_id=connection_id" --query "name=name" --query "external_id=external_id" --query "search=search" --query "fields=fields" --query "include_fields=true" --query "include_totals=true" --query "from=from" --query "take=1"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,
IncludeTotals = true,
From = "from",
Take = 1
}
);
}
}
package com.example.usage;
import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListGroupsRequestParameters;
public class Example {
public static void main(String[] args) {
ManagementApi client = ManagementApi
.builder()
.domain("{YOUR_DOMAIN}")
.token("<token>")
.build();
client.groups().list(
ListGroupsRequestParameters
.builder()
.connectionId("connection_id")
.name("name")
.externalId("external_id")
.search("search")
.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\Groups\Requests\ListGroupsRequestParameters;
$client = new ManagementClient(new ManagementClientOptions(
domain: '{YOUR_DOMAIN}',
token: '<token>',
));
$client->groups->list(
new ListGroupsRequestParameters([
'connectionId' => 'connection_id',
'name' => 'name',
'externalId' => 'external_id',
'search' => 'search',
'fields' => 'fields',
'includeFields' => true,
'includeTotals' => true,
'from' => 'from',
'take' => 1,
]),
);
from auth0.management import ManagementClient
client = ManagementClient(
domain="{YOUR_DOMAIN}",
token="<token>",
)
client.groups.list(
connection_id="connection_id",
name="name",
external_id="external_id",
search="search",
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.groups.list(
connection_id: "connection_id",
name: "name",
external_id: "external_id",
search: "search",
fields: "fields",
include_fields: true,
include_totals: true,
from: "from",
take: 1
)
curl --request GET \
--url https://{tenantDomain}/api/v2/groups \
--header 'Authorization: Bearer <token>'[
{
"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"
}
]すべてのグループを取得する
テナント内のすべてのグループを一覧表示します。
import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.groups.list({
connection_id: "connection_id",
name: "name",
external_id: "external_id",
search: "search",
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.groups.list({
connection_id: "connection_id",
name: "name",
external_id: "external_id",
search: "search",
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.ListGroupsRequestParameters{
ConnectionID: management.String(
"connection_id",
),
Name: management.String(
"name",
),
ExternalID: management.String(
"external_id",
),
Search: management.String(
"search",
),
Fields: management.String(
"fields",
),
IncludeFields: management.Bool(
true,
),
IncludeTotals: management.Bool(
true,
),
From: management.String(
"from",
),
Take: management.Int(
1,
),
}
mgmt.Groups.List(
context.TODO(),
request,
)
}
# Ensure you're logged in: auth0 login
auth0 api get "groups" --query "connection_id=connection_id" --query "name=name" --query "external_id=external_id" --query "search=search" --query "fields=fields" --query "include_fields=true" --query "include_totals=true" --query "from=from" --query "take=1"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,
IncludeTotals = true,
From = "from",
Take = 1
}
);
}
}
package com.example.usage;
import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListGroupsRequestParameters;
public class Example {
public static void main(String[] args) {
ManagementApi client = ManagementApi
.builder()
.domain("{YOUR_DOMAIN}")
.token("<token>")
.build();
client.groups().list(
ListGroupsRequestParameters
.builder()
.connectionId("connection_id")
.name("name")
.externalId("external_id")
.search("search")
.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\Groups\Requests\ListGroupsRequestParameters;
$client = new ManagementClient(new ManagementClientOptions(
domain: '{YOUR_DOMAIN}',
token: '<token>',
));
$client->groups->list(
new ListGroupsRequestParameters([
'connectionId' => 'connection_id',
'name' => 'name',
'externalId' => 'external_id',
'search' => 'search',
'fields' => 'fields',
'includeFields' => true,
'includeTotals' => true,
'from' => 'from',
'take' => 1,
]),
);
from auth0.management import ManagementClient
client = ManagementClient(
domain="{YOUR_DOMAIN}",
token="<token>",
)
client.groups.list(
connection_id="connection_id",
name="name",
external_id="external_id",
search="search",
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.groups.list(
connection_id: "connection_id",
name: "name",
external_id: "external_id",
search: "search",
fields: "fields",
include_fields: true,
include_totals: true,
from: "from",
take: 1
)
curl --request GET \
--url https://{tenantDomain}/api/v2/groups \
--header 'Authorization: Bearer <token>'[
{
"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"
}
]承認
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
クエリパラメータ
接続 ID でグループを絞り込みます。
名前でグループを絞り込みます。
1 - 128外部 ID でグループを絞り込みます。
256名前または外部 ID でグループを検索します。
1 - 256結果に含める、または除外する(include_fields に応じて)フィールドのカンマ区切りリストです。空の場合はすべてのフィールドを取得します。
256指定したフィールドを含める(true)か除外する(false)かを指定します。
返される結果のページインデックスです。最初のページは 0 です。オフセット方式のページ分割では、結果数が最大 1,000 件に制限されます。代わりにチェックポイント方式のページ分割(from と take)を使用してください。
x >= 01 ページあたりの結果数です。デフォルトは 50 です。オフセット方式のページ分割では、結果数が最大 1,000 件に制限されます。代わりにチェックポイント方式のページ分割(from と take)を使用してください。
1 <= x <= 100結果を総結果数を含むオブジェクト内に返す(true)か、結果の配列をそのまま返す(false、デフォルト)かを指定します。返される総結果数は最大 1,000 件です。
選択を開始する起点となる省略可能な ID。
1 ページあたりの結果数です。デフォルトは 50 です。
1 <= x <= 100レスポンス
グループを正常に取得しました。
- object[]
- object
グループのメタデータを表します。メンバー一覧は別のendpointで取得します。
グループの一意の識別子(サービスによって生成)。
18 - 26^grp_[1-9a-km-zA-HJ-NP-Z]{14,22}$グループ名。その接続内で一意である必要があります。1〜128文字の表示可能なASCII文字を含める必要があります。
1 - 128^[\x20-\x7E]+$グループの外部識別子。SCIM同期でよく使用されます。最大長は256文字です。
256このグループが属する接続の識別子(接続グループの場合)。
このグループが属するtenantの識別子。
3^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$グループが作成された日時を示すタイムスタンプ。
グループが最後に更新された日時を示すタイムスタンプ。