Web Apps - Update Auth Settings

Reference

Service:: App Service

API Version:: 2023-12-01

Popis Aktualizace nastavení ověřování/autorizace přidruženého k webové aplikaci.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings?api-version=2023-12-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
name	path	True	string	Název webové aplikace.
resourceGroupName	path	True	string	Název skupiny prostředků, do které prostředek patří. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	ID vašeho předplatného Azure Jedná se o řetězec ve formátu GUID (např. 00000000-0000-0000-0000-0000000000000000).
api-version	query	True	string	Verze rozhraní API

Text požadavku

Name	Typ	Description
kind	string	Druh prostředku.
properties.aadClaimsAuthorization	string	Získá řetězec JSON obsahující nastavení seznamu ACL Azure AD.
properties.additionalLoginParams	string[]	Přihlašovací parametry, které se mají odeslat do koncového bodu autorizace OpenID Connect při přihlášení uživatele. Každý parametr musí být ve formátu key=value.
properties.allowedAudiences	string[]	Povolené hodnoty cílové skupiny ke zvážení při ověřování webových tokenů JSON vydaných službou Azure Active Directory Všimněte si, že hodnota `ClientID` se vždy považuje za povolenou cílovou skupinu bez ohledu na toto nastavení.
properties.allowedExternalRedirectUrls	string[]	Externí adresy URL, na které je možné přesměrovat v rámci přihlášení nebo odhlášení z aplikace. Všimněte si, že část adresy URL řetězce dotazu se ignoruje. Jedná se o upřesňující nastavení, které obvykle potřebují jenom back-endy aplikací pro Windows Store. Mějte na paměti, že adresy URL v rámci aktuální domény jsou vždy implicitně povolené.
properties.authFilePath	string	Cesta ke konfiguračnímu souboru obsahujícímu nastavení ověřování. Pokud je cesta relativní, základ bude kořenový adresář webu.
properties.clientId	string	ID klienta této aplikace předávající strany označované jako client_id. Toto nastavení se vyžaduje k povolení ověřování připojení OpenID pomocí Azure Active Directory nebo jiných poskytovatelů OpenID Connect třetích stran. Další informace o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret	string	Tajný klíč klienta této aplikace předávající strany (v Azure Active Directory se označuje také jako klíč). Toto nastavení je volitelné. Pokud není nakonfigurovaný žádný tajný klíč klienta, použije se k ověření koncových uživatelů tok implicitního ověřování OpenID Connect. Jinak se k ověřování koncových uživatelů používá tok autorizačního kódu OpenID Connect. Další informace o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecretCertificateThumbprint	string	Alternativou k tajnému klíči klienta je kryptografický otisk certifikátu, který se používá pro podpisové účely. Tato vlastnost funguje jako náhrada tajného klíče klienta. Je také nepovinný.
properties.clientSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný klíč klienta aplikace předávající strany.
properties.configVersion	string	ConfigVersion funkce ověřování / autorizace, která se používá pro aktuální aplikaci. Nastavení v této hodnotě může řídit chování řídicí roviny pro ověřování / autorizaci.
properties.defaultProvider	BuiltInAuthenticationProvider	Výchozí zprostředkovatel ověřování, který se použije při konfiguraci více zprostředkovatelů. Toto nastavení je potřeba jenom v případě, že je nakonfigurovaných více zprostředkovatelů a neověřená akce klienta je nastavená na RedirectToLoginPage.
properties.enabled	boolean	`true`pokud je pro aktuální aplikaci povolená funkce ověřování /autorizace; v opačném případě . `false`
properties.facebookAppId	string	ID aplikace Facebook použité k přihlášení. Toto nastavení se vyžaduje k povolení přihlášení Facebook. Dokumentace k přihlášení Facebook:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	Tajný kód aplikace Facebook použité k přihlášení Facebook. Toto nastavení se vyžaduje k povolení přihlášení Facebook. Dokumentace k přihlášení Facebook:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný kód aplikace použitý pro přihlášení Facebook.
properties.facebookOAuthScopes	string[]	Obory OAuth 2.0, které budou požadovány v rámci ověřování přihlášení Facebook. Toto nastavení je volitelné. Dokumentace k přihlášení Facebook:https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	ID klienta aplikace GitHubu, která se používá k přihlášení. Toto nastavení se vyžaduje pro povolení přihlášení ke GitHubu.
properties.gitHubClientSecret	string	Tajný klíč klienta aplikace GitHub, která se používá pro přihlášení ke GitHubu. Toto nastavení se vyžaduje pro povolení přihlášení ke GitHubu.
properties.gitHubClientSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný klíč klienta aplikace GitHub, který se používá pro přihlášení ke GitHubu.
properties.gitHubOAuthScopes	string[]	Obory OAuth 2.0, které se budou vyžadovat v rámci ověřování přihlášení Ke GitHubu. Toto nastavení je volitelné.
properties.googleClientId	string	ID klienta OpenID Connect pro webovou aplikaci Google. Toto nastavení se vyžaduje k povolení přihlášení googlem. Dokumentace ke službě Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	Tajný klíč klienta přidružený k webové aplikaci Google. Toto nastavení se vyžaduje k povolení přihlášení googlem. Dokumentace ke službě Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný klíč klienta přidružený k webové aplikaci Google.
properties.googleOAuthScopes	string[]	Obory OAuth 2.0, které budou požadovány v rámci ověřování Google Sign-In. Toto nastavení je volitelné. Pokud není zadaný, jako výchozí obory se použijí "openid", "profile" a "email". Dokumentace ke službě Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile	string	"true", pokud se má nastavení konfigurace ověřování číst ze souboru, "false", jinak "false".
properties.issuer	string	Identifikátor URI vystavitele OpenID Connect, který představuje entitu, která vydává přístupové tokeny pro tuto aplikaci. Při použití Azure Active Directory je tato hodnota identifikátorem URI tenanta adresáře, např. https://sts.windows.net/{tenant-guid}/. Tento identifikátor URI rozlišuje malá a velká písmena pro vystavitele tokenu. Další informace o zjišťování OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	ID klienta OAuth 2.0 vytvořené pro aplikaci, která se používá k ověřování. Toto nastavení se vyžaduje k povolení ověřování účtu Microsoft. Dokumentace k účtu Microsoft OAuth: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	Tajný klíč klienta OAuth 2.0, který byl vytvořen pro aplikaci používanou k ověřování. Toto nastavení se vyžaduje k povolení ověřování účtu Microsoft. Dokumentace k účtu Microsoft OAuth: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName	string	Název nastavení aplikace obsahující tajný klíč klienta OAuth 2.0, který byl vytvořen pro aplikaci používanou k ověřování.
properties.microsoftAccountOAuthScopes	string[]	Obory OAuth 2.0, které budou požadovány v rámci ověřování účtu Microsoft. Toto nastavení je volitelné. Pokud není zadaný, použije se jako výchozí obor wl.basic. Dokumentace k rozsahům a oprávněním účtu Microsoft: https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	RuntimeVersion funkce ověřování / autorizace, která se používá pro aktuální aplikaci. Nastavení v této hodnotě může řídit chování určitých funkcí v modulu Ověřování / autorizace.
properties.tokenRefreshExtensionHours	number	Počet hodin po vypršení platnosti tokenu relace, kdy je možné token relace použít k volání rozhraní API pro aktualizaci tokenu. Výchozí hodnota je 72 hodin.
properties.tokenStoreEnabled	boolean	`true`trvale ukládat tokeny zabezpečení specifické pro platformu, které se získávají během toků přihlašování; v opačném případě . `false` Výchozí formát je `false`.
properties.twitterConsumerKey	string	Klíč příjemce OAuth 1.0a aplikace Twitter, která se používá pro přihlášení. Toto nastavení se vyžaduje k povolení přihlášení k Twitteru. Dokumentace k twitteru Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecret	string	Tajný kód uživatele OAuth 1.0a aplikace Twitter, který se používá pro přihlášení. Toto nastavení se vyžaduje k povolení přihlášení k Twitteru. Dokumentace k twitteru Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný kód uživatele OAuth 1.0a aplikace Twitter použité pro přihlášení.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	Akce, která se má provést, když se neověřený klient pokusí o přístup k aplikaci.
properties.validateIssuer	boolean	Získá hodnotu určující, zda vystavitel by měl být platná adresa URL https a být ověřen jako takový.

Odpovědi

Name	Typ	Description
200 OK	SiteAuthSettings	OK
Other Status Codes	DefaultErrorResponse	App Service chybovou odpověď.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Update Auth Settings

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings?api-version=2023-12-01

{
  "properties": {
    "enabled": true,
    "runtimeVersion": "~1",
    "unauthenticatedClientAction": "RedirectToLoginPage",
    "tokenStoreEnabled": true,
    "allowedExternalRedirectUrls": [
      "sitef6141.customdomain.net",
      "sitef6141.customdomain.info"
    ],
    "defaultProvider": "Google",
    "tokenRefreshExtensionHours": 120,
    "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings",
  "name": "authsettings",
  "type": "Microsoft.Web/sites/authsettings",
  "kind": "app",
  "properties": {
    "enabled": true,
    "runtimeVersion": "~1",
    "unauthenticatedClientAction": "RedirectToLoginPage",
    "tokenStoreEnabled": true,
    "allowedExternalRedirectUrls": [
      "sitef6141.customdomain.net",
      "sitef6141.customdomain.info"
    ],
    "defaultProvider": "Google",
    "tokenRefreshExtensionHours": 120,
    "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"
  }
}

Definice

Name	Description
BuiltInAuthenticationProvider	Výchozí zprostředkovatel ověřování, který se použije při konfiguraci více zprostředkovatelů. Toto nastavení je potřeba jenom v případě, že je nakonfigurovaných více zprostředkovatelů a neověřená akce klienta je nastavená na RedirectToLoginPage.
DefaultErrorResponse	App Service chybovou odpověď.
Details
Error	Model chyb.
SiteAuthSettings	Nastavení konfigurace pro funkci ověřování / autorizace Azure App Service.
UnauthenticatedClientAction	Akce, která se má provést, když se neověřený klient pokusí o přístup k aplikaci.

BuiltInAuthenticationProvider

Výchozí zprostředkovatel ověřování, který se použije při konfiguraci více zprostředkovatelů. Toto nastavení je potřeba jenom v případě, že je nakonfigurovaných více zprostředkovatelů a neověřená akce klienta je nastavená na RedirectToLoginPage.

Name	Typ	Description
AzureActiveDirectory	string
Facebook	string
Github	string
Google	string
MicrosoftAccount	string
Twitter	string

DefaultErrorResponse

App Service chybovou odpověď.

Name	Typ	Description
error	Error	Model chyb.

Details

Name	Typ	Description
code	string	Standardizovaný řetězec pro programovou identifikaci chyby
message	string	Podrobný popis chyby a informace o ladění
target	string	Podrobný popis chyby a informace o ladění

Error

Model chyb.

Name	Typ	Description
code	string	Standardizovaný řetězec pro programovou identifikaci chyby
details	Details[]	Podrobné chyby.
innererror	string	Další informace o chybě ladění
message	string	Podrobný popis chyby a informace o ladění
target	string	Podrobný popis chyby a informace o ladění

SiteAuthSettings

Nastavení konfigurace pro funkci ověřování / autorizace Azure App Service.

Name	Typ	Description
id	string	ID prostředku.
kind	string	Druh prostředku.
name	string	Název prostředku.
properties.aadClaimsAuthorization	string	Získá řetězec JSON obsahující nastavení seznamu ACL Azure AD.
properties.additionalLoginParams	string[]	Přihlašovací parametry, které se mají odeslat do koncového bodu autorizace OpenID Connect při přihlášení uživatele. Každý parametr musí být ve formátu key=value.
properties.allowedAudiences	string[]	Povolené hodnoty cílové skupiny ke zvážení při ověřování webových tokenů JSON vydaných službou Azure Active Directory Všimněte si, že hodnota `ClientID` se vždy považuje za povolenou cílovou skupinu bez ohledu na toto nastavení.
properties.allowedExternalRedirectUrls	string[]	Externí adresy URL, na které je možné přesměrovat v rámci přihlášení nebo odhlášení z aplikace. Všimněte si, že část adresy URL řetězce dotazu se ignoruje. Jedná se o upřesňující nastavení, které obvykle potřebují jenom back-endy aplikací pro Windows Store. Mějte na paměti, že adresy URL v rámci aktuální domény jsou vždy implicitně povolené.
properties.authFilePath	string	Cesta ke konfiguračnímu souboru obsahujícímu nastavení ověřování. Pokud je cesta relativní, základ bude kořenový adresář webu.
properties.clientId	string	ID klienta této aplikace předávající strany označované jako client_id. Toto nastavení se vyžaduje k povolení ověřování připojení OpenID pomocí Azure Active Directory nebo jiných poskytovatelů OpenID Connect třetích stran. Další informace o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret	string	Tajný klíč klienta této aplikace předávající strany (v Azure Active Directory se označuje také jako klíč). Toto nastavení je volitelné. Pokud není nakonfigurovaný žádný tajný klíč klienta, použije se k ověření koncových uživatelů tok implicitního ověřování OpenID Connect. Jinak se k ověřování koncových uživatelů používá tok autorizačního kódu OpenID Connect. Další informace o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecretCertificateThumbprint	string	Alternativou k tajnému klíči klienta je kryptografický otisk certifikátu, který se používá pro podpisové účely. Tato vlastnost funguje jako náhrada tajného klíče klienta. Je také nepovinný.
properties.clientSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný klíč klienta aplikace předávající strany.
properties.configVersion	string	ConfigVersion funkce ověřování / autorizace, která se používá pro aktuální aplikaci. Nastavení v této hodnotě může řídit chování řídicí roviny pro ověřování / autorizaci.
properties.defaultProvider	BuiltInAuthenticationProvider	Výchozí zprostředkovatel ověřování, který se použije při konfiguraci více zprostředkovatelů. Toto nastavení je potřeba jenom v případě, že je nakonfigurovaných více zprostředkovatelů a neověřená akce klienta je nastavená na RedirectToLoginPage.
properties.enabled	boolean	`true`pokud je pro aktuální aplikaci povolená funkce ověřování /autorizace; v opačném případě . `false`
properties.facebookAppId	string	ID aplikace Facebook použité k přihlášení. Toto nastavení se vyžaduje k povolení přihlášení Facebook. Dokumentace k přihlášení Facebook:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	Tajný kód aplikace Facebook použité k přihlášení Facebook. Toto nastavení se vyžaduje k povolení přihlášení Facebook. Dokumentace k přihlášení Facebook:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný kód aplikace použitý pro přihlášení Facebook.
properties.facebookOAuthScopes	string[]	Obory OAuth 2.0, které budou požadovány v rámci ověřování přihlášení Facebook. Toto nastavení je volitelné. Dokumentace k přihlášení Facebook:https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	ID klienta aplikace GitHubu, která se používá k přihlášení. Toto nastavení se vyžaduje pro povolení přihlášení ke GitHubu.
properties.gitHubClientSecret	string	Tajný klíč klienta aplikace GitHub, která se používá pro přihlášení ke GitHubu. Toto nastavení se vyžaduje pro povolení přihlášení ke GitHubu.
properties.gitHubClientSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný klíč klienta aplikace GitHub, který se používá pro přihlášení ke GitHubu.
properties.gitHubOAuthScopes	string[]	Obory OAuth 2.0, které se budou vyžadovat v rámci ověřování přihlášení Ke GitHubu. Toto nastavení je volitelné.
properties.googleClientId	string	ID klienta OpenID Connect pro webovou aplikaci Google. Toto nastavení se vyžaduje k povolení přihlášení googlem. Dokumentace ke službě Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	Tajný klíč klienta přidružený k webové aplikaci Google. Toto nastavení se vyžaduje k povolení přihlášení googlem. Dokumentace ke službě Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný klíč klienta přidružený k webové aplikaci Google.
properties.googleOAuthScopes	string[]	Obory OAuth 2.0, které budou požadovány v rámci ověřování Google Sign-In. Toto nastavení je volitelné. Pokud není zadaný, jako výchozí obory se použijí "openid", "profile" a "email". Dokumentace ke službě Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile	string	"true", pokud se má nastavení konfigurace ověřování číst ze souboru, "false", jinak "false".
properties.issuer	string	Identifikátor URI vystavitele OpenID Connect, který představuje entitu, která vydává přístupové tokeny pro tuto aplikaci. Při použití Azure Active Directory je tato hodnota identifikátorem URI tenanta adresáře, např. https://sts.windows.net/{tenant-guid}/. Tento identifikátor URI rozlišuje malá a velká písmena pro vystavitele tokenu. Další informace o zjišťování OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	ID klienta OAuth 2.0 vytvořené pro aplikaci, která se používá k ověřování. Toto nastavení se vyžaduje k povolení ověřování účtu Microsoft. Dokumentace k účtu Microsoft OAuth: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	Tajný klíč klienta OAuth 2.0, který byl vytvořen pro aplikaci používanou k ověřování. Toto nastavení se vyžaduje k povolení ověřování účtu Microsoft. Dokumentace k účtu Microsoft OAuth: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName	string	Název nastavení aplikace obsahující tajný klíč klienta OAuth 2.0, který byl vytvořen pro aplikaci používanou k ověřování.
properties.microsoftAccountOAuthScopes	string[]	Obory OAuth 2.0, které budou požadovány v rámci ověřování účtu Microsoft. Toto nastavení je volitelné. Pokud není zadaný, použije se jako výchozí obor wl.basic. Dokumentace k rozsahům a oprávněním účtu Microsoft: https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	RuntimeVersion funkce ověřování / autorizace, která se používá pro aktuální aplikaci. Nastavení v této hodnotě může řídit chování určitých funkcí v modulu Ověřování / autorizace.
properties.tokenRefreshExtensionHours	number	Počet hodin po vypršení platnosti tokenu relace, kdy je možné token relace použít k volání rozhraní API pro aktualizaci tokenu. Výchozí hodnota je 72 hodin.
properties.tokenStoreEnabled	boolean	`true`trvale ukládat tokeny zabezpečení specifické pro platformu, které se získávají během toků přihlašování; v opačném případě . `false` Výchozí formát je `false`.
properties.twitterConsumerKey	string	Klíč příjemce OAuth 1.0a aplikace Twitter, která se používá pro přihlášení. Toto nastavení se vyžaduje k povolení přihlášení k Twitteru. Dokumentace k twitteru Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecret	string	Tajný kód uživatele OAuth 1.0a aplikace Twitter, který se používá pro přihlášení. Toto nastavení se vyžaduje k povolení přihlášení k Twitteru. Dokumentace k twitteru Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný kód uživatele OAuth 1.0a aplikace Twitter použité pro přihlášení.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	Akce, která se má provést, když se neověřený klient pokusí o přístup k aplikaci.
properties.validateIssuer	boolean	Získá hodnotu určující, zda vystavitel by měl být platná adresa URL https a být ověřen jako takový.
type	string	Typ prostředku.

UnauthenticatedClientAction

Akce, která se má provést, když se neověřený klient pokusí o přístup k aplikaci.

Name	Typ	Description
AllowAnonymous	string
RedirectToLoginPage	string

Share via