ロールを取得 - Auth0 Docs

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.Roles.ListAsync(
            new ListRolesRequestParameters {
                NameFilter = "name_filter",
                Type = RoleTypeEnum.Tenant,
                OwnerId = "owner_id",
                From = "from",
                Take = 1
            }
        );
    }

}

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.ListRolesRequestParameters{
        PerPage: management.Int(
            1,
        ),
        Page: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        NameFilter: management.String(
            "name_filter",
        ),
    }
    mgmt.Roles.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListRolesRequestParameters;
import com.auth0.client.mgmt.types.RoleTypeEnum;

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

        client.roles().list(
            ListRolesRequestParameters
                .builder()
                .nameFilter("name_filter")
                .type(RoleTypeEnum.TENANT)
                .ownerId("owner_id")
                .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\Roles\Requests\ListRolesRequestParameters;
use Auth0\SDK\API\Management\Types\RoleTypeEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->roles->list(
    new ListRolesRequestParameters([
        'nameFilter' => 'name_filter',
        'type' => RoleTypeEnum::Tenant->value,
        'ownerId' => 'owner_id',
        'from' => 'from',
        'take' => 1,
    ]),
);

from auth0.management import ManagementClient

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

client.roles.list(
    name_filter="name_filter",
    type="tenant",
    owner_id="owner_id",
    from="from",
    take=1,
)

require "auth0"

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

client.roles.list(
  name_filter: "name_filter",
  type: "tenant",
  owner_id: "owner_id",
  from: "from",
  take: 1
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.roles.list({
        perPage: 1,
        page: 1,
        includeTotals: true,
        nameFilter: "name_filter",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.roles.list({
        perPage: 1,
        page: 1,
        includeTotals: true,
        nameFilter: "name_filter",
    });
}
main();

[
  {
    "description": "<string>",
    "id": "<string>",
    "name": "<string>",
    "owner_id": "<string>"
  }
]

GET

https://{tenantDomain}/api/v2

roles

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.Roles.ListAsync(
            new ListRolesRequestParameters {
                NameFilter = "name_filter",
                Type = RoleTypeEnum.Tenant,
                OwnerId = "owner_id",
                From = "from",
                Take = 1
            }
        );
    }

}

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.ListRolesRequestParameters{
        PerPage: management.Int(
            1,
        ),
        Page: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        NameFilter: management.String(
            "name_filter",
        ),
    }
    mgmt.Roles.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListRolesRequestParameters;
import com.auth0.client.mgmt.types.RoleTypeEnum;

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

        client.roles().list(
            ListRolesRequestParameters
                .builder()
                .nameFilter("name_filter")
                .type(RoleTypeEnum.TENANT)
                .ownerId("owner_id")
                .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\Roles\Requests\ListRolesRequestParameters;
use Auth0\SDK\API\Management\Types\RoleTypeEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->roles->list(
    new ListRolesRequestParameters([
        'nameFilter' => 'name_filter',
        'type' => RoleTypeEnum::Tenant->value,
        'ownerId' => 'owner_id',
        'from' => 'from',
        'take' => 1,
    ]),
);

from auth0.management import ManagementClient

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

client.roles.list(
    name_filter="name_filter",
    type="tenant",
    owner_id="owner_id",
    from="from",
    take=1,
)

require "auth0"

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

client.roles.list(
  name_filter: "name_filter",
  type: "tenant",
  owner_id: "owner_id",
  from: "from",
  take: 1
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.roles.list({
        perPage: 1,
        page: 1,
        includeTotals: true,
        nameFilter: "name_filter",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.roles.list({
        perPage: 1,
        page: 1,
        includeTotals: true,
        nameFilter: "name_filter",
    });
}
main();

[
  {
    "description": "<string>",
    "id": "<string>",
    "name": "<string>",
    "owner_id": "<string>"
  }
]

承認

Authorization

string

header

必須

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

クエリパラメータ

per_page

integer

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

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

page

integer

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

必須範囲: x >= 0

include_totals

boolean

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

name_filter

string

名前で絞り込むための任意のフィルター（大文字と小文字は区別されません）。

type

enum<string>

role のタイプで絞り込むための任意のフィルター。ロールのタイプ

利用可能なオプション:

tenant,

organization

owner_id

string

所有者 ID で organization レベルの roles をフィルタリングします。type が "organization" の場合は必須です。

Maximum string length: 50

from

string

選択を開始する任意の ID。

take

integer

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

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

レスポンス

Roles を正常に取得しました。

Option 1 · object[]
Option 2 · object
Option 3 · object

description

string

このロールの説明。

string

このロールの ID。

name

string

このロールの名前。

owner_id

string<organization-id>

organization ID など、このロールを所有するエンティティの ID。

Maximum string length: 50

type

enum<string>

ロールのタイプ

利用可能なオプション:

tenant,

organization