リソースサーバーを作成

テナントに関連付けられた新しい API を作成します。なお、すべての新しい API は Auth0 に登録する必要があります。詳細については、APIs を参照してください。

POST 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.CreateResourceServerRequestContent{
        Identifier: "identifier",
    }
    client.ResourceServers.Create(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.resourceServers.create({
        identifier: "identifier",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.resourceServers.create({
        identifier: "identifier",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/resource-servers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "<string>",
  "allow_offline_access": true,
  "allow_online_access": true,
  "allow_online_access_with_ephemeral_sessions": true,
  "authorization_details": [
    "<unknown>"
  ],
  "authorization_policy": {
    "policy_id": "<string>"
  },
  "enforce_policies": 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": 1296000
}
'

import requests

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

payload = {
    "identifier": "<string>",
    "allow_offline_access": True,
    "allow_online_access": True,
    "allow_online_access_with_ephemeral_sessions": True,
    "authorization_details": ["<unknown>"],
    "authorization_policy": { "policy_id": "<string>" },
    "enforce_policies": 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-----
MIIBIjANBg...
-----END PUBLIC KEY-----
",
            "kid": "<string>",
            "name": "<string>"
        },
        "format": "compact-nested-jwe"
    },
    "token_lifetime": 1296000
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, 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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'identifier' => '<string>',
    'allow_offline_access' => true,
    'allow_online_access' => true,
    'allow_online_access_with_ephemeral_sessions' => true,
    'authorization_details' => [
        '<unknown>'
    ],
    'authorization_policy' => [
        'policy_id' => '<string>'
    ],
    'enforce_policies' => 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-----
MIIBIjANBg...
-----END PUBLIC KEY-----
',
                'kid' => '<string>',
                'name' => '<string>'
        ],
        'format' => 'compact-nested-jwe'
    ],
    'token_lifetime' => 1296000
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/resource-servers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"identifier\": \"<string>\",\n  \"allow_offline_access\": true,\n  \"allow_online_access\": true,\n  \"allow_online_access_with_ephemeral_sessions\": true,\n  \"authorization_details\": [\n    \"<unknown>\"\n  ],\n  \"authorization_policy\": {\n    \"policy_id\": \"<string>\"\n  },\n  \"enforce_policies\": true,\n  \"name\": \"<string>\",\n  \"proof_of_possession\": {\n    \"required\": true\n  },\n  \"scopes\": [\n    {\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"signing_alg\": \"HS256\",\n  \"signing_secret\": \"<string>\",\n  \"skip_consent_for_verifiable_first_party_clients\": true,\n  \"subject_type_authorization\": {\n    \"client\": {},\n    \"user\": {}\n  },\n  \"token_encryption\": {\n    \"encryption_key\": {\n      \"pem\": \"-----BEGIN PUBLIC KEY-----\\r\\nMIIBIjANBg...\\r\\n-----END PUBLIC KEY-----\\r\\n\",\n      \"kid\": \"<string>\",\n      \"name\": \"<string>\"\n    },\n    \"format\": \"compact-nested-jwe\"\n  },\n  \"token_lifetime\": 1296000\n}")
  .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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"identifier\": \"<string>\",\n  \"allow_offline_access\": true,\n  \"allow_online_access\": true,\n  \"allow_online_access_with_ephemeral_sessions\": true,\n  \"authorization_details\": [\n    \"<unknown>\"\n  ],\n  \"authorization_policy\": {\n    \"policy_id\": \"<string>\"\n  },\n  \"enforce_policies\": true,\n  \"name\": \"<string>\",\n  \"proof_of_possession\": {\n    \"required\": true\n  },\n  \"scopes\": [\n    {\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"signing_alg\": \"HS256\",\n  \"signing_secret\": \"<string>\",\n  \"skip_consent_for_verifiable_first_party_clients\": true,\n  \"subject_type_authorization\": {\n    \"client\": {},\n    \"user\": {}\n  },\n  \"token_encryption\": {\n    \"encryption_key\": {\n      \"pem\": \"-----BEGIN PUBLIC KEY-----\\r\\nMIIBIjANBg...\\r\\n-----END PUBLIC KEY-----\\r\\n\",\n      \"kid\": \"<string>\",\n      \"name\": \"<string>\"\n    },\n    \"format\": \"compact-nested-jwe\"\n  },\n  \"token_lifetime\": 1296000\n}"

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

201

{
  "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.

ボディ

application/jsonapplication/x-www-form-urlencoded

identifier · string · 必須

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

Required string length: 1 - 600

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

consent_policy · enum<string> | null

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

enforce_policies · boolean

認可ポリシーを適用するか（true）、無視するか（false）。

name · string

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

Maximum string length: 200

Pattern: ^[^<>]+$

proof_of_possession · object | null

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

Show child attributes

scopes · object[]

この API で使用する permissions（スコープ）の一覧。

Show child attributes

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

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

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

signing_secret · string

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

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 に対して発行されるアクセストークンの有効期限（秒単位）。

必須範囲: 0 <= x <= 2592000

レスポンス

201

application/json

リソースサーバーが正常に作成されました。

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 で使用する permissions（スコープ）の一覧。

Show child attributes

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

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

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

signing_secret · string

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

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 の値を超えることはできません。