設定を更新

テナントの設定を更新します。

PATCH https://{tenantDomain}/api/v2/tenants/settings

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Tenants;

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.Tenants.Settings.UpdateAsync(
            new UpdateTenantSettingsRequestContent()
        );
    }

}

200

{
  "acr_values_supported": [
    "<string>"
  ],
  "allow_organization_name_in_authentication_api": false,
  "allowed_logout_urls": [
    "<string>"
  ],
  "authorization_response_iss_parameter_supported": false,
  "change_password": {
    "enabled": false,
    "html": ""
  },
  "client_id_metadata_document_supported": false,
  "country_codes": {
    "list": [
      "<string>"
    ]
  },
  "customize_mfa_in_postlogin_action": false,
  "default_audience": "",
  "default_directory": "",
  "default_redirection_uri": "<string>",
  "default_token_quota": {
    "clients": {
      "client_credentials": {
        "enforce": true,
        "per_day": 1073741824,
        "per_hour": 1073741824
      }
    },
    "organizations": {
      "client_credentials": {
        "enforce": true,
        "per_day": 1073741824,
        "per_hour": 1073741824
      }
    }
  },
  "device_flow": {
    "charset": "base20",
    "mask": "****-****"
  },
  "enable_ai_guide": true,
  "enabled_locales": [],
  "ephemeral_session_lifetime": 72,
  "error_page": {
    "html": "",
    "show_log_link": false,
    "url": "https://mycompany.org/error"
  },
  "flags": {
    "allow_changing_enable_sso": true,
    "allow_legacy_delegation_grant_types": true,
    "allow_legacy_ro_grant_types": true,
    "allow_legacy_tokeninfo_endpoint": true,
    "change_pwd_flow_v1": false,
    "custom_domains_provisioning": false,
    "dashboard_insights_view": true,
    "dashboard_log_streams_next": true,
    "disable_clickjack_protection_headers": true,
    "disable_fields_map_fix": true,
    "disable_impersonation": false,
    "disable_management_api_sms_obfuscation": true,
    "enable_adfs_waad_email_verification": true,
    "enable_apis_section": false,
    "enable_client_connections": true,
    "enable_dynamic_client_registration": false,
    "enable_idtoken_api2": true,
    "enable_legacy_profile": true,
    "enable_pipeline2": true,
    "enable_public_signup_user_exists_error": true,
    "enable_sso": true,
    "enforce_client_authentication_on_passwordless_start": true,
    "genai_trial": true,
    "improved_signup_bot_detection_in_classic": true,
    "mfa_show_factor_list_on_enrollment": true,
    "no_disclose_enterprise_connections": true,
    "remove_alg_from_jwks": true,
    "revoke_refresh_token_grant": true,
    "trust_azure_adfs_email_verified_connection_property": false
  },
  "friendly_name": "My Company",
  "guardian_mfa_page": {
    "enabled": false,
    "html": ""
  },
  "idle_ephemeral_session_lifetime": 24,
  "idle_session_lifetime": 72,
  "include_session_metadata_in_tenant_logs": false,
  "legacy_sandbox_version": "",
  "mtls": {
    "enable_endpoint_aliases": false
  },
  "oidc_logout": {
    "rp_logout_end_session_endpoint_discovery": true
  },
  "phone_consolidated_experience": true,
  "picture_url": "https://mycompany.org/logo.png",
  "pushed_authorization_requests_supported": false,
  "resource_parameter_profile": "audience",
  "sandbox_version": "22",
  "sandbox_versions_available": [
    "<string>"
  ],
  "security_headers": {
    "content_security_policy": {
      "enabled": true,
      "policies": [
        {
          "directives": {},
          "flags": [],
          "reporting": {
            "report_to_group": "<string>",
            "report_uri": "<string>"
          }
        }
      ],
      "reporting_infrastructure": {
        "report_to": {
          "endpoints": [
            {
              "url": "<string>"
            }
          ],
          "group": "<string>",
          "max_age": 123
        },
        "reporting_endpoints": {}
      }
    },
    "x_xss_protection": {
      "enabled": true,
      "mode": "block",
      "report_uri": "<string>"
    }
  },
  "session_cookie": {
    "mode": "persistent"
  },
  "session_lifetime": 168,
  "sessions": {
    "oidc_logout_prompt_enabled": true
  },
  "skip_non_verifiable_callback_uri_confirmation_prompt": true,
  "support_email": "[e-mail]",
  "support_url": "https://mycompany.org/support"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

acr_values_supported · string<acr>[] | null

サポートされる ACR 値

allow_organization_name_in_authentication_api · boolean | null · デフォルト: false

認証エンドポイントで ID の代わりに organization名 を受け入れるかどうか

allowed_logout_urls · string<url-with-placeholders>[]

Auth0 からログアウトした後のリダイレクト先として使用できる URL。

authorization_response_iss_parameter_supported · boolean | null · デフォルト: false

認可レスポンスで iss パラメーターをサポートします

change_password · object | null

Change Password ページのカスタマイズ。

Show child attributes

client_id_metadata_document_supported · boolean · デフォルト: false · EA

認可サーバーが client_id URL からクライアント メタデータを取得できるかどうか。

country_codes · object | null

identifier 入力のための電話の国番号設定。

Show child attributes

customize_mfa_in_postlogin_action · boolean | null · デフォルト: false

PostLogin Action で MFA の柔軟な認証要素を有効にするかどうか

default_audience · string · デフォルト: ""

API 認可のデフォルト audience。

default_directory · string · デフォルト: ""

/token エンドポイントでパスワードグラントに使用される接続名。サポート対象の接続タイプは次のとおりです: LDAP、AD、Database Connections、パスワードレス、Windows Azure Active Directory、ADFS。

default_redirection_uri · string<absolute-https-uri-or-empty>

既定の絶対リダイレクト URI。https である必要があります

default_token_quota · object | null · EA

クライアントおよび組織のトークン発行クォータを設定するための Token Quota 設定。個別のクライアントまたは organization の設定で上書きされない限り、すべてのクライアントおよび組織に適用されます。

Show child attributes

device_flow · object | null

デバイスフローの設定。

Show child attributes

dynamic_client_registration_security_mode · enum<string> · GA

Dynamic Client Registration 経由で作成されたクライアントに割り当てる third_party_security_mode を設定します。strict では enhanced security controls が適用されます。permissive は従来の動作を維持し、過去にサードパーティ クライアントの使用実績がある tenant でのみ利用できます。

利用可能なオプション: strict, permissive

enable_ai_guide · boolean

この tenant で Auth0 Guide（AI を活用した支援）が有効かどうか。

enabled_locales · enum<string>[]

ユーザー インターフェイスでサポートされるロケール

Minimum array length: 1

利用可能なオプション: am, ar, ar-EG, ar-SA, az, bg, bn, bs, ca-ES, cnr, cs, cy, da, de, el, en, en-CA, es, es-419, es-AR, es-MX, et, eu-ES, fa, fi, fr, fr-CA, fr-FR, gl-ES, gu, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, kn, ko, lt, lv, mk, ml, mn, mr, ms, my, nb, nl, nn, no, pa, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, so, sq, sr, sv, sw, ta, te, th, tl, tr, uk, ur, vi, zgh, zh-CN, zh-HK, zh-MO, zh-TW

ephemeral_session_lifetime · integer · デフォルト: 72

一時的な（永続化されない）セッションが有効なまま維持される時間数。

必須範囲: x >= 1

ephemeral_session_lifetime_in_minutes · integer

一時的な（永続化されない）セッションが有効なまま維持される分数。ephemeral_session_lifetime と同時には指定できません。

必須範囲: x >= 1

error_page · object | null

エラーページのカスタマイズ。

Show child attributes

flags · object

この tenant の動作を変更するためのフラグ。

Show child attributes

friendly_name · string · デフォルト: My Company

このテナントのフレンドリー名。

guardian_mfa_page · object | null

Guardian ページのカスタマイズ。

Show child attributes

idle_ephemeral_session_lifetime · integer · デフォルト: 24

ユーザーが再度ログインする必要が生じるまで、一時的な（永続化されない）セッションを非アクティブのままにできる時間数。

必須範囲: x >= 1

idle_ephemeral_session_lifetime_in_minutes · integer

ユーザーが再度ログインする必要が生じるまで、一時的な（永続化されない）セッションを非アクティブのままにできる分数。idle_ephemeral_session_lifetime と同時には指定できません。

必須範囲: x >= 1

idle_session_lifetime · integer · デフォルト: 72

ユーザーが再度ログインする必要が生じるまで、セッションを非アクティブのままにできる時間数。

必須範囲: x >= 1

idle_session_lifetime_in_minutes · integer

ユーザーが再度ログインする必要が生じるまで、セッションを非アクティブのままにできる分数。idle_session_lifetime と同時には指定できません。

必須範囲: x >= 1

include_session_metadata_in_tenant_logs · boolean · デフォルト: false · EA

特定のテナントログ（slo、oidc_backchannel_logout_failed、oidc_backchannel_logout_succeeded）にセッション メタデータが含まれるかどうか。

legacy_sandbox_version · string

拡張環境用に選択されたレガシー サンドボックス バージョン

Maximum string length: 8

mtls · object | null

mTLS の設定。

Show child attributes

oidc_logout · object

OIDC の RP-Initiated Logout に関する設定

Show child attributes

phone_consolidated_experience · boolean

この tenant で Phone Consolidated Experience が有効かどうか。

picture_url · string<absolute-uri-or-empty> · デフォルト: https://mycompany.org/logo.png

このテナントに表示するロゴの URL（推奨サイズ: 150x150）

pushed_authorization_requests_supported · boolean | null · デフォルト: false

プッシュ型認可リクエストの使用を有効にします

resource_parameter_profile · enum<string> · デフォルト: audience · GA

アクセス要求時に、保護対象リソース（つまり API）の識別情報を OAuth エンドポイントでどのように指定するかを決定するプロファイルです。audience（既定値）に設定すると、リソースサーバーの指定に audience パラメーターが使用されます。compatibility に設定すると、引き続き最初に audience パラメーターが確認されますが、それが指定されていない場合は、resource パラメーターを使用してリソースサーバーを指定できます。

利用可能なオプション: audience, compatibility

sandbox_version · string · デフォルト: 22

拡張環境用に選択された sandbox バージョン

Maximum string length: 8

security_headers · object | null

tenant のレスポンスに対するセキュリティヘッダーの設定。

Show child attributes

session_cookie · object | null

セッションCookieの設定

Show child attributes

session_lifetime · integer · デフォルト: 168

セッションが有効なまま維持される時間数。

必須範囲: x >= 1

session_lifetime_in_minutes · integer

セッションが有効なまま維持される分数。session_lifetime と同時には指定できません。

必須範囲: x >= 1

sessions · object | null

tenant のセッション関連設定

Show child attributes

skip_non_verifiable_callback_uri_confirmation_prompt · boolean | null

リダイレクト URI に検証不能なコールバック URI（たとえば、myapp:// のようなカスタム URI スキーマや localhost）が使用されている場合に、ログインフロー中に確認プロンプトを表示するかどうかを制御します。 true に設定すると、確認プロンプトは表示されません。悪意のあるアプリからの保護を強化するため、false に設定することを推奨します。 詳しくは https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation を参照してください。

support_email · string<email-or-empty> · デフォルト: [e-mail]

エンドユーザー向けサポートメールアドレス。

support_url · string<absolute-uri-or-empty> · デフォルト: https://mycompany.org/support

エンドユーザー向けサポート URL。

レスポンス

200

application/json

テナント設定を正常に更新しました。

acr_values_supported · string<acr>[] | null

サポートされる ACR 値

allow_organization_name_in_authentication_api · boolean · デフォルト: false

認証エンドポイントで ID の代わりに organization名 を受け入れるかどうか

allowed_logout_urls · string<url>[]

Auth0 からの Logout 後にリダイレクト先として有効な URL。

authorization_response_iss_parameter_supported · boolean | null · デフォルト: false

認可レスポンスでの iss パラメーターをサポートします

change_password · object | null

Change Password ページのカスタマイズ。

Show child attributes

client_id_metadata_document_supported · boolean · デフォルト: false · EA

認可サーバーが client_id URL からクライアントメタデータを取得できるかどうか。

country_codes · object

identifier 入力のための電話の国番号設定。

Show child attributes

customize_mfa_in_postlogin_action · boolean · デフォルト: false

PostLogin Action で MFA の柔軟な認証要素を有効にするかどうか

default_audience · string · デフォルト: ""

API 認可の既定の audience。

default_directory · string · デフォルト: ""

/token endpoint でパスワード グラントに使用される接続名。サポートされる接続タイプは次のとおりです: LDAP、AD、Database Connections、パスワードレス、Windows Azure Active Directory、ADFS。

default_redirection_uri · string

既定の絶対リダイレクト URI。https である必要があります

default_token_quota · object | null · EA

クライアントおよび組織のトークン発行クォータを設定するための Token Quota 設定。個別のクライアントまたは organization の設定で上書きされない限り、すべてのクライアントおよび組織に適用されます。

Show child attributes

device_flow · object | null

Device フローの設定

Show child attributes

dynamic_client_registration_security_mode · enum<string> · GA

Dynamic Client Registration 経由で作成されたクライアントに割り当てる third_party_security_mode を設定します。strict では enhanced security controls が適用されます。permissive は従来の動作を維持し、過去にサードパーティ クライアントの使用実績がある tenant でのみ利用できます。

利用可能なオプション: strict, permissive

enable_ai_guide · boolean

このテナントで Auth0 Guide（AI を活用した支援機能）が有効かどうか。

enabled_locales · enum<string>[]

ユーザー インターフェイスでサポートされるロケール。

利用可能なオプション: am, ar, ar-EG, ar-SA, az, bg, bn, bs, ca-ES, cnr, cs, cy, da, de, el, en, en-CA, es, es-419, es-AR, es-MX, et, eu-ES, fa, fi, fr, fr-CA, fr-FR, gl-ES, gu, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, kn, ko, lt, lv, mk, ml, mn, mr, ms, my, nb, nl, nn, no, pa, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, so, sq, sr, sv, sw, ta, te, th, tl, tr, uk, ur, vi, zgh, zh-CN, zh-HK, zh-MO, zh-TW

ephemeral_session_lifetime · number · デフォルト: 72

一時的な（永続化されない）セッションが有効な状態を維持する時間数。

必須範囲: x >= 1

error_page · object | null

エラーページのカスタマイズ。

Show child attributes

flags · object

この tenant の動作を変更するためのフラグ。

Show child attributes

friendly_name · string · デフォルト: My Company

この tenant の表示名。

guardian_mfa_page · object | null

Guardian ページのカスタマイズ。

Show child attributes

idle_ephemeral_session_lifetime · number · デフォルト: 24

ユーザーが再度ログインする必要が生じるまで、一時的な（永続化されない）セッションを非アクティブのままにできる時間数。

必須範囲: x >= 1

idle_session_lifetime · number · デフォルト: 72

ユーザーが再度ログインする必要が生じるまで、セッションを非アクティブのままにできる時間数。

include_session_metadata_in_tenant_logs · boolean · デフォルト: false · EA

特定のテナントログ（slo、oidc_backchannel_logout_failed、oidc_backchannel_logout_succeeded）にセッションメタデータが含まれるかどうか。

legacy_sandbox_version · string · デフォルト: ""

ルールおよび Hooks の拡張用に選択されたサンドボックス バージョン。

mtls · object | null

mTLS の設定。

Show child attributes

oidc_logout · object

OIDC の RP-Initiated Logout に関する設定

Show child attributes

phone_consolidated_experience · boolean

このテナントで Phone Consolidated Experience が有効かどうか。

picture_url · string<absolute-uri-or-empty> · デフォルト: https://mycompany.org/logo.png

この tenant に表示するロゴの URL（推奨サイズ: 150x150）

pushed_authorization_requests_supported · boolean · デフォルト: false

プッシュ型認可リクエストの使用を有効にします

resource_parameter_profile · enum<string> · デフォルト: audience · GA

アクセス要求時に、保護対象リソース（つまり API）の識別情報を OAuth エンドポイントでどのように指定するかを決定するプロファイルです。audience（既定値）に設定すると、リソースサーバーの指定に audience パラメーターが使用されます。compatibility に設定すると、引き続き最初に audience パラメーターが確認されますが、それが指定されていない場合は、resource パラメーターを使用してリソースサーバーを指定できます。

利用可能なオプション: audience, compatibility

sandbox_version · string · デフォルト: 22

拡張環境用に選択されたサンドボックス バージョン。

sandbox_versions_available · string[]

拡張環境で使用可能なサンドボックス バージョン。

security_headers · object | null

tenant のレスポンスに対するセキュリティヘッダーの設定。

Show child attributes

session_cookie · object | null

セッションCookieの設定

Show child attributes

session_lifetime · number · デフォルト: 168

セッションが有効な状態を維持する時間数。

sessions · object | null

tenant のセッション関連設定

Show child attributes

skip_non_verifiable_callback_uri_confirmation_prompt · boolean | null

リダイレクト URI に検証不能なコールバック URI（たとえば、myapp:// のようなカスタム URI スキーマや localhost）が使用されている場合に、ログインフロー中に確認プロンプトを表示するかどうかを制御します。 true に設定すると、確認プロンプトは表示されません。悪意のあるアプリからの保護を強化するため、この設定は false にすることを推奨します。 詳細については、https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation を参照してください。

support_email · string<email-or-empty> · デフォルト: [e-mail]

エンドユーザー向けサポートのメールアドレス。

support_url · string<absolute-uri-or-empty> · デフォルト: https://mycompany.org/support

エンドユーザー向けサポート URL。