Obtenir les paramètres du tenant

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.GetAsync(
            new GetTenantSettingsRequestParameters {
                Fields = "fields",
                IncludeFields = true
            }
        );
    }

}

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.GetTenantSettingsRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    mgmt.Tenants.Settings.Get(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.tenants.types.GetTenantSettingsRequestParameters;

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

        client.tenants().settings().get(
            GetTenantSettingsRequestParameters
                .builder()
                .fields("fields")
                .includeFields(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Tenants\Settings\Requests\GetTenantSettingsRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->tenants->settings->get(
    new GetTenantSettingsRequestParameters([
        'fields' => 'fields',
        'includeFields' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.tenants.settings.get(
    fields="fields",
    include_fields=True,
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.tenants.settings.get({
        fields: "fields",
        includeFields: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.tenants.settings.get({
        fields: "fields",
        includeFields: true,
    });
}
main();

{
  "change_password": {
    "enabled": false,
    "html": ""
  },
  "guardian_mfa_page": {
    "enabled": false,
    "html": ""
  },
  "default_audience": "",
  "default_directory": "",
  "error_page": {
    "html": "",
    "show_log_link": false,
    "url": "https://mycompany.org/error"
  },
  "device_flow": {
    "charset": "base20",
    "mask": "****-****"
  },
  "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
      }
    }
  },
  "flags": {
    "change_pwd_flow_v1": false,
    "enable_apis_section": false,
    "disable_impersonation": false,
    "enable_client_connections": true,
    "enable_pipeline2": true,
    "allow_legacy_delegation_grant_types": true,
    "allow_legacy_ro_grant_types": true,
    "allow_legacy_tokeninfo_endpoint": true,
    "enable_legacy_profile": true,
    "enable_idtoken_api2": true,
    "enable_public_signup_user_exists_error": true,
    "enable_sso": true,
    "allow_changing_enable_sso": true,
    "disable_clickjack_protection_headers": true,
    "no_disclose_enterprise_connections": true,
    "enforce_client_authentication_on_passwordless_start": true,
    "enable_adfs_waad_email_verification": true,
    "revoke_refresh_token_grant": true,
    "dashboard_log_streams_next": true,
    "dashboard_insights_view": true,
    "disable_fields_map_fix": true,
    "mfa_show_factor_list_on_enrollment": true,
    "remove_alg_from_jwks": true,
    "improved_signup_bot_detection_in_classic": true,
    "genai_trial": true,
    "local_resource_discovery": true,
    "enable_dynamic_client_registration": false,
    "disable_management_api_sms_obfuscation": true,
    "trust_azure_adfs_email_verified_connection_property": false,
    "custom_domains_provisioning": false
  },
  "friendly_name": "My Company",
  "picture_url": "https://mycompany.org/logo.png",
  "support_email": "support@mycompany.org",
  "support_url": "https://mycompany.org/support",
  "allowed_logout_urls": [
    "<string>"
  ],
  "session_lifetime": 168,
  "idle_session_lifetime": 72,
  "ephemeral_session_lifetime": 72,
  "idle_ephemeral_session_lifetime": 24,
  "sandbox_version": "22",
  "legacy_sandbox_version": "",
  "sandbox_versions_available": [
    "<string>"
  ],
  "default_redirection_uri": "<string>",
  "enabled_locales": [
    "am"
  ],
  "access_token": {
    "claims_mapping": {
      "custom_claims": [
        {
          "name": "<string>",
          "expression": "<string>"
        }
      ]
    }
  },
  "security_headers": {
    "content_security_policy": {
      "enabled": true,
      "policies": [
        {
          "mode": "enforcing",
          "directives": {},
          "flags": [
            "upgrade-insecure-requests"
          ],
          "reporting": {
            "report_uri": "<string>",
            "report_to_group": "<string>"
          }
        }
      ],
      "reporting_infrastructure": {
        "report_to": {
          "group": "<string>",
          "max_age": 123,
          "endpoints": [
            {
              "url": "<string>"
            }
          ]
        },
        "reporting_endpoints": {}
      }
    },
    "x_xss_protection": {
      "enabled": true,
      "mode": "block",
      "report_uri": "<string>"
    }
  },
  "session_cookie": {
    "mode": "persistent"
  },
  "sessions": {
    "oidc_logout_prompt_enabled": true,
    "anonymous": {
      "lifetime_in_minutes": 43200,
      "activate_cookie": true
    }
  },
  "oidc_logout": {
    "rp_logout_end_session_endpoint_discovery": true
  },
  "allow_organization_name_in_authentication_api": false,
  "customize_mfa_in_postlogin_action": false,
  "acr_values_supported": [
    "<string>"
  ],
  "mtls": {
    "enable_endpoint_aliases": false
  },
  "pushed_authorization_requests_supported": false,
  "authorization_response_iss_parameter_supported": false,
  "dpop_strict_refresh_token_binding": false,
  "skip_non_verifiable_callback_uri_confirmation_prompt": true,
  "resource_parameter_profile": "audience",
  "client_id_metadata_document_supported": false,
  "phone_consolidated_experience": true,
  "enable_ai_guide": true,
  "include_session_metadata_in_tenant_logs": false,
  "dynamic_client_registration_security_mode": "strict",
  "country_codes": {
    "list": [
      "<string>"
    ],
    "mode": "allow"
  }
}

GET

https://{tenantDomain}/api/v2

tenants

settings

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.GetAsync(
            new GetTenantSettingsRequestParameters {
                Fields = "fields",
                IncludeFields = true
            }
        );
    }

}

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.GetTenantSettingsRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    mgmt.Tenants.Settings.Get(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.tenants.types.GetTenantSettingsRequestParameters;

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

        client.tenants().settings().get(
            GetTenantSettingsRequestParameters
                .builder()
                .fields("fields")
                .includeFields(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Tenants\Settings\Requests\GetTenantSettingsRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->tenants->settings->get(
    new GetTenantSettingsRequestParameters([
        'fields' => 'fields',
        'includeFields' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.tenants.settings.get(
    fields="fields",
    include_fields=True,
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.tenants.settings.get({
        fields: "fields",
        includeFields: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.tenants.settings.get({
        fields: "fields",
        includeFields: true,
    });
}
main();

{
  "change_password": {
    "enabled": false,
    "html": ""
  },
  "guardian_mfa_page": {
    "enabled": false,
    "html": ""
  },
  "default_audience": "",
  "default_directory": "",
  "error_page": {
    "html": "",
    "show_log_link": false,
    "url": "https://mycompany.org/error"
  },
  "device_flow": {
    "charset": "base20",
    "mask": "****-****"
  },
  "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
      }
    }
  },
  "flags": {
    "change_pwd_flow_v1": false,
    "enable_apis_section": false,
    "disable_impersonation": false,
    "enable_client_connections": true,
    "enable_pipeline2": true,
    "allow_legacy_delegation_grant_types": true,
    "allow_legacy_ro_grant_types": true,
    "allow_legacy_tokeninfo_endpoint": true,
    "enable_legacy_profile": true,
    "enable_idtoken_api2": true,
    "enable_public_signup_user_exists_error": true,
    "enable_sso": true,
    "allow_changing_enable_sso": true,
    "disable_clickjack_protection_headers": true,
    "no_disclose_enterprise_connections": true,
    "enforce_client_authentication_on_passwordless_start": true,
    "enable_adfs_waad_email_verification": true,
    "revoke_refresh_token_grant": true,
    "dashboard_log_streams_next": true,
    "dashboard_insights_view": true,
    "disable_fields_map_fix": true,
    "mfa_show_factor_list_on_enrollment": true,
    "remove_alg_from_jwks": true,
    "improved_signup_bot_detection_in_classic": true,
    "genai_trial": true,
    "local_resource_discovery": true,
    "enable_dynamic_client_registration": false,
    "disable_management_api_sms_obfuscation": true,
    "trust_azure_adfs_email_verified_connection_property": false,
    "custom_domains_provisioning": false
  },
  "friendly_name": "My Company",
  "picture_url": "https://mycompany.org/logo.png",
  "support_email": "support@mycompany.org",
  "support_url": "https://mycompany.org/support",
  "allowed_logout_urls": [
    "<string>"
  ],
  "session_lifetime": 168,
  "idle_session_lifetime": 72,
  "ephemeral_session_lifetime": 72,
  "idle_ephemeral_session_lifetime": 24,
  "sandbox_version": "22",
  "legacy_sandbox_version": "",
  "sandbox_versions_available": [
    "<string>"
  ],
  "default_redirection_uri": "<string>",
  "enabled_locales": [
    "am"
  ],
  "access_token": {
    "claims_mapping": {
      "custom_claims": [
        {
          "name": "<string>",
          "expression": "<string>"
        }
      ]
    }
  },
  "security_headers": {
    "content_security_policy": {
      "enabled": true,
      "policies": [
        {
          "mode": "enforcing",
          "directives": {},
          "flags": [
            "upgrade-insecure-requests"
          ],
          "reporting": {
            "report_uri": "<string>",
            "report_to_group": "<string>"
          }
        }
      ],
      "reporting_infrastructure": {
        "report_to": {
          "group": "<string>",
          "max_age": 123,
          "endpoints": [
            {
              "url": "<string>"
            }
          ]
        },
        "reporting_endpoints": {}
      }
    },
    "x_xss_protection": {
      "enabled": true,
      "mode": "block",
      "report_uri": "<string>"
    }
  },
  "session_cookie": {
    "mode": "persistent"
  },
  "sessions": {
    "oidc_logout_prompt_enabled": true,
    "anonymous": {
      "lifetime_in_minutes": 43200,
      "activate_cookie": true
    }
  },
  "oidc_logout": {
    "rp_logout_end_session_endpoint_discovery": true
  },
  "allow_organization_name_in_authentication_api": false,
  "customize_mfa_in_postlogin_action": false,
  "acr_values_supported": [
    "<string>"
  ],
  "mtls": {
    "enable_endpoint_aliases": false
  },
  "pushed_authorization_requests_supported": false,
  "authorization_response_iss_parameter_supported": false,
  "dpop_strict_refresh_token_binding": false,
  "skip_non_verifiable_callback_uri_confirmation_prompt": true,
  "resource_parameter_profile": "audience",
  "client_id_metadata_document_supported": false,
  "phone_consolidated_experience": true,
  "enable_ai_guide": true,
  "include_session_metadata_in_tenant_logs": false,
  "dynamic_client_registration_security_mode": "strict",
  "country_codes": {
    "list": [
      "<string>"
    ],
    "mode": "allow"
  }
}

Autorisations

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 précisés doivent être inclus (true) ou exclus (false).

Réponse

Paramètres du tenant récupérés avec succès.

change_password

object | null

Personnalisation de la page Change Password.

Show child attributes

guardian_mfa_page

object | null

Personnalisation de la page Guardian.

Show child attributes

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 grants par mot de passe au endpoint /token. Les types de connexion suivants sont pris en charge : LDAP, AD, Database Connections, Passwordless, Windows Azure Active Directory, ADFS.

error_page

object | null

Personnalisation de la page d’Error.

Show child attributes

device_flow

object | null

Configuration du flux d’appareil

Show child attributes

default_token_quota

object | null

Configuration du quota de jetons, pour configurer les quotas d’émission de jetons pour les clients et les organisations. S’applique à tous les clients et à toutes les organisations, sauf si un remplacement est défini dans les paramètres de chaque client ou organisation.

Show child attributes

flags

object

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

Show child attributes

friendly_name

string

défaut:My Company

Nom convivial de ce tenant.

picture_url

string<absolute-uri-or-empty>

défaut:https://mycompany.org/logo.png

URL du logo à afficher pour ce tenant (taille recommandée : 150x150)

support_email

string<email-or-empty>

défaut:support@mycompany.org

Adresse courriel de soutien pour l’utilisateur final.

support_url

string<absolute-uri-or-empty>

défaut:https://mycompany.org/support

URL de soutien pour l’utilisateur final.

allowed_logout_urls

string<url>[]

URL valides de redirection après le logout d’Auth0.

session_lifetime

number

défaut:168

Nombre d’heures pendant lesquelles une session reste valide.

idle_session_lifetime

number

défaut:72

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

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

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 connecter de nouveau.

Plage requise: x >= 1

sandbox_version

string

défaut:22

Version de sandbox sélectionnée pour l’environnement d’extensibilité.

legacy_sandbox_version

string

défaut:""

Version de sandbox sélectionnée pour l’extensibilité des rules et des hooks.

sandbox_versions_available

string[]

Versions de sandbox disponibles pour l’environnement d’extensibilité.

default_redirection_uri

string

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

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

access_token

object | null

Configuration personnalisée des jetons d'accès

Show child attributes

security_headers

object | null

Configuration des en-têtes de sécurité pour les réponses du tenant.

Show child attributes

Configuration du cookie de session

Show child attributes

sessions

object | null

Paramètres relatifs aux sessions pour le tenant

Show child attributes

oidc_logout

object

Paramètres liés à la déconnexion RP initiée par OIDC

Show child attributes

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 endpoints d’authentification

customize_mfa_in_postlogin_action

boolean

défaut:false

Indique s’il faut activer les facteurs flexibles pour l’AMF dans l’action PostLogin

acr_values_supported

string<acr>[] | null

Valeurs ACR prises en charge

mtls

object | null

Configuration mTLS.

Show child attributes

pushed_authorization_requests_supported

boolean

défaut:false

Active l’utilisation des Pushed Authorization Requests

authorization_response_iss_parameter_supported

boolean | null

défaut:false

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

dpop_strict_refresh_token_binding

boolean | null

défaut:false

Active la liaison stricte des jetons d’actualisation DPoP conformément à la RFC 9449 : tous les jetons d’actualisation émis pour les clients publics qui présentent une preuve DPoP sont liés à la clé de l’expéditeur, et cette liaison est validée à chaque échange ultérieur. Lorsque cette option est désactivée, la liaison des jetons d’actualisation DPoP peut tout de même s’appliquer à certains publics pour assurer la rétrocompatibilité.

skip_non_verifiable_callback_uri_confirmation_prompt

boolean | null

Détermine si un prompt de confirmation s’affiche pendant les login flows lorsque l’URI de redirection utilise des URI de rappel non vérifiables (par exemple, un schéma d’URI personnalisé comme myapp:// ou localhost). Si cette valeur est définie sur true, aucun prompt de confirmation ne s’affichera. Nous recommandons de la 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.

resource_parameter_profile

enum<string>

défaut:audience

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é. Lorsqu’il est défini à audience (par défaut), le paramètre audience est utilisé pour spécifier le resource server. Lorsqu’il est défini à 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 alors être utilisé pour spécifier le resource server.

Options disponibles:

audience,

compatibility

client_id_metadata_document_supported

boolean

défaut:false

Indique si le serveur d’autorisation prend en charge la récupération des métadonnées du client à partir d’une URL client_id.

phone_consolidated_experience

boolean

Indique si Phone Consolidated Experience est activée pour ce tenant.

enable_ai_guide

boolean

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

include_session_metadata_in_tenant_logs

boolean

défaut:false

Indique si les métadonnées de session sont incluses dans certains journaux du tenant (slo, oidc_backchannel_logout_failed, oidc_backchannel_logout_succeeded).

dynamic_client_registration_security_mode

enum<string>

Définit le third_party_security_mode attribué aux clients créés au moyen de Dynamic Client Registration. strict applique des contrôles de sécurité renforcés. permissive conserve le comportement préexistant et n’est offert qu’aux tenants ayant déjà utilisé des clients tiers.

Options disponibles:

strict,

permissive

country_codes

object

Configuration de l’indicatif régional pour la saisie de l’identifiant.

Show child attributes