SiteAuthSettings Classe

Paramètres de configuration pour la fonctionnalité d’authentification/autorisation Azure App Service.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

Héritage

azure.mgmt.web.v2021_03_01.models._models_py3.ProxyOnlyResource

SiteAuthSettings

Constructeur

SiteAuthSettings(*, kind: str | None = None, enabled: bool | None = None, runtime_version: str | None = None, unauthenticated_client_action: str | _models.UnauthenticatedClientAction | None = None, token_store_enabled: bool | None = None, allowed_external_redirect_urls: List[str] | None = None, default_provider: str | _models.BuiltInAuthenticationProvider | None = None, token_refresh_extension_hours: float | None = None, client_id: str | None = None, client_secret: str | None = None, client_secret_setting_name: str | None = None, client_secret_certificate_thumbprint: str | None = None, issuer: str | None = None, validate_issuer: bool | None = None, allowed_audiences: List[str] | None = None, additional_login_params: List[str] | None = None, aad_claims_authorization: str | None = None, google_client_id: str | None = None, google_client_secret: str | None = None, google_client_secret_setting_name: str | None = None, google_o_auth_scopes: List[str] | None = None, facebook_app_id: str | None = None, facebook_app_secret: str | None = None, facebook_app_secret_setting_name: str | None = None, facebook_o_auth_scopes: List[str] | None = None, git_hub_client_id: str | None = None, git_hub_client_secret: str | None = None, git_hub_client_secret_setting_name: str | None = None, git_hub_o_auth_scopes: List[str] | None = None, twitter_consumer_key: str | None = None, twitter_consumer_secret: str | None = None, twitter_consumer_secret_setting_name: str | None = None, microsoft_account_client_id: str | None = None, microsoft_account_client_secret: str | None = None, microsoft_account_client_secret_setting_name: str | None = None, microsoft_account_o_auth_scopes: List[str] | None = None, is_auth_from_file: str | None = None, auth_file_path: str | None = None, config_version: str | None = None, **kwargs: Any)

Paramètres de mot clé uniquement

Nom	Description
kind	str Type de ressource.
enabled	bool <code>true</code> si la fonctionnalité Authentification/Autorisation est activée pour l’application actuelle ; sinon, <code>false</code>.
runtime_version	str RuntimeVersion de la fonctionnalité d’authentification/autorisation en cours d’utilisation pour l’application actuelle. Le paramètre de cette valeur peut contrôler le comportement de certaines fonctionnalités dans le module Authentification/Autorisation.
unauthenticated_client_action	str ou UnauthenticatedClientAction Action à entreprendre lorsqu’un client non authentifié tente d’accéder à l’application. Les valeurs connues sont : « RedirectToLoginPage » et « AllowAnonymous ».
token_store_enabled	bool <code>true</code> pour stocker durablement les jetons de sécurité spécifiques à la plateforme qui sont obtenus pendant les flux de connexion ; sinon, <code>false</code>. Par défaut, il s’agit de <code>false</code>.
allowed_external_redirect_urls	list[str] URL externes vers qui peuvent être redirigées dans le cadre de la connexion ou de la déconnexion de l’application. Notez que la partie chaîne de requête de l’URL est ignorée. Il s’agit d’un paramètre avancé généralement requis uniquement par les back-ends d’applications du Windows Store. Notez que les URL du domaine actuel sont toujours implicitement autorisées.
default_provider	str ou BuiltInAuthenticationProvider Fournisseur d’authentification par défaut à utiliser lorsque plusieurs fournisseurs sont configurés. Ce paramètre n’est nécessaire que si plusieurs fournisseurs sont configurés et que l’action cliente non authentifiée est définie sur « RedirectToLoginPage ». Les valeurs connues sont : « AzureActiveDirectory », « Facebook », « Google », « MicrosoftAccount », « Twitter » et « Github ».
token_refresh_extension_hours	float Nombre d’heures après l’expiration du jeton de session qu’un jeton de session peut être utilisé pour appeler l’API d’actualisation du jeton. La valeur par défaut est 72 heures.
client_id	str ID client de cette application de partie de confiance, appelé client_id. Ce paramètre est requis pour activer l’authentification de connexion OpenID avec Azure Active Directory ou d’autres fournisseurs OpenID Connect tiers. Plus d’informations sur OpenID Connect : http://openid.net/specs/openid-connect-core-1_0.html.
client_secret	str Clé secrète client de cette application de partie de confiance (dans Azure Active Directory, elle est également appelée clé). Ce paramètre est facultatif. Si aucune clé secrète client n’est configurée, le flux d’authentification implicite OpenID Connect est utilisé pour authentifier les utilisateurs finaux. Sinon, le flux de code d’autorisation OpenID Connect est utilisé pour authentifier les utilisateurs finaux. Plus d’informations sur OpenID Connect : http://openid.net/specs/openid-connect-core-1_0.html.
client_secret_setting_name	str Nom du paramètre d’application qui contient la clé secrète client de l’application de la partie de confiance.
client_secret_certificate_thumbprint	str Une alternative à la clé secrète client, c’est-à-dire l’empreinte numérique d’un certificat utilisé à des fins de signature. Cette propriété remplace la clé secrète client. Elle est également facultative.
issuer	str URI de l’émetteur OpenID Connect qui représente l’entité qui émet des jetons d’accès pour cette application. Lorsque vous utilisez Azure Active Directory, cette valeur est l’URI du locataire d’annuaire, par exemple https://sts.windows.net/{tenant-guid}/. Cet URI est un identificateur respectant la casse pour l’émetteur du jeton. Plus d’informations sur OpenID Connect Discovery : http://openid.net/specs/openid-connect-discovery-1_0.html.
validate_issuer	bool Obtient une valeur indiquant si l’émetteur doit être une URL HTTPS valide et être validé en tant que telle.
allowed_audiences	list[str] Valeurs d’audience autorisées à prendre en compte lors de la validation des JWT émis par Azure Active Directory. Notez que la <code>ClientID</code> valeur est toujours considérée comme un public autorisé, quel que soit ce paramètre.
additional_login_params	list[str] Paramètres de connexion à envoyer au point de terminaison d’autorisation OpenID Connect lorsqu’un utilisateur se connecte. Chaque paramètre doit avoir la forme « key=value ».
aad_claims_authorization	str Obtient une chaîne JSON contenant les paramètres Acl Azure AD.
google_client_id	str ID client OpenID Connect pour l’application web Google. Ce paramètre est requis pour activer la connexion Google. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/.
google_client_secret	str Clé secrète client associée à l’application web Google. Ce paramètre est requis pour activer la connexion Google. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/.
google_client_secret_setting_name	str Nom du paramètre d’application qui contient la clé secrète client associée à l’application web Google.
google_o_auth_scopes	list[str] Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification Google Sign-In. Ce paramètre est facultatif. S’ils ne sont pas spécifiés, « openid », « profil » et « email » sont utilisés comme étendues par défaut. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/.
facebook_app_id	str ID d’application de l’application Facebook utilisée pour la connexion. Ce paramètre est requis pour activer Facebook Connexion. Facebook Documentation de connexion : https://developers.facebook.com/docs/facebook-login.
facebook_app_secret	str Secret d’application de l’application Facebook utilisée pour Facebook Login. Ce paramètre est requis pour activer Facebook Connexion. Facebook Documentation de connexion : https://developers.facebook.com/docs/facebook-login.
facebook_app_secret_setting_name	str Nom du paramètre d’application qui contient le secret d’application utilisé pour Facebook Connexion.
facebook_o_auth_scopes	list[str] Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification de Facebook connexion. Ce paramètre est facultatif. Facebook Documentation de connexion : https://developers.facebook.com/docs/facebook-login.
git_hub_client_id	str ID client de l’application GitHub utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Github.
git_hub_client_secret	str Secret client de l’application GitHub utilisée pour la connexion Github. Ce paramètre est requis pour activer la connexion Github.
git_hub_client_secret_setting_name	str Nom du paramètre d’application qui contient la clé secrète client de l’application Github utilisée pour la connexion GitHub.
git_hub_o_auth_scopes	list[str] Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification gitHub Login. Ce paramètre est facultatif.
twitter_consumer_key	str Clé de consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Twitter. Documentation twitter Sign-In : https://dev.twitter.com/web/sign-in.
twitter_consumer_secret	str Secret consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Twitter. Documentation twitter Sign-In : https://dev.twitter.com/web/sign-in.
twitter_consumer_secret_setting_name	str Nom du paramètre d’application qui contient le secret consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion.
microsoft_account_client_id	str ID client OAuth 2.0 créé pour l’application utilisée pour l’authentification. Ce paramètre est requis pour activer l’authentification du compte Microsoft. Documentation OAuth du compte Microsoft : https://dev.onedrive.com/auth/msa_oauth.htm.
microsoft_account_client_secret	str Clé secrète client OAuth 2.0 qui a été créée pour l’application utilisée pour l’authentification. Ce paramètre est requis pour activer l’authentification du compte Microsoft. Documentation OAuth du compte Microsoft : https://dev.onedrive.com/auth/msa_oauth.htm.
microsoft_account_client_secret_setting_name	str Nom du paramètre d’application contenant la clé secrète client OAuth 2.0 créée pour l’application utilisée pour l’authentification.
microsoft_account_o_auth_scopes	list[str] Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification du compte Microsoft. Ce paramètre est facultatif. S’il n’est pas spécifié, « wl.basic » est utilisé comme étendue par défaut. Documentation sur les étendues et autorisations des comptes Microsoft : https://msdn.microsoft.com/en-us/library/dn631845.aspx.
is_auth_from_file	str « true » si les paramètres de configuration d’authentification doivent être lus à partir d’un fichier, « false » sinon.
auth_file_path	str Chemin d’accès du fichier de configuration contenant les paramètres d’authentification. Si le chemin est relatif, base sera le répertoire racine du site.
config_version	str ConfigVersion de la fonctionnalité d’authentification/autorisation en cours d’utilisation pour l’application actuelle. Le paramètre de cette valeur peut contrôler le comportement du plan de contrôle pour Authentification/Autorisation.

Variables

Nom	Description
id	str ID de ressource.
name	str Nom de la ressource.
kind	str Type de ressource.
type	str Type de ressource.
enabled	bool <code>true</code> si la fonctionnalité d’authentification/autorisation est activée pour l’application actuelle ; sinon, <code>false</code>.
runtime_version	str RuntimeVersion de la fonctionnalité d’authentification/autorisation utilisée pour l’application actuelle. Le paramètre dans cette valeur peut contrôler le comportement de certaines fonctionnalités dans le module Authentification/Autorisation.
unauthenticated_client_action	str ou UnauthenticatedClientAction Action à effectuer lorsqu’un client non authentifié tente d’accéder à l’application. Les valeurs connues sont « RedirectToLoginPage » et « AllowAnonymous ».
token_store_enabled	bool <code>true</code> pour stocker durablement les jetons de sécurité spécifiques à la plateforme qui sont obtenus pendant les flux de connexion ; sinon, <code>false</code>. Par défaut, il s’agit de <code>false</code>.
allowed_external_redirect_urls	list[str] URL externes vers qui peuvent être redirigées dans le cadre de la connexion ou de la déconnexion de l’application. Notez que la partie chaîne de requête de l’URL est ignorée. Il s’agit d’un paramètre avancé généralement nécessaire uniquement aux back-ends d’applications du Windows Store. Notez que les URL dans le domaine actuel sont toujours implicitement autorisées.
default_provider	str ou BuiltInAuthenticationProvider Fournisseur d’authentification par défaut à utiliser lorsque plusieurs fournisseurs sont configurés. Ce paramètre n’est nécessaire que si plusieurs fournisseurs sont configurés et que l’action cliente non authentifiée est définie sur « RedirectToLoginPage ». Les valeurs connues sont « AzureActiveDirectory », « Facebook », « Google », « MicrosoftAccount », « Twitter » et « Github ».
token_refresh_extension_hours	float Nombre d’heures après l’expiration du jeton de session pendant lesquelles un jeton de session peut être utilisé pour appeler l’API d’actualisation du jeton. La valeur par défaut est 72 heures.
client_id	str ID client de cette application de partie de confiance, appelé client_id. Ce paramètre est requis pour activer l’authentification de connexion OpenID auprès d’Azure Active Directory ou d’autres fournisseurs OpenID Connect tiers. Plus d’informations sur OpenID Connect : http://openid.net/specs/openid-connect-core-1_0.html.
client_secret	str Clé secrète client de cette application de partie de confiance (dans Azure Active Directory, elle est également appelée clé). Ce paramètre est facultatif. Si aucune clé secrète client n’est configurée, le flux d’authentification implicite OpenID Connect est utilisé pour authentifier les utilisateurs finaux. Sinon, le flux de code d’autorisation OpenID Connect est utilisé pour authentifier les utilisateurs finaux. Plus d’informations sur OpenID Connect : http://openid.net/specs/openid-connect-core-1_0.html.
client_secret_setting_name	str Nom du paramètre d’application qui contient la clé secrète client de l’application de partie de confiance.
client_secret_certificate_thumbprint	str Alternative à la clé secrète client, c’est-à-dire l’empreinte numérique d’un certificat utilisé à des fins de signature. Cette propriété remplace la clé secrète client. Elle est également facultative.
issuer	str URI de l’émetteur OpenID Connect qui représente l’entité qui émet des jetons d’accès pour cette application. Lorsque vous utilisez Azure Active Directory, cette valeur est l’URI du locataire d’annuaire, par exemple https://sts.windows.net/{tenant-guid}/. Cet URI est un identificateur respectant la casse pour l’émetteur de jeton. Plus d’informations sur openID Connect Discovery : http://openid.net/specs/openid-connect-discovery-1_0.html.
validate_issuer	bool Obtient une valeur indiquant si l’émetteur doit être une URL HTTPS valide et être validé en tant que tel.
allowed_audiences	list[str] Valeurs d’audience autorisées à prendre en compte lors de la validation des JWT émis par Azure Active Directory. Notez que la <code>ClientID</code> valeur est toujours considérée comme une audience autorisée, quel que soit ce paramètre.
additional_login_params	list[str] Paramètres de connexion à envoyer au point de terminaison d’autorisation OpenID Connect lorsqu’un utilisateur se connecte. Chaque paramètre doit être au format « key=value ».
aad_claims_authorization	str Obtient une chaîne JSON contenant les paramètres Acl Azure AD.
google_client_id	str ID client OpenID Connect pour l’application web Google. Ce paramètre est requis pour activer la connexion Google. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/.
google_client_secret	str Clé secrète client associée à l’application web Google. Ce paramètre est requis pour activer la connexion Google. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/.
google_client_secret_setting_name	str Nom du paramètre d’application qui contient la clé secrète client associée à l’application web Google.
google_o_auth_scopes	list[str] Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification google Sign-In. Ce paramètre est facultatif. S’ils ne sont pas spécifiés, « openid », « profile » et « email » sont utilisés comme étendues par défaut. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/.
facebook_app_id	str ID d’application de l’application Facebook utilisée pour la connexion. Ce paramètre est requis pour activer Facebook Connexion. Facebook documentation de connexion : https://developers.facebook.com/docs/facebook-login.
facebook_app_secret	str Secret d’application de l’application Facebook utilisée pour Facebook Connexion. Ce paramètre est requis pour activer Facebook Connexion. Facebook documentation de connexion : https://developers.facebook.com/docs/facebook-login.
facebook_app_secret_setting_name	str Nom du paramètre d’application qui contient le secret d’application utilisé pour Facebook Connexion.
facebook_o_auth_scopes	list[str] Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification de connexion Facebook. Ce paramètre est facultatif. Facebook documentation de connexion : https://developers.facebook.com/docs/facebook-login.
git_hub_client_id	str ID client de l’application GitHub utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Github.
git_hub_client_secret	str Clé secrète client de l’application GitHub utilisée pour la connexion Github. Ce paramètre est requis pour activer la connexion Github.
git_hub_client_secret_setting_name	str Nom du paramètre d’application qui contient la clé secrète client de l’application Github utilisée pour la connexion à GitHub.
git_hub_o_auth_scopes	list[str] Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification de connexion GitHub. Ce paramètre est facultatif.
twitter_consumer_key	str Clé de consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Twitter. Documentation Sign-In Twitter : https://dev.twitter.com/web/sign-in.
twitter_consumer_secret	str Secret du consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Twitter. Documentation Sign-In Twitter : https://dev.twitter.com/web/sign-in.
twitter_consumer_secret_setting_name	str Nom du paramètre d’application qui contient le secret du consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion.
microsoft_account_client_id	str ID client OAuth 2.0 créé pour l’application utilisée pour l’authentification. Ce paramètre est requis pour activer l’authentification du compte Microsoft. Documentation OAuth du compte Microsoft : https://dev.onedrive.com/auth/msa_oauth.htm.
microsoft_account_client_secret	str Clé secrète client OAuth 2.0 créée pour l’application utilisée pour l’authentification. Ce paramètre est requis pour activer l’authentification du compte Microsoft. Documentation OAuth du compte Microsoft : https://dev.onedrive.com/auth/msa_oauth.htm.
microsoft_account_client_secret_setting_name	str Nom du paramètre d’application contenant la clé secrète client OAuth 2.0 créée pour l’application utilisée pour l’authentification.
microsoft_account_o_auth_scopes	list[str] Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification du compte Microsoft. Ce paramètre est facultatif. S’il n’est pas spécifié, « wl.basic » est utilisé comme étendue par défaut. Documentation sur les étendues et autorisations de compte Microsoft : https://msdn.microsoft.com/en-us/library/dn631845.aspx.
is_auth_from_file	str « true » si les paramètres de configuration d’authentification doivent être lus à partir d’un fichier ; sinon, « false ».
auth_file_path	str Chemin du fichier de configuration contenant les paramètres d’authentification. Si le chemin d’accès est relatif, base est le répertoire racine du site.
config_version	str ConfigVersion de la fonctionnalité d’authentification/autorisation en cours d’utilisation pour l’application actuelle. Le paramètre dans cette valeur peut contrôler le comportement du plan de contrôle pour l’authentification/autorisation.