メインコンテンツへスキップ
PATCH
https://{tenantDomain}/api/v2
/
tenants
/
settings
Go
package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &tenants.UpdateTenantSettingsRequestContent{}
    client.Tenants.Settings.Update(
        context.TODO(),
        request,
    )
}
{
  "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,
  "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>"
  ],
  "session_cookie": {
    "mode": "persistent"
  },
  "session_lifetime": 168,
  "sessions": {
    "oidc_logout_prompt_enabled": true
  },
  "skip_non_verifiable_callback_uri_confirmation_prompt": true,
  "support_email": "support@mycompany.org",
  "support_url": "https://mycompany.org/support"
}

承認

Authorization
string
header
必須

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

ボディ

acr_values_supported
string<acr>[] | null

サポートされる ACR 値

allow_organization_name_in_authentication_api
boolean | null
デフォルト:false

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

allowed_logout_urls
string<url-with-placeholders>[]

Auth0 からログアウトした後のリダイレクト先として有効な URL。

authorization_response_iss_parameter_supported
boolean | null
デフォルト:false

認可レスポンスで iss パラメーターをサポートするかどうか

change_password
object

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

client_id_metadata_document_supported
boolean
デフォルト:false
EA

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

country_codes
object

識別子入力用の電話番号の国コード設定。

customize_mfa_in_postlogin_action
boolean | null
デフォルト:false

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

default_audience
string
デフォルト:""

API 認可のデフォルトのオーディエンス。

default_directory
string
デフォルト:""

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

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

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

default_token_quota
object
EA

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

device_flow
object

デバイスフローの設定。

dynamic_client_registration_security_mode
enum<string>
GA

動的クライアント登録で作成されたクライアントに割り当てる third_party_security_mode を設定します。strict では強化されたセキュリティ制御が適用されます。permissive では従来の動作が維持され、過去にサードパーティクライアントを使用したことがあるテナントでのみ利用できます。

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

このテナントで 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
error_page
object

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

flags
object

このテナントの動作を変更するためのフラグ。

friendly_name
string
デフォルト:My Company

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

guardian_mfa_page
object

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

idle_ephemeral_session_lifetime
integer
デフォルト:24

ユーザーが再度ログインするまで、一時的な(永続化されない)セッションが非アクティブな状態を維持できる時間数。

必須範囲: x >= 1
idle_session_lifetime
integer
デフォルト:72

ユーザーが再度ログインするまで、セッションが非アクティブな状態を維持できる時間数。

必須範囲: x >= 1
legacy_sandbox_version
string

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

Maximum string length: 8
mtls
object

mTLS の設定。

oidc_logout
object

OIDC RP-initiated Logout に関連する設定

phone_consolidated_experience
boolean

このテナントで 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

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

利用可能なオプション:
audience,
compatibility
sandbox_version
string
デフォルト:22

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

Maximum string length: 8

セッションクッキーの設定

session_lifetime
integer
デフォルト:168

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

必須範囲: x >= 1
sessions
object

テナントのセッション関連設定

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>
デフォルト:support@mycompany.org

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

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

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

レスポンス

テナントの設定が正常に更新されました。

acr_values_supported
string<acr>[] | null

サポートされる ACR 値

allow_organization_name_in_authentication_api
boolean
デフォルト:false

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

allowed_logout_urls
string<url>[]

Auth0 からログアウトした後のリダイレクト先として有効な URL。

authorization_response_iss_parameter_supported
boolean | null
デフォルト:false

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

change_password
object

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

client_id_metadata_document_supported
boolean
デフォルト:false
EA

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

country_codes
object

識別子入力用の電話番号の国コード設定。

customize_mfa_in_postlogin_action
boolean
デフォルト:false

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

default_audience
string
デフォルト:""

API 認可の既定のオーディエンス。

default_directory
string
デフォルト:""

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

default_redirection_uri
string

デフォルトの絶対リダイレクト URI。https である必要があります

default_token_quota
object
EA

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

device_flow
object

デバイスフローの設定

dynamic_client_registration_security_mode
enum<string>
GA

動的クライアント登録で作成されたクライアントに割り当てる third_party_security_mode を設定します。strict では強化されたセキュリティ制御が適用されます。permissive では従来の動作が維持され、過去にサードパーティクライアントを使用したことがあるテナントでのみ利用できます。

利用可能なオプション:
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

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

flags
object

このテナントの動作を変更するためのフラグ。

friendly_name
string
デフォルト:My Company

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

guardian_mfa_page
object

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

idle_ephemeral_session_lifetime
number
デフォルト:24

ユーザーが再度ログインするまで、一時的な(永続化されない)セッションが非アクティブな状態を維持できる時間数。

必須範囲: x >= 1
idle_session_lifetime
number
デフォルト:72

ユーザーが再度ログインするまで、セッションが非アクティブな状態を維持できる時間数。

legacy_sandbox_version
string
デフォルト:""

Rules および Hooks の拡張機能で選択されているサンドボックスのバージョン。

mtls
object

mTLS の設定。

oidc_logout
object

OIDC RP-initiated Logout に関連する設定

phone_consolidated_experience
boolean

このテナントで Phone Consolidated Experience が有効になっているかどうか。

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

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

pushed_authorization_requests_supported
boolean
デフォルト:false

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

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

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

利用可能なオプション:
audience,
compatibility
sandbox_version
string
デフォルト:22

拡張機能環境で選択されているサンドボックスのバージョン。

sandbox_versions_available
string[]

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

セッションクッキーの設定

session_lifetime
number
デフォルト:168

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

sessions
object

テナントのセッション関連設定

skip_non_verifiable_callback_uri_confirmation_prompt
boolean | null

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

support_email
string<email-or-empty>
デフォルト:support@mycompany.org

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

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

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