Route des paramètres du locataire

Récupérer les paramètres du locataire. Vous pouvez également préciser une liste de champs à inclure ou à exclure.

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

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"
    tenants "github.com/auth0/go-auth0/management/management/tenants"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &tenants.GetTenantSettingsRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.Tenants.Settings.Get(
        context.TODO(),
        request,
    )
}

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,
  "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": "[e-mail]",
  "support_url": "https://mycompany.org/support"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de requête

fields · string

Liste de champs séparés par des virgules à inclure ou à exclure dans le résultat (selon la valeur fournie pour include_fields). Laissez vide pour récupérer tous les champs.

include_fields · boolean

Indique si les champs spécifiés doivent être inclus (true) ou exclus (false).

Réponse

200

application/json

Les paramètres du locataire ont été récupérés avec succès.

acr_values_supported · string<acr>[] | null

Valeurs ACR prises en charge

allow_organization_name_in_authentication_api · boolean · défaut: false

Indique s’il faut accepter un nom d’organisation au lieu d’un ID sur les points de terminaison d’authentification

allowed_logout_urls · string<url>[]

URL valides vers lesquelles rediriger après la déconnexion d’Auth0.

authorization_response_iss_parameter_supported · boolean | null · défaut: false

Prend en charge le paramètre iss dans les réponses d’autorisation

change_password · object

Personnalisation de la page changer le mot de passe.

Show child attributes

client_id_metadata_document_supported · boolean · défaut: false · EA

Indique si le serveur d’autorisation permet de récupérer les métadonnées de l’application à partir d’une URL client_id.

country_codes · object

Configuration du code de pays du téléphone pour la saisie de l’identifiant.

Show child attributes

customize_mfa_in_postlogin_action · boolean · défaut: false

Indique s’il faut activer des facteurs flexibles pour la MFA dans l’Action PostLogin

default_audience · string · défaut: ""

Audience par défaut pour l’autorisation de l’API.

default_directory · string · défaut: ""

Nom de la connexion utilisée pour les octrois par mot de passe au point de terminaison /token. Les types de connexion suivants sont pris en charge : LDAP, AD, connexions de base de données, Passwordless, Windows Azure Active Directory, ADFS.

default_redirection_uri · string

L’URI de redirection absolue par défaut doit utiliser HTTPS

default_token_quota · object · EA

Configuration du quota de jetons permettant de configurer les quotas d’émission de jetons pour les applications et les organisations. S’applique à toutes les applications et organisations, sauf remplacement dans les paramètres d’une application ou d’une organisation donnée.

Show child attributes

device_flow · object

Configuration du flux d’appareil

Show child attributes

dynamic_client_registration_security_mode · enum<string> · GA

Définit le third_party_security_mode attribué aux applications créées au moyen de l’Enregistrement dynamique des applications. strict applique des contrôles de sécurité renforcés. permissive préserve le comportement existant et n’est offert qu’aux locataires ayant déjà utilisé des applications tierces.

Options disponibles: strict, permissive

enable_ai_guide · boolean

Indique si Auth0 Guide (assistance alimentée par l’IA) est activé pour ce locataire.

enabled_locales · enum<string>[]

Paramètres régionaux pris en charge pour l’interface utilisateur.

Options disponibles: 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 · défaut: 72

Nombre d’heures pendant lesquelles une session éphémère (non persistante) reste valide.

Plage requise: x >= 1

error_page · object

Personnalisation de la page d’erreur.

Show child attributes

flags · object

Indicateurs utilisés pour modifier le comportement de ce locataire.

Show child attributes

friendly_name · string · défaut: My Company

Nom convivial de ce locataire.

guardian_mfa_page · object

Personnalisation de la page Guardian.

Show child attributes

idle_ephemeral_session_lifetime · number · défaut: 24

Nombre d’heures pendant lesquelles une session éphémère (non persistante) peut rester inactive avant que l’utilisateur doive se reconnecter.

Plage requise: x >= 1

idle_session_lifetime · number · défaut: 72

Nombre d’heures pendant lesquelles une session peut rester inactive avant que l’utilisateur doive se reconnecter.

legacy_sandbox_version · string · défaut: ""

Version du bac à sable sélectionnée pour l’extensibilité des Rules et des Hooks.

mtls · object

Configuration mTLS.

Show child attributes

oidc_logout · object

Paramètres liés à Logout initié par le RP OIDC

Show child attributes

phone_consolidated_experience · boolean

Indique si Phone Consolidated Experience est activé pour ce locataire.

picture_url · string<absolute-uri-or-empty> · défaut: https://mycompany.org/logo.png

URL du logo à afficher pour ce locataire (taille recommandée : 150 x 150)

pushed_authorization_requests_supported · boolean · défaut: false

Active l’utilisation des requêtes d’autorisation poussées

resource_parameter_profile · enum<string> · défaut: audience · GA

Profil qui détermine comment l’identité de la ressource protégée (c.-à-d. l’API) peut être spécifiée dans les points de terminaison OAuth lorsqu’un accès est demandé. Lorsque la valeur est audience (par défaut), le paramètre audience est utilisé pour spécifier le serveur de ressources. Lorsque la valeur est compatibility, le paramètre audience est quand même vérifié en premier, mais s’il n’est pas fourni, le paramètre resource peut être utilisé pour spécifier le serveur de ressources.

Options disponibles: audience, compatibility

sandbox_version · string · défaut: 22

Version du bac à sable sélectionnée pour l’environnement d’extensibilité.

sandbox_versions_available · string[]

Versions du bac à sable offertes pour l’environnement d’extensibilité.

session_cookie · object

Configuration du cookie de session

Show child attributes

session_lifetime · number · défaut: 168

Nombre d’heures pendant lesquelles une session reste valide.

sessions · object

Paramètres liés aux sessions pour le locataire

Show child attributes

skip_non_verifiable_callback_uri_confirmation_prompt · boolean | null

Détermine si une invite de confirmation s’affiche pendant les flux de connexion lorsque l’URI de redirection utilise des URI de callback non vérifiables (par exemple, un schéma d’URI personnalisé comme myapp:// ou localhost). Si ce paramètre est défini sur true, aucune invite de confirmation ne s’affichera. Nous recommandons de le définir sur false afin d’améliorer la protection contre les applications malveillantes. Consultez https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation pour en savoir plus.

support_email · string<email-or-empty> · défaut: [e-mail]

Adresse de courriel d’assistance de l’utilisateur final.

support_url · string<absolute-uri-or-empty> · défaut: https://mycompany.org/support

URL d’assistance pour les utilisateurs finaux.