リソースサーバーを取得

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

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.ResourceServers.ListAsync(
            new ListResourceServerRequestParameters {
                Identifiers = new List<string>(){
                    "identifiers",
                }
                ,
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                IncludeFields = true
            }
        );
    }

}

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.ListResourceServerRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    mgmt.ResourceServers.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListResourceServerRequestParameters;
import java.util.Arrays;

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

        client.resourceServers().list(
            ListResourceServerRequestParameters
                .builder()
                .identifiers(
                    Arrays.asList("identifiers")
                )
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .includeFields(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\ResourceServers\Requests\ListResourceServerRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->resourceServers->list(
    new ListResourceServerRequestParameters([
        'identifiers' => [
            'identifiers',
        ],
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'includeFields' => true,
    ]),
);

from auth0.management import ManagementClient

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

client.resource_servers.list(
    identifiers=[
        "identifiers"
    ],
    page=1,
    per_page=1,
    include_totals=True,
    include_fields=True,
)

require "auth0"

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

client.resource_servers.list(
  identifiers: ["identifiers"],
  page: 1,
  per_page: 1,
  include_totals: true,
  include_fields: true
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

[
  {
    "allow_offline_access": true,
    "allow_online_access": true,
    "allow_online_access_with_ephemeral_sessions": true,
    "authorization_details": [
      "<unknown>"
    ],
    "authorization_policy": {
      "policy_id": "<string>"
    },
    "client_id": "<string>",
    "enforce_policies": true,
    "id": "<string>",
    "identifier": "<string>",
    "is_system": true,
    "name": "<string>",
    "proof_of_possession": {
      "required": true
    },
    "scopes": [
      {
        "value": "<string>",
        "description": "<string>"
      }
    ],
    "signing_alg": "HS256",
    "signing_secret": "<string>",
    "skip_consent_for_verifiable_first_party_clients": true,
    "subject_type_authorization": {
      "client": {},
      "user": {}
    },
    "token_encryption": {
      "encryption_key": {
        "pem": "-----BEGIN PUBLIC KEY-----\r\nMIIBIjANBg...\r\n-----END PUBLIC KEY-----\r\n",
        "kid": "<string>",
        "name": "<string>"
      },
      "format": "compact-nested-jwe"
    },
    "token_lifetime": 123,
    "token_lifetime_for_web": 123
  }
]

GET

https://{tenantDomain}/api/v2

resource-servers

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

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.ResourceServers.ListAsync(
            new ListResourceServerRequestParameters {
                Identifiers = new List<string>(){
                    "identifiers",
                }
                ,
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                IncludeFields = true
            }
        );
    }

}

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.ListResourceServerRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    mgmt.ResourceServers.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListResourceServerRequestParameters;
import java.util.Arrays;

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

        client.resourceServers().list(
            ListResourceServerRequestParameters
                .builder()
                .identifiers(
                    Arrays.asList("identifiers")
                )
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .includeFields(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\ResourceServers\Requests\ListResourceServerRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->resourceServers->list(
    new ListResourceServerRequestParameters([
        'identifiers' => [
            'identifiers',
        ],
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'includeFields' => true,
    ]),
);

from auth0.management import ManagementClient

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

client.resource_servers.list(
    identifiers=[
        "identifiers"
    ],
    page=1,
    per_page=1,
    include_totals=True,
    include_fields=True,
)

require "auth0"

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

client.resource_servers.list(
  identifiers: ["identifiers"],
  page: 1,
  per_page: 1,
  include_totals: true,
  include_fields: true
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

[
  {
    "allow_offline_access": true,
    "allow_online_access": true,
    "allow_online_access_with_ephemeral_sessions": true,
    "authorization_details": [
      "<unknown>"
    ],
    "authorization_policy": {
      "policy_id": "<string>"
    },
    "client_id": "<string>",
    "enforce_policies": true,
    "id": "<string>",
    "identifier": "<string>",
    "is_system": true,
    "name": "<string>",
    "proof_of_possession": {
      "required": true
    },
    "scopes": [
      {
        "value": "<string>",
        "description": "<string>"
      }
    ],
    "signing_alg": "HS256",
    "signing_secret": "<string>",
    "skip_consent_for_verifiable_first_party_clients": true,
    "subject_type_authorization": {
      "client": {},
      "user": {}
    },
    "token_encryption": {
      "encryption_key": {
        "pem": "-----BEGIN PUBLIC KEY-----\r\nMIIBIjANBg...\r\n-----END PUBLIC KEY-----\r\n",
        "kid": "<string>",
        "name": "<string>"
      },
      "format": "compact-nested-jwe"
    },
    "token_lifetime": 123,
    "token_lifetime_for_web": 123
  }
]

承認

Authorization

string

header

必須

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

クエリパラメータ

identifiers

string[]

リソースサーバー identifier に対するオプションのフィルターです。URL エンコードする必要があり、複数回指定できます（最大 10 回）。
例: ../resource-servers?identifiers=id1&identifiers=id2

Minimum string length: 1

page

integer

返される結果のページ index。最初のページは 0 です。

必須範囲: x >= 0

per_page

integer

1 ページあたりの結果数。

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

include_totals

boolean

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

include_fields

boolean

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

レスポンス

リソースサーバーの取得に成功しました。

object[]
object

allow_offline_access

boolean

この API に対してリフレッシュトークンを発行できるかどうか（true/false）。

allow_online_access

boolean

この API に対して Online Refresh Tokens を発行できるかどうか（true/false）。

allow_online_access_with_ephemeral_sessions

boolean

session がエフェメラルに設定されている場合でも、この API に対して Online Refresh Tokens を発行できるかどうか（true/false）。

authorization_details

any[] | null

authorization_policy

object | null

リソースサーバーの認可ポリシー。

Show child attributes

client_id

string<client-id>

このリソースサーバーがリンクされているクライアントの client ID

利用可能なオプション:

transactional-authorization-with-mfa,

null

enforce_policies

boolean

認可ポリシーが適用される（true）か、適用されない（false）か。

string

API（リソースサーバー）の ID。

identifier

string

認可呼び出しで audience パラメーターとして使用される API の一意識別子。一度設定すると変更できません。

is_system

boolean

これが Auth0 システム API（true）か、カスタム API（false）か。

name

string

このリソースサーバーの表示名。< または > の文字は使用できません。

proof_of_possession

object | null

アクセストークンの Proof-of-Possession 設定

Show child attributes

scopes

object[]

この API で使用される permissions（scopes）の一覧。

Show child attributes

signing_alg

enum<string>

デフォルト:HS256

JWTの署名に使用するアルゴリズム。HS256（デフォルト）または RS256 を指定できます。PS256 は addon で利用できます。

利用可能なオプション:

HS256,

RS256,

RS512,

PS256

signing_secret

string

対称アルゴリズム（HS256）を使用する場合に、トークンの署名に使用する Secret。

Minimum string length: 16

ファーストパーティとしてフラグ付けされたアプリケーションについて、ユーザーの同意をスキップするかどうか（true/false）。

subject_type_authorization

object

リソースサーバーに対するアプリケーションのアクセス権限を定義します

Show child attributes

token_dialect

enum<string>

発行するアクセストークンのトークンダイアレクト。access_token は標準の Auth0 クレームを含む JWT、rfc9068_profile は IETF JWT Access Token Profile に準拠した JWT です。access_token_authz と rfc9068_profile_authz には、さらに RBAC の permissions クレームが含まれます。

利用可能なオプション:

access_token,

access_token_authz,

rfc9068_profile,

rfc9068_profile_authz

token_encryption

object | null

Show child attributes

token_lifetime

integer

トークンエンドポイントからこの API 向けに発行されるアクセストークンの有効期限（秒単位）。

token_lifetime_for_web

integer

Implicit またはハイブリッドフローを介してこの API 向けに発行されるアクセストークンの有効期限（秒単位）。token_lifetime の値を超えることはできません。