リソースサーバーを更新する

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.ResourceServers.UpdateAsync(
            id: "id",
            request: new UpdateResourceServerRequestContent()
        );
    }

}

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.UpdateResourceServerRequestContent{}
    mgmt.ResourceServers.Update(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.UpdateResourceServerRequestContent;

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

        client.resourceServers().update(
            "id",
            UpdateResourceServerRequestContent
                .builder()
                .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\UpdateResourceServerRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->resourceServers->update(
    'id',
    new UpdateResourceServerRequestContent([]),
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.resourceServers.update("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.resourceServers.update("id", {});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/resource-servers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "scopes": [
    {
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "signing_alg": "HS256",
  "signing_secret": "<string>",
  "skip_consent_for_verifiable_first_party_clients": true,
  "allow_offline_access": true,
  "allow_online_access": true,
  "allow_online_access_with_ephemeral_sessions": true,
  "token_lifetime": 1296000,
  "token_lifetime_for_anonymous_access_tokens": 1339200,
  "enforce_policies": true,
  "access_token": {
    "claims_mapping": {
      "custom_claims": [
        {
          "name": "<string>",
          "expression": "<string>"
        }
      ]
    }
  },
  "token_encryption": {
    "format": "compact-nested-jwe",
    "encryption_key": {
      "pem": "-----BEGIN PUBLIC KEY-----\r\nMIIBIjANBg...\r\n-----END PUBLIC KEY-----\r\n",
      "name": "<string>",
      "kid": "<string>"
    }
  },
  "require_consent_non_repudiation": true,
  "authorization_details": [
    "<unknown>"
  ],
  "proof_of_possession": {
    "required": true
  },
  "subject_type_authorization": {
    "user": {},
    "client": {},
    "anonymous_user": {}
  },
  "authorization_policy": {
    "policy_id": "<string>"
  }
}
'

{
  "id": "<string>",
  "name": "<string>",
  "is_system": true,
  "identifier": "<string>",
  "scopes": [
    {
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "signing_alg": "HS256",
  "signing_secret": "<string>",
  "allow_offline_access": true,
  "allow_online_access": true,
  "allow_online_access_with_ephemeral_sessions": true,
  "skip_consent_for_verifiable_first_party_clients": true,
  "token_lifetime": 123,
  "token_lifetime_for_web": 123,
  "enforce_policies": true,
  "token_lifetime_for_anonymous_access_tokens": 123,
  "token_dialect": "access_token",
  "access_token": {
    "claims_mapping": {
      "custom_claims": [
        {
          "name": "<string>",
          "expression": "<string>"
        }
      ]
    }
  },
  "token_encryption": {
    "format": "compact-nested-jwe",
    "encryption_key": {
      "alg": "RSA-OAEP-256",
      "pem": "-----BEGIN PUBLIC KEY-----\r\nMIIBIjANBg...\r\n-----END PUBLIC KEY-----\r\n",
      "name": "<string>",
      "kid": "<string>"
    }
  },
  "consent_policy": "transactional-authorization-with-mfa",
  "require_consent_non_repudiation": true,
  "authorization_details": [
    "<unknown>"
  ],
  "proof_of_possession": {
    "mechanism": "mtls",
    "required": true,
    "required_for": "public_clients"
  },
  "subject_type_authorization": {
    "user": {
      "policy": "allow_all"
    },
    "client": {
      "policy": "deny_all"
    },
    "anonymous_user": {
      "policy": "deny_all"
    }
  },
  "authorization_policy": {
    "policy_id": "<string>"
  },
  "client_id": "<string>"
}

PATCH

https://{tenantDomain}/api/v2

resource-servers

{id}

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.ResourceServers.UpdateAsync(
            id: "id",
            request: new UpdateResourceServerRequestContent()
        );
    }

}

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.UpdateResourceServerRequestContent{}
    mgmt.ResourceServers.Update(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.UpdateResourceServerRequestContent;

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

        client.resourceServers().update(
            "id",
            UpdateResourceServerRequestContent
                .builder()
                .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\UpdateResourceServerRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->resourceServers->update(
    'id',
    new UpdateResourceServerRequestContent([]),
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.resourceServers.update("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.resourceServers.update("id", {});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/resource-servers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "scopes": [
    {
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "signing_alg": "HS256",
  "signing_secret": "<string>",
  "skip_consent_for_verifiable_first_party_clients": true,
  "allow_offline_access": true,
  "allow_online_access": true,
  "allow_online_access_with_ephemeral_sessions": true,
  "token_lifetime": 1296000,
  "token_lifetime_for_anonymous_access_tokens": 1339200,
  "enforce_policies": true,
  "access_token": {
    "claims_mapping": {
      "custom_claims": [
        {
          "name": "<string>",
          "expression": "<string>"
        }
      ]
    }
  },
  "token_encryption": {
    "format": "compact-nested-jwe",
    "encryption_key": {
      "pem": "-----BEGIN PUBLIC KEY-----\r\nMIIBIjANBg...\r\n-----END PUBLIC KEY-----\r\n",
      "name": "<string>",
      "kid": "<string>"
    }
  },
  "require_consent_non_repudiation": true,
  "authorization_details": [
    "<unknown>"
  ],
  "proof_of_possession": {
    "required": true
  },
  "subject_type_authorization": {
    "user": {},
    "client": {},
    "anonymous_user": {}
  },
  "authorization_policy": {
    "policy_id": "<string>"
  }
}
'

{
  "id": "<string>",
  "name": "<string>",
  "is_system": true,
  "identifier": "<string>",
  "scopes": [
    {
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "signing_alg": "HS256",
  "signing_secret": "<string>",
  "allow_offline_access": true,
  "allow_online_access": true,
  "allow_online_access_with_ephemeral_sessions": true,
  "skip_consent_for_verifiable_first_party_clients": true,
  "token_lifetime": 123,
  "token_lifetime_for_web": 123,
  "enforce_policies": true,
  "token_lifetime_for_anonymous_access_tokens": 123,
  "token_dialect": "access_token",
  "access_token": {
    "claims_mapping": {
      "custom_claims": [
        {
          "name": "<string>",
          "expression": "<string>"
        }
      ]
    }
  },
  "token_encryption": {
    "format": "compact-nested-jwe",
    "encryption_key": {
      "alg": "RSA-OAEP-256",
      "pem": "-----BEGIN PUBLIC KEY-----\r\nMIIBIjANBg...\r\n-----END PUBLIC KEY-----\r\n",
      "name": "<string>",
      "kid": "<string>"
    }
  },
  "consent_policy": "transactional-authorization-with-mfa",
  "require_consent_non_repudiation": true,
  "authorization_details": [
    "<unknown>"
  ],
  "proof_of_possession": {
    "mechanism": "mtls",
    "required": true,
    "required_for": "public_clients"
  },
  "subject_type_authorization": {
    "user": {
      "policy": "allow_all"
    },
    "client": {
      "policy": "deny_all"
    },
    "anonymous_user": {
      "policy": "deny_all"
    }
  },
  "authorization_policy": {
    "policy_id": "<string>"
  },
  "client_id": "<string>"
}

承認

Authorization

string

header

必須

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

パスパラメータ

string

必須

更新するリソースサーバーの ID または audience。

ボディ

name

string

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

Maximum string length: 200

Pattern: ^[^<>]+$

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 の場合はスキップしない）。

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 がエフェメラルに設定されている場合でも、Online Refresh Tokensを発行できるかどうか（true の場合は可、false の場合は不可）。

token_lifetime

integer

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

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

token_lifetime_for_anonymous_access_tokens

integer | null

この API で発行される匿名セッション用アクセストークンの有効期限（秒）。

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

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

enforce_policies

boolean

認可ポリシーを適用するかどうか（true の場合は適用、false の場合は未適用）。

access_token

object | null

アクセストークンのカスタム設定

Show child attributes

token_encryption

object | null

Show child attributes

利用可能なオプション:

transactional-authorization-with-mfa,

null

true の場合、リソースサーバーはすべての同意承認にデジタル署名を要求するため、承認者は後から自ら付与した同意を否認できません。false の場合、同意決定に署名は必要ありません。デフォルトは false です。関連するエンタイトルメントが無効化された後も、設定値は返されます。

authorization_details

any[] | null

proof_of_possession

object | null

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

Show child attributes

subject_type_authorization

object

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

Show child attributes

authorization_policy

object | null

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

Show child attributes

レスポンス

リソースサーバーの更新に成功しました。

string

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

name

string

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

is_system

boolean

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

identifier

string

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

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

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 がエフェメラルに設定されている場合でも、Online Refresh Tokensを発行できるかどうか（true の場合は可、false の場合は不可）。

token_lifetime

integer

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

token_lifetime_for_web

integer

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

enforce_policies

boolean

認可ポリシーを適用するかどうか（true の場合は適用、false の場合は未適用）。

token_lifetime_for_anonymous_access_tokens

integer

この API で発行される匿名セッション用アクセストークンの有効期限（秒）。

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

access_token

object | null

アクセストークンのカスタム設定

Show child attributes

token_encryption

object | null

Show child attributes

利用可能なオプション:

transactional-authorization-with-mfa,

null

true の場合、リソースサーバーではすべての同意承認にデジタル署名が必要となるため、承認者は後から自身が付与した同意を否認できなくなります。false の場合、同意決定に署名は必要ありません。デフォルトは false です。関連するエンタイトルメントが無効になった後も、設定された値が返されます。

authorization_details

any[] | null

proof_of_possession

object | null

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

Show child attributes

subject_type_authorization

object

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

Show child attributes

authorization_policy

object | null

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

Show child attributes

client_id

string<client-id>

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