SiteAuthSettings Klasse

Referenz

Konfigurationseinstellungen für die Azure App Service Authentifizierungs-/Autorisierungsfunktion.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

Vererbung: azure.mgmt.web.v2020_09_01.models._models_py3.ProxyOnlyResource

SiteAuthSettings

Konstruktor

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, **kwargs: Any)

Nur Schlüsselwortparameter

Name	Beschreibung
kind	str Art der Ressource.
enabled	bool `<code>true</code>` , wenn die Authentifizierungs-/Autorisierungsfunktion für die aktuelle App aktiviert ist; `<code>false</code>`andernfalls .
runtime_version	str Die RuntimeVersion des Authentifizierungs-/Autorisierungsfeatures, das für die aktuelle App verwendet wird. Die Einstellung in diesem Wert kann das Verhalten bestimmter Features im Modul Authentifizierung/Autorisierung steuern.
unauthenticated_client_action	str oder UnauthenticatedClientAction Die Aktion, die ausgeführt werden soll, wenn ein nicht authentifizierter Client versucht, auf die App zuzugreifen. Bekannte Werte sind "RedirectToLoginPage" und "AllowAnonymous".
token_store_enabled	bool `<code>true</code>` um plattformspezifische Sicherheitstoken, die während der Anmeldeflows abgerufen werden, dauerhaft zu speichern; `<code>false</code>`andernfalls . Der Standardwert lautet `<code>false</code>`.
allowed_external_redirect_urls	list[str] Externe URLs, zu denen im Rahmen des Anmeldens oder Abmeldens der App umgeleitet werden kann. Beachten Sie, dass der Abfragezeichenfolgenteil der URL ignoriert wird. Dies ist eine erweiterte Einstellung, die normalerweise nur von Windows Store-Anwendungs-Back-Ends benötigt wird. Beachten Sie, dass URLs innerhalb der aktuellen Domäne immer implizit zulässig sind.
default_provider	str oder BuiltInAuthenticationProvider Der Standardauthentifizierungsanbieter, der verwendet werden soll, wenn mehrere Anbieter konfiguriert sind. Diese Einstellung ist nur erforderlich, wenn mehrere Anbieter konfiguriert sind und die nicht authentifizierte Clientaktion auf "RedirectToLoginPage" festgelegt ist. Bekannte Werte sind "AzureActiveDirectory", "Facebook", "Google", "MicrosoftAccount", "Twitter" und "Github".
token_refresh_extension_hours	float Die Anzahl der Stunden nach Ablauf des Sitzungstokens, die ein Sitzungstoken zum Aufrufen der Tokenaktualisierungs-API verwendet werden kann. Die Standardeinstellung beträgt 72 Stunden.
client_id	str Die Client-ID dieser Anwendung der vertrauenden Seite, die als client_id bezeichnet wird. Diese Einstellung ist erforderlich, um die OpenID-Verbindungsauthentifizierung mit Azure Active Directory oder anderen OpenID Connect-Anbietern von Drittanbietern zu aktivieren. Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.
client_secret	str Der geheime Clientschlüssel dieser Anwendung der vertrauenden Seite (in Azure Active Directory wird dies auch als Schlüssel bezeichnet). Diese Einstellung ist optional. Wenn kein geheimer Clientschlüssel konfiguriert ist, wird der implizite Authentifizierungsflow von OpenID Connect verwendet, um Endbenutzer zu authentifizieren. Andernfalls wird der OpenID Connect-Autorisierungscodeflow verwendet, um Endbenutzer zu authentifizieren. Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.
client_secret_setting_name	str Der App-Einstellungsname, der den geheimen Clientschlüssel der Anwendung der vertrauenden Seite enthält.
client_secret_certificate_thumbprint	str Eine Alternative zum geheimen Clientschlüssel, d. h. der Fingerabdruck eines Zertifikats, das zu Signaturzwecken verwendet wird. Diese Eigenschaft fungiert als Ersatz für den geheimen Clientschlüssel. Es ist auch optional.
issuer	str Der OpenID Connect Issuer-URI, der die Entität darstellt, die Zugriffstoken für diese Anwendung ausgibt. Bei Verwendung von Azure Active Directory ist dieser Wert der URI des Verzeichnismandanten, z. B. https://sts.windows.net/{tenant-guid}/. Bei diesem URI handelt es sich um einen Bezeichner, bei dem die Groß-/Kleinschreibung für den Tokenaussteller beachtet wird. Weitere Informationen zur OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html.
validate_issuer	bool Ruft einen Wert ab, der angibt, ob der Aussteller eine gültige HTTPS-URL sein soll und als solcher überprüft werden soll.
allowed_audiences	list[str] Zulässige Zielgruppenwerte, die beim Überprüfen von von Azure Active Directory ausgegebenen JWTs berücksichtigt werden. Beachten Sie, dass der `<code>ClientID</code>` Wert unabhängig von dieser Einstellung immer als zulässige Zielgruppe betrachtet wird.
additional_login_params	list[str] Anmeldeparameter, die an den OpenID Connect-Autorisierungsendpunkt gesendet werden sollen, wenn sich ein Benutzer anmeldet. Jeder Parameter muss das Format "key=value" aufweisen.
aad_claims_authorization	str Ruft eine JSON-Zeichenfolge ab, die die Azure AD-ACL-Einstellungen enthält.
google_client_id	str Die OpenID Connect-Client-ID für die Google-Webanwendung. Diese Einstellung ist erforderlich, um die Google-Anmeldung zu aktivieren. Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/.
google_client_secret	str Der geheime Clientschlüssel, der der Google-Webanwendung zugeordnet ist. Diese Einstellung ist erforderlich, um die Google-Anmeldung zu aktivieren. Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/.
google_client_secret_setting_name	str Der App-Einstellungsname, der den geheimen Clientschlüssel enthält, der der Google-Webanwendung zugeordnet ist.
google_o_auth_scopes	list[str] Die OAuth 2.0-Bereiche, die im Rahmen der Google-Sign-In-Authentifizierung angefordert werden. Diese Einstellung ist optional. Wenn nicht angegeben, werden "openid", "profile" und "email" als Standardbereiche verwendet. Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/.
facebook_app_id	str Die App-ID der Facebook-App, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Facebook-Anmeldung zu aktivieren. Dokumentation zur Facebook-Anmeldung: https://developers.facebook.com/docs/facebook-login.
facebook_app_secret	str Das App-Geheimnis der Facebook-App, die für die Facebook-Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Facebook-Anmeldung zu aktivieren. Dokumentation zur Facebook-Anmeldung: https://developers.facebook.com/docs/facebook-login.
facebook_app_secret_setting_name	str Der App-Einstellungsname, der das für die Facebook-Anmeldung verwendete App-Geheimnis enthält.
facebook_o_auth_scopes	list[str] Die OAuth 2.0-Bereiche, die im Rahmen der Facebook-Anmeldeauthentifizierung angefordert werden. Diese Einstellung ist optional. Dokumentation zur Facebook-Anmeldung: https://developers.facebook.com/docs/facebook-login.
git_hub_client_id	str Die Client-ID der GitHub-App, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Github-Anmeldung zu aktivieren.
git_hub_client_secret	str Der geheime Clientschlüssel der GitHub-App, die für die Github-Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Github-Anmeldung zu aktivieren.
git_hub_client_secret_setting_name	str Der App-Einstellungsname, der den geheimen Clientschlüssel der Github-App enthält, die für die GitHub-Anmeldung verwendet wird.
git_hub_o_auth_scopes	list[str] Die OAuth 2.0-Bereiche, die im Rahmen der GitHub-Anmeldeauthentifizierung angefordert werden. Diese Einstellung ist optional.
twitter_consumer_key	str Der OAuth 1.0a-Consumerschlüssel der Twitter-Anwendung, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Twitter-Anmeldung zu aktivieren. Twitter Sign-In Dokumentation: https://dev.twitter.com/web/sign-in.
twitter_consumer_secret	str Das OAuth 1.0a-Consumergeheimnis der Twitter-Anwendung, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Twitter-Anmeldung zu aktivieren. Twitter Sign-In Dokumentation: https://dev.twitter.com/web/sign-in.
twitter_consumer_secret_setting_name	str Der App-Einstellungsname, der das OAuth 1.0a-Consumergeheimnis der twitter-Anwendung enthält, die für die Anmeldung verwendet wird.
microsoft_account_client_id	str Die OAuth 2.0-Client-ID, die für die für die Authentifizierung verwendete App erstellt wurde. Diese Einstellung ist erforderlich, um die Microsoft-Kontoauthentifizierung zu aktivieren. Microsoft-Konto OAuth-Dokumentation: https://dev.onedrive.com/auth/msa_oauth.htm.
microsoft_account_client_secret	str Der geheime OAuth 2.0-Clientschlüssel, der für die für die Authentifizierung verwendete App erstellt wurde. Diese Einstellung ist erforderlich, um die Microsoft-Kontoauthentifizierung zu aktivieren. Microsoft-Konto OAuth-Dokumentation: https://dev.onedrive.com/auth/msa_oauth.htm.
microsoft_account_client_secret_setting_name	str Der App-Einstellungsname, der den geheimen OAuth 2.0-Clientschlüssel enthält, der für die für die Authentifizierung verwendete App erstellt wurde.
microsoft_account_o_auth_scopes	list[str] Die OAuth 2.0-Bereiche, die im Rahmen der Microsoft-Kontoauthentifizierung angefordert werden. Diese Einstellung ist optional. Falls nicht angegeben, wird "wl.basic" als Standardbereich verwendet. Dokumentation zu Microsoft-Kontobereichen und Berechtigungen: https://msdn.microsoft.com/en-us/library/dn631845.aspx.
is_auth_from_file	str "true", wenn die Konfigurationseinstellungen der Authentifizierung aus einer Datei gelesen werden sollen, andernfalls "false".
auth_file_path	str Der Pfad der Konfigurationsdatei, die Authentifizierungseinstellungen enthält. Wenn der Pfad relativ ist, wird basis das Stammverzeichnis der Website verwendet.

Variablen

Name	Beschreibung
id	str Ressourcen-ID.
name	str Ressourcenname.
kind	str Art der Ressource.
type	str Der Ressourcentyp.
system_data	SystemData Die Systemmetadaten, die sich auf diese Ressource beziehen.
enabled	bool `<code>true</code>` , wenn die Authentifizierungs-/Autorisierungsfunktion für die aktuelle App aktiviert ist; `<code>false</code>`andernfalls .
runtime_version	str Die RuntimeVersion der Authentifizierungs-/Autorisierungsfunktion, die für die aktuelle App verwendet wird. Die Einstellung in diesem Wert kann das Verhalten bestimmter Features im Modul Authentifizierung/Autorisierung steuern.
unauthenticated_client_action	str oder UnauthenticatedClientAction Die Aktion, die ausgeführt werden soll, wenn ein nicht authentifizierter Client versucht, auf die App zuzugreifen. Bekannte Werte sind: "RedirectToLoginPage" und "AllowAnonymous".
token_store_enabled	bool `<code>true</code>` zum dauerhaften Speichern plattformspezifischer Sicherheitstoken, die während der Anmeldeflows abgerufen werden; `<code>false</code>`andernfalls . Der Standardwert lautet `<code>false</code>`.
allowed_external_redirect_urls	list[str] Externe URLs, die im Rahmen der Anmeldung oder Abmeldung der App umgeleitet werden können. Beachten Sie, dass der Abfragezeichenfolgenteil der URL ignoriert wird. Dies ist eine erweiterte Einstellung, die normalerweise nur von Windows Store-Anwendungs-Back-Ends benötigt wird. Beachten Sie, dass URLs innerhalb der aktuellen Domäne immer implizit zulässig sind.
default_provider	str oder BuiltInAuthenticationProvider Der Standardauthentifizierungsanbieter, der verwendet werden soll, wenn mehrere Anbieter konfiguriert sind. Diese Einstellung ist nur erforderlich, wenn mehrere Anbieter konfiguriert sind und die nicht authentifizierte Clientaktion auf "RedirectToLoginPage" festgelegt ist. Bekannte Werte sind: "AzureActiveDirectory", "Facebook", "Google", "MicrosoftAccount", "Twitter" und "GitHub".
token_refresh_extension_hours	float Die Anzahl der Stunden nach Ablauf des Sitzungstokens, die ein Sitzungstoken zum Aufrufen der Tokenaktualisierungs-API verwendet werden kann. Die Standardeinstellung beträgt 72 Stunden.
client_id	str Die Client-ID dieser Anwendung der vertrauenden Seite, die als client_id bezeichnet wird. Diese Einstellung ist erforderlich, um die OpenID-Verbindungsauthentifizierung mit Azure Active Directory oder anderen OpenID Connect-Drittanbietern zu aktivieren. Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.
client_secret	str Der geheime Clientschlüssel dieser Anwendung der vertrauenden Seite (in Azure Active Directory wird dies auch als Schlüssel bezeichnet). Diese Einstellung ist optional. Wenn kein geheimer Clientschlüssel konfiguriert ist, wird der implizite OpenID Connect-Authentifizierungsflow verwendet, um Endbenutzer zu authentifizieren. Andernfalls wird der OpenID Connect-Autorisierungscodeflow verwendet, um Endbenutzer zu authentifizieren. Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.
client_secret_setting_name	str Der Name der App-Einstellung, der den geheimen Clientschlüssel der Anwendung der vertrauenden Seite enthält.
client_secret_certificate_thumbprint	str Eine Alternative zum geheimen Clientschlüssel, d. h. der Fingerabdruck eines Zertifikats, das zu Signaturzwecken verwendet wird. Diese Eigenschaft fungiert als Ersatz für den geheimen Clientschlüssel. Es ist auch optional.
issuer	str Der OpenID Connect-Aussteller-URI, der die Entität darstellt, die Zugriffstoken für diese Anwendung ausgibt. Bei Verwendung von Azure Active Directory ist dieser Wert der URI des Verzeichnismandanten, z. B. https://sts.windows.net/{tenant-guid}/. Bei diesem URI handelt es sich um einen Bezeichner, bei dem die Groß-/Kleinschreibung für den Tokenaussteller beachtet wird. Weitere Informationen zur OpenID Connect-Ermittlung: http://openid.net/specs/openid-connect-discovery-1_0.html.
validate_issuer	bool Ruft einen Wert ab, der angibt, ob der Aussteller eine gültige HTTPS-URL sein und als solcher überprüft werden soll.
allowed_audiences	list[str] Zulässige Zielgruppenwerte, die beim Überprüfen von von Azure Active Directory ausgestellten JWTs berücksichtigt werden. Beachten Sie, dass der `<code>ClientID</code>` Wert unabhängig von dieser Einstellung immer als zulässige Zielgruppe betrachtet wird.
additional_login_params	list[str] Anmeldeparameter, die an den OpenID Connect-Autorisierungsendpunkt gesendet werden sollen, wenn sich ein Benutzer anmeldet. Jeder Parameter muss die Form "key=value" aufweisen.
aad_claims_authorization	str Ruft eine JSON-Zeichenfolge ab, die die Azure AD-Acl-Einstellungen enthält.
google_client_id	str Die OpenID Connect-Client-ID für die Google-Webanwendung. Diese Einstellung ist erforderlich, um die Google-Anmeldung zu aktivieren. Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/.
google_client_secret	str Der geheime Clientschlüssel, der der Google-Webanwendung zugeordnet ist. Diese Einstellung ist erforderlich, um die Google-Anmeldung zu aktivieren. Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/.
google_client_secret_setting_name	str Der Name der App-Einstellung, der den geheimen Clientschlüssel enthält, der der Google-Webanwendung zugeordnet ist.
google_o_auth_scopes	list[str] Die OAuth 2.0-Bereiche, die im Rahmen der Google-Sign-In-Authentifizierung angefordert werden. Diese Einstellung ist optional. Wenn nicht angegeben, werden "openid", "profile" und "email" als Standardbereiche verwendet. Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/.
facebook_app_id	str Die App-ID der Facebook-App, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Facebook-Anmeldung zu aktivieren. Dokumentation zur Facebook-Anmeldung: https://developers.facebook.com/docs/facebook-login.
facebook_app_secret	str Das App-Geheimnis der Facebook-App, die für die Facebook-Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Facebook-Anmeldung zu aktivieren. Dokumentation zur Facebook-Anmeldung: https://developers.facebook.com/docs/facebook-login.
facebook_app_secret_setting_name	str Der Name der App-Einstellung, der das für die Facebook-Anmeldung verwendete App-Geheimnis enthält.
facebook_o_auth_scopes	list[str] Die OAuth 2.0-Bereiche, die im Rahmen der Facebook-Anmeldeauthentifizierung angefordert werden. Diese Einstellung ist optional. Dokumentation zur Facebook-Anmeldung: https://developers.facebook.com/docs/facebook-login.
git_hub_client_id	str Die Client-ID der GitHub-App, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die GitHub-Anmeldung zu aktivieren.
git_hub_client_secret	str Der geheime Clientschlüssel der GitHub-App, die für die GitHub-Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die GitHub-Anmeldung zu aktivieren.
git_hub_client_secret_setting_name	str Der Name der App-Einstellung, der den geheimen Clientschlüssel der GitHub-App enthält, die für die GitHub-Anmeldung verwendet wird.
git_hub_o_auth_scopes	list[str] Die OAuth 2.0-Bereiche, die im Rahmen der GitHub-Anmeldeauthentifizierung angefordert werden. Diese Einstellung ist optional.
twitter_consumer_key	str Der OAuth 1.0a-Consumerschlüssel der Twitter-Anwendung, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Twitter-Anmeldung zu aktivieren. Twitter Sign-In Dokumentation: https://dev.twitter.com/web/sign-in.
twitter_consumer_secret	str Das OAuth 1.0a-Consumergeheimnis der Twitter-Anwendung, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Twitter-Anmeldung zu aktivieren. Twitter Sign-In Dokumentation: https://dev.twitter.com/web/sign-in.
twitter_consumer_secret_setting_name	str Der Name der App-Einstellung, der das OAuth 1.0a-Consumergeheimnis der twitter-Anwendung enthält, die für die Anmeldung verwendet wird.
microsoft_account_client_id	str Die OAuth 2.0-Client-ID, die für die für die Authentifizierung verwendete App erstellt wurde. Diese Einstellung ist erforderlich, um die Microsoft-Kontoauthentifizierung zu aktivieren. Microsoft-Konto OAuth-Dokumentation: https://dev.onedrive.com/auth/msa_oauth.htm.
microsoft_account_client_secret	str Der geheime OAuth 2.0-Clientschlüssel, der für die für die Authentifizierung verwendete App erstellt wurde. Diese Einstellung ist erforderlich, um die Microsoft-Kontoauthentifizierung zu aktivieren. Microsoft-Konto OAuth-Dokumentation: https://dev.onedrive.com/auth/msa_oauth.htm.
microsoft_account_client_secret_setting_name	str Der Name der App-Einstellung, der den geheimen OAuth 2.0-Clientschlüssel enthält, der für die app erstellt wurde, die für die Authentifizierung verwendet wird.
microsoft_account_o_auth_scopes	list[str] Die OAuth 2.0-Bereiche, die im Rahmen der Microsoft-Kontoauthentifizierung angefordert werden. Diese Einstellung ist optional. Wenn nicht angegeben, wird "wl.basic" als Standardbereich verwendet. Dokumentation zu Microsoft-Kontobereichen und Berechtigungen: https://msdn.microsoft.com/en-us/library/dn631845.aspx.
is_auth_from_file	str "true", wenn die Konfigurationseinstellungen für die Authentifizierung aus einer Datei gelesen werden sollen, andernfalls "false".
auth_file_path	str Der Pfad der Konfigurationsdatei, die Authentifizierungseinstellungen enthält. Wenn der Pfad relativ ist, wird base das Stammverzeichnis der Website.

Freigeben über

SiteAuthSettings Klasse

Konstruktor

Nur Schlüsselwortparameter

Variablen

Zusätzliche Ressourcen