ID でリソースサーバーにパッチを適用

リソースサーバー ID で既存の API 設定を変更します。詳しくは、API Settings をご覧ください。

PATCH https://{tenantDomain}/api/v2/resource-servers/{id}

C#

C#

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()
        );
    }

}

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.

パスパラメータ

id · string · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

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 の場合は不可）。

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

アクセストークンの 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

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

token endpoint からこの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

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

authorization_details · any[] | null

authorization_policy · object | null · EA

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

Show child attributes

client_id · string<client-id>

このリソースサーバーにリンクされているクライアントのclient 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

アクセストークンの 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

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

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

token_lifetime_for_web · integer

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