リソースサーバーの取得

テナントに関連付けられているすべての API の詳細を取得します。

GET https://{tenantDomain}/api/v2/resource-servers

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.ListResourceServerRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.ResourceServers.List(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        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({
        token: "<token>",
    });
    await client.resourceServers.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        includeFields: true,
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/resource-servers \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/resource-servers"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/resource-servers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/resource-servers")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/resource-servers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

[
  {
    "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
  }
]

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

クエリパラメータ

identifiers · string[]

リソースサーバーの識別子で絞り込むための任意のフィルターです。URL エンコードする必要があり、複数回指定できます（最大 10 回）。
例: ../resource-servers?identifiers=id1&identifiers=id2

Minimum string length: 1

page · integer

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

必須範囲: x >= 0

per_page · integer

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

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

include_totals · boolean

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

include_fields · boolean

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

レスポンス

200

application/json

リソースサーバーを正常に取得しました。

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

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

authorization_details · any[] | null

authorization_policy · object | null · EA

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

Show child attributes

client_id · string<client-id>

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

consent_policy · enum<string> | null

利用可能なオプション: transactional-authorization-with-mfa, null

enforce_policies · boolean

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

id · string

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

identifier · string

認可リクエストで audience パラメーターとして使用されるAPIの一意の識別子。設定後は変更できません。

is_system · boolean

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

name · string

このリソースサーバーのフレンドリ名。< または > の文字は使用できません。

proof_of_possession · object | null

アクセストークンの所有証明の設定

Show child attributes

scopes · object[]

このAPIで使用する権限（スコープ）のリスト。

Show child attributes

signing_alg · enum<string> · デフォルト: HS256

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

利用可能なオプション: HS256, RS256, RS512, PS256

signing_secret · string

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

Minimum string length: 16

skip_consent_for_verifiable_first_party_clients · boolean

ファーストパーティとしてフラグ付けされたアプリケーションについて、ユーザーの同意をスキップするかどうか（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 または Hybrid Flow を介してこのAPI向けに発行されるアクセストークンの有効期限（秒単位）。token_lifetime の値を超えることはできません。