Dela via


SiteAuthSettings Klass

Konfigurationsinställningar för funktionen Azure App Service-autentisering/auktorisering.

Variabler fylls bara i av servern och ignoreras när en begäran skickas.

Arv
azure.mgmt.web.v2020_06_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)

Keyword-Only parametrar

Name Description
kind
str

Typ av resurs.

enabled

<code>true</code>om funktionen Autentisering/auktorisering är aktiverad för den aktuella appen; annars . <code>false</code>

runtime_version
str

RuntimeVersion för funktionen Autentisering/auktorisering som används för den aktuella appen. Inställningen i det här värdet kan styra beteendet för vissa funktioner i modulen Autentisering/auktorisering.

unauthenticated_client_action

Åtgärden som ska vidtas när en oautentiserad klient försöker komma åt appen. Kända värden är: "RedirectToLoginPage" och "AllowAnonymous".

token_store_enabled

<code>true</code>att durably lagrar plattformsspecifika säkerhetstoken som hämtas under inloggningsflöden; annars . <code>false</code>

Standardvärdet är <code>false</code>.

allowed_external_redirect_urls

Externa URL:er som kan omdirigeras till som en del av att logga in eller logga ut från appen. Observera att frågesträngdelen i URL:en ignoreras. Det här är en avancerad inställning som vanligtvis bara behövs av Windows Store-programservrar. Observera att URL:er i den aktuella domänen alltid är implicit tillåtna.

default_provider

Standardautentiseringsprovidern som ska användas när flera leverantörer har konfigurerats. Den här inställningen behövs bara om flera providers har konfigurerats och den oautentiserade klientåtgärden är inställd på "RedirectToLoginPage". Kända värden är: "AzureActiveDirectory", "Facebook", "Google", "MicrosoftAccount", "Twitter" och "Github".

token_refresh_extension_hours

Antalet timmar efter att sessionstoken upphör att gälla som en sessionstoken kan användas för att anropa API:et för tokenuppdatering. Standardvärdet är 72 timmar.

client_id
str

Klient-ID:t för det här förlitande partprogrammet, som kallas client_id. Den här inställningen krävs för att aktivera OpenID-anslutningsautentisering med Azure Active Directory eller andra OpenID Connect-leverantörer från tredje part. Mer information om OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.

client_secret
str

Klienthemligheten för det här förlitande partprogrammet (i Azure Active Directory kallas detta även nyckel). Den här inställningen är valfri. Om ingen klienthemlighet har konfigurerats används openID Connect implicit autentiseringsflöde för att autentisera slutanvändare. Annars används OpenID Connect Authorization Code Flow för att autentisera slutanvändare. Mer information om OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.

client_secret_setting_name
str

Namnet på appinställningen som innehåller klienthemligheten för det förlitande partprogrammet.

client_secret_certificate_thumbprint
str

Ett alternativ till klienthemligheten, som är tumavtrycket för ett certifikat som används för signering. Den här egenskapen fungerar som en ersättning för klienthemligheten. Det är också valfritt.

issuer
str

OpenID Connect Issuer-URI:n som representerar entiteten som utfärdar åtkomsttoken för det här programmet. När du använder Azure Active Directory är det här värdet URI för katalogklientorganisationen, t.ex. https://sts.windows.net/{tenant-guid}/. Den här URI:n är en skiftlägeskänslig identifierare för token utfärdaren. Mer information om OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html.

validate_issuer

Hämtar ett värde som anger om utfärdaren ska vara en giltig HTTPS-URL och verifieras som sådan.

allowed_audiences

Tillåtna målgruppsvärden att tänka på när du verifierar JWT:n som utfärdats av Azure Active Directory. Observera att värdet <code>ClientID</code> alltid betraktas som en tillåten målgrupp, oavsett den här inställningen.

additional_login_params

Inloggningsparametrar som ska skickas till OpenID Connect-auktoriseringsslutpunkten när en användare loggar in. Varje parameter måste vara i formatet "key=value".

aad_claims_authorization
str

Hämtar en JSON-sträng som innehåller inställningarna för Azure AD Acl.

google_client_id
str

OpenID Connect-klient-ID för Google-webbappen. Den här inställningen krävs för att aktivera Google-inloggning. Dokumentation om Google Sign-In: https://developers.google.com/identity/sign-in/web/.

google_client_secret
str

Klienthemligheten som är kopplad till Googles webbapp. Den här inställningen krävs för att aktivera Google-inloggning. Dokumentation om Google Sign-In: https://developers.google.com/identity/sign-in/web/.

google_client_secret_setting_name
str

Appinställningsnamnet som innehåller klienthemligheten som är associerad med Google-webbappen.

google_o_auth_scopes

OAuth 2.0-omfång som begärs som en del av Google Sign-In autentisering. Den här inställningen är valfri. Om inget anges används "openid", "profile" och "email" som standardomfång. Dokumentation om Google Sign-In: https://developers.google.com/identity/sign-in/web/.

facebook_app_id
str

App-ID för Facebook-appen som används för inloggning. Den här inställningen krävs för att aktivera Facebook-inloggning. Dokumentation om Facebook-inloggning: https://developers.facebook.com/docs/facebook-login.

facebook_app_secret
str

Apphemligheten för Facebook-appen som används för Facebook-inloggning. Den här inställningen krävs för att aktivera Facebook-inloggning. Dokumentation om Facebook-inloggning: https://developers.facebook.com/docs/facebook-login.

facebook_app_secret_setting_name
str

Appinställningsnamnet som innehåller apphemligheten som används för Facebook-inloggning.

facebook_o_auth_scopes

OAuth 2.0-omfången som begärs som en del av Facebook-inloggningsautentisering. Den här inställningen är valfri. Dokumentation om Facebook-inloggning: https://developers.facebook.com/docs/facebook-login.

git_hub_client_id
str

Klient-ID för GitHub-appen som används för inloggning. Den här inställningen krävs för att aktivera Github-inloggning.

git_hub_client_secret
str

Klienthemligheten för GitHub-appen som används för Github-inloggning. Den här inställningen krävs för att aktivera Github-inloggning.

git_hub_client_secret_setting_name
str

Namnet på appinställningen som innehåller klienthemligheten för Github-appen som används för GitHub-inloggning.

git_hub_o_auth_scopes

OAuth 2.0-omfång som begärs som en del av GitHub-inloggningsautentisering. Den här inställningen är valfri.

twitter_consumer_key
str

OAuth 1.0a-konsumentnyckeln för Twitter-programmet som används för inloggning. Den här inställningen krävs för att aktivera Twitter-inloggning. Dokumentation om Twitter-Sign-In: https://dev.twitter.com/web/sign-in.

twitter_consumer_secret
str

OAuth 1.0a-konsumenthemligheten för Twitter-programmet som används för inloggning. Den här inställningen krävs för att aktivera Twitter-inloggning. Dokumentation om Twitter-Sign-In: https://dev.twitter.com/web/sign-in.

twitter_consumer_secret_setting_name
str

Appinställningsnamnet som innehåller OAuth 1.0a-konsumenthemligheten för Twitter-programmet som används för inloggning.

microsoft_account_client_id
str

OAuth 2.0-klient-ID:t som skapades för appen som används för autentisering. Den här inställningen krävs för att aktivera autentisering med Microsoft-konto. Dokumentation om Microsoft Account OAuth: https://dev.onedrive.com/auth/msa_oauth.htm.

microsoft_account_client_secret
str

OAuth 2.0-klienthemligheten som skapades för appen som används för autentisering. Den här inställningen krävs för att aktivera autentisering med Microsoft-konto. Dokumentation om Microsoft Account OAuth: https://dev.onedrive.com/auth/msa_oauth.htm.

microsoft_account_client_secret_setting_name
str

Appinställningsnamnet som innehåller OAuth 2.0-klienthemligheten som skapades för appen som används för autentisering.

microsoft_account_o_auth_scopes

OAuth 2.0-omfång som begärs som en del av Microsoft-kontoautentisering. Den här inställningen är valfri. Om det inte anges används "wl.basic" som standardomfång. Dokumentation om Microsoft-kontoomfattningar och behörigheter: https://msdn.microsoft.com/en-us/library/dn631845.aspx.

is_auth_from_file
str

"true" om autentiseringskonfigurationsinställningarna ska läsas från en fil, annars "falskt".

auth_file_path
str

Sökvägen till konfigurationsfilen som innehåller autentiseringsinställningar. Om sökvägen är relativ kommer platsens rotkatalog att baseras.

Variabler

Name Description
id
str

Resurs-ID.

name
str

Resursnamn.

kind
str

Typ av resurs.

type
str

Resurstyp.

enabled

<code>true</code>om funktionen Autentisering/auktorisering är aktiverad för den aktuella appen; annars . <code>false</code>

runtime_version
str

RuntimeVersion för funktionen Autentisering/auktorisering som används för den aktuella appen. Inställningen i det här värdet kan styra beteendet för vissa funktioner i modulen Autentisering/auktorisering.

unauthenticated_client_action

Åtgärden som ska vidtas när en oautentiserad klient försöker komma åt appen. Kända värden är: "RedirectToLoginPage" och "AllowAnonymous".

token_store_enabled

<code>true</code>att durably lagrar plattformsspecifika säkerhetstoken som hämtas under inloggningsflöden; annars . <code>false</code>

Standardvärdet är <code>false</code>.

allowed_external_redirect_urls

Externa URL:er som kan omdirigeras till som en del av att logga in eller logga ut från appen. Observera att frågesträngdelen i URL:en ignoreras. Det här är en avancerad inställning som vanligtvis bara behövs av Windows Store-programservrar. Observera att URL:er i den aktuella domänen alltid är implicit tillåtna.

default_provider

Standardautentiseringsprovidern som ska användas när flera leverantörer har konfigurerats. Den här inställningen behövs bara om flera providers har konfigurerats och den oautentiserade klientåtgärden är inställd på "RedirectToLoginPage". Kända värden är: "AzureActiveDirectory", "Facebook", "Google", "MicrosoftAccount", "Twitter" och "Github".

token_refresh_extension_hours

Antalet timmar efter att sessionstoken upphör att gälla som en sessionstoken kan användas för att anropa API:et för tokenuppdatering. Standardvärdet är 72 timmar.

client_id
str

Klient-ID:t för det här förlitande partprogrammet, som kallas client_id. Den här inställningen krävs för att aktivera OpenID-anslutningsautentisering med Azure Active Directory eller andra OpenID Connect-leverantörer från tredje part. Mer information om OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.

client_secret
str

Klienthemligheten för det här förlitande partprogrammet (i Azure Active Directory kallas detta även nyckel). Den här inställningen är valfri. Om ingen klienthemlighet har konfigurerats används openID Connect implicit autentiseringsflöde för att autentisera slutanvändare. Annars används OpenID Connect Authorization Code Flow för att autentisera slutanvändare. Mer information om OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.

client_secret_setting_name
str

Namnet på appinställningen som innehåller klienthemligheten för det förlitande partprogrammet.

client_secret_certificate_thumbprint
str

Ett alternativ till klienthemligheten, som är tumavtrycket för ett certifikat som används för signering. Den här egenskapen fungerar som en ersättning för klienthemligheten. Det är också valfritt.

issuer
str

OpenID Connect Issuer-URI:n som representerar entiteten som utfärdar åtkomsttoken för det här programmet. När du använder Azure Active Directory är det här värdet URI för katalogklientorganisationen, t.ex. https://sts.windows.net/{tenant-guid}/. Den här URI:n är en skiftlägeskänslig identifierare för token utfärdaren. Mer information om OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html.

validate_issuer

Hämtar ett värde som anger om utfärdaren ska vara en giltig HTTPS-URL och verifieras som sådan.

allowed_audiences

Tillåtna målgruppsvärden att tänka på när du verifierar JWT:n som utfärdats av Azure Active Directory. Observera att värdet <code>ClientID</code> alltid betraktas som en tillåten målgrupp, oavsett den här inställningen.

additional_login_params

Inloggningsparametrar som ska skickas till OpenID Connect-auktoriseringsslutpunkten när en användare loggar in. Varje parameter måste vara i formatet "key=value".

aad_claims_authorization
str

Hämtar en JSON-sträng som innehåller inställningarna för Azure AD Acl.

google_client_id
str

OpenID Connect-klient-ID för Google-webbappen. Den här inställningen krävs för att aktivera Google-inloggning. Dokumentation om Google Sign-In: https://developers.google.com/identity/sign-in/web/.

google_client_secret
str

Klienthemligheten som är kopplad till Googles webbapp. Den här inställningen krävs för att aktivera Google-inloggning. Dokumentation om Google Sign-In: https://developers.google.com/identity/sign-in/web/.

google_client_secret_setting_name
str

Appinställningsnamnet som innehåller klienthemligheten som är associerad med Google-webbappen.

google_o_auth_scopes

OAuth 2.0-omfång som begärs som en del av Google Sign-In autentisering. Den här inställningen är valfri. Om inget anges används "openid", "profile" och "email" som standardomfång. Dokumentation om Google Sign-In: https://developers.google.com/identity/sign-in/web/.

facebook_app_id
str

App-ID för Facebook-appen som används för inloggning. Den här inställningen krävs för att aktivera Facebook-inloggning. Dokumentation om Facebook-inloggning: https://developers.facebook.com/docs/facebook-login.

facebook_app_secret
str

Apphemligheten för Facebook-appen som används för Facebook-inloggning. Den här inställningen krävs för att aktivera Facebook-inloggning. Dokumentation om Facebook-inloggning: https://developers.facebook.com/docs/facebook-login.

facebook_app_secret_setting_name
str

Appinställningsnamnet som innehåller apphemligheten som används för Facebook-inloggning.

facebook_o_auth_scopes

OAuth 2.0-omfången som begärs som en del av Facebook-inloggningsautentisering. Den här inställningen är valfri. Dokumentation om Facebook-inloggning: https://developers.facebook.com/docs/facebook-login.

git_hub_client_id
str

Klient-ID för GitHub-appen som används för inloggning. Den här inställningen krävs för att aktivera Github-inloggning.

git_hub_client_secret
str

Klienthemligheten för GitHub-appen som används för Github-inloggning. Den här inställningen krävs för att aktivera Github-inloggning.

git_hub_client_secret_setting_name
str

Namnet på appinställningen som innehåller klienthemligheten för Github-appen som används för GitHub-inloggning.

git_hub_o_auth_scopes

OAuth 2.0-omfång som begärs som en del av GitHub-inloggningsautentisering. Den här inställningen är valfri.

twitter_consumer_key
str

OAuth 1.0a-konsumentnyckeln för Twitter-programmet som används för inloggning. Den här inställningen krävs för att aktivera Twitter-inloggning. Dokumentation om Twitter-Sign-In: https://dev.twitter.com/web/sign-in.

twitter_consumer_secret
str

OAuth 1.0a-konsumenthemligheten för Twitter-programmet som används för inloggning. Den här inställningen krävs för att aktivera Twitter-inloggning. Dokumentation om Twitter-Sign-In: https://dev.twitter.com/web/sign-in.

twitter_consumer_secret_setting_name
str

Appinställningsnamnet som innehåller OAuth 1.0a-konsumenthemligheten för Twitter-programmet som används för inloggning.

microsoft_account_client_id
str

OAuth 2.0-klient-ID:t som skapades för appen som används för autentisering. Den här inställningen krävs för att aktivera autentisering med Microsoft-konto. Dokumentation om Microsoft Account OAuth: https://dev.onedrive.com/auth/msa_oauth.htm.

microsoft_account_client_secret
str

OAuth 2.0-klienthemligheten som skapades för appen som används för autentisering. Den här inställningen krävs för att aktivera autentisering med Microsoft-konto. Dokumentation om Microsoft Account OAuth: https://dev.onedrive.com/auth/msa_oauth.htm.

microsoft_account_client_secret_setting_name
str

Appinställningsnamnet som innehåller OAuth 2.0-klienthemligheten som skapades för appen som används för autentisering.

microsoft_account_o_auth_scopes

OAuth 2.0-omfång som begärs som en del av Microsoft-kontoautentisering. Den här inställningen är valfri. Om det inte anges används "wl.basic" som standardomfång. Dokumentation om Microsoft-kontoomfattningar och behörigheter: https://msdn.microsoft.com/en-us/library/dn631845.aspx.

is_auth_from_file
str

"true" om autentiseringskonfigurationsinställningarna ska läsas från en fil, annars "falskt".

auth_file_path
str

Sökvägen till konfigurationsfilen som innehåller autentiseringsinställningar. Om sökvägen är relativ kommer platsens rotkatalog att baseras.