Web Apps - Update Auth Settings

Referens

Service:: App Service

API Version:: 2023-12-01

Beskrivning för Uppdateringar inställningarna för autentisering/auktorisering som är associerade med webbappen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
name	path	True	string	Namnet på webbappen.
resourceGroupName	path	True	string	Namnet på resursgruppen som resursen tillhör. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	ditt prenumerations-ID för Azure Det här är en GUID-formaterad sträng (t.ex. 00000000-0000-0000-0000-0000000000000000).
api-version	query	True	string	API-version

Begärandetext

Name	Typ	Description
kind	string	Typ av resurs.
properties.aadClaimsAuthorization	string	Hämtar en JSON-sträng som innehåller inställningarna för Azure AD Acl.
properties.additionalLoginParams	string[]	Inloggningsparametrar som ska skickas till OpenID Connect-auktoriseringsslutpunkten när en användare loggar in. Varje parameter måste vara i formatet "key=value".
properties.allowedAudiences	string[]	Tillåtna målgruppsvärden att tänka på när du verifierar JSON-webbtoken som utfärdats av Azure Active Directory. Observera att värdet `ClientID` alltid betraktas som en tillåten målgrupp, oavsett den här inställningen.
properties.allowedExternalRedirectUrls	string[]	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.
properties.authFilePath	string	Sökvägen till konfigurationsfilen som innehåller autentiseringsinställningar. Om sökvägen är relativ kommer platsens rotkatalog att baseras.
properties.clientId	string	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
properties.clientSecret	string	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
properties.clientSecretCertificateThumbprint	string	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.
properties.clientSecretSettingName	string	Namnet på appinställningen som innehåller klienthemligheten för det förlitande partprogrammet.
properties.configVersion	string	ConfigVersion för funktionen Autentisering/auktorisering som används för den aktuella appen. Inställningen i det här värdet kan styra kontrollplanets beteende för autentisering/auktorisering.
properties.defaultProvider	BuiltInAuthenticationProvider	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".
properties.enabled	boolean	`true`om funktionen Autentisering/auktorisering är aktiverad för den aktuella appen; annars . `false`
properties.facebookAppId	string	App-ID för den Facebook app som används för inloggning. Den här inställningen krävs för att aktivera Facebook Inloggning. Facebook inloggningsdokumentation:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	Apphemligheten för den Facebook app som används för Facebook inloggning. Den här inställningen krävs för att aktivera Facebook Inloggning. Facebook inloggningsdokumentation:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	Namnet på appinställningen som innehåller apphemligheten som används för Facebook Inloggning.
properties.facebookOAuthScopes	string[]	OAuth 2.0-omfång som begärs som en del av Facebook inloggningsautentisering. Den här inställningen är valfri. Facebook inloggningsdokumentation:https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	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
properties.gitHubClientSecret	string	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.
properties.gitHubClientSecretSettingName	string	Namnet på appinställningen som innehåller klienthemligheten för Github-appen som används för GitHub-inloggning.
properties.gitHubOAuthScopes	string[]	OAuth 2.0-omfång som begärs som en del av GitHub-inloggningsautentisering. Den här inställningen är valfri
properties.googleClientId	string	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/
properties.googleClientSecret	string	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/
properties.googleClientSecretSettingName	string	Appinställningsnamnet som innehåller klienthemligheten som är associerad med Google-webbappen.
properties.googleOAuthScopes	string[]	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/
properties.isAuthFromFile	string	"sant" om autentiseringskonfigurationsinställningarna ska läsas från en fil, annars "falskt"
properties.issuer	string	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-identifiering: http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	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
properties.microsoftAccountClientSecret	string	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
properties.microsoftAccountClientSecretSettingName	string	Appinställningsnamnet som innehåller OAuth 2.0-klienthemligheten som skapades för appen som används för autentisering.
properties.microsoftAccountOAuthScopes	string[]	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
properties.runtimeVersion	string	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.
properties.tokenRefreshExtensionHours	number	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.
properties.tokenStoreEnabled	boolean	`true`att durably lagrar plattformsspecifika säkerhetstoken som hämtas under inloggningsflöden; annars . `false` Standardvärdet är `false`.
properties.twitterConsumerKey	string	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
properties.twitterConsumerSecret	string	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
properties.twitterConsumerSecretSettingName	string	Appinställningsnamnet som innehåller OAuth 1.0a-konsumenthemligheten för Twitter-programmet som används för inloggning.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	Åtgärden som ska vidtas när en oautentiserad klient försöker komma åt appen.
properties.validateIssuer	boolean	Hämtar ett värde som anger om utfärdaren ska vara en giltig HTTPS-URL och verifieras som sådan.

Svar

Name	Typ	Description
200 OK	SiteAuthSettings	OK
Other Status Codes	DefaultErrorResponse	App Service felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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"
  }
}

Definitioner

Name	Description
BuiltInAuthenticationProvider	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".
DefaultErrorResponse	App Service felsvar.
Details
Error	Felmodell.
SiteAuthSettings	Konfigurationsinställningar för funktionen Azure App Service-autentisering/auktorisering.
UnauthenticatedClientAction	Åtgärden som ska vidtas när en oautentiserad klient försöker komma åt appen.

BuiltInAuthenticationProvider

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".

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

DefaultErrorResponse

App Service felsvar.

Name	Typ	Description
error	Error	Felmodell.

Details

Name	Typ	Description
code	string	Standardiserad sträng för att programmässigt identifiera felet.
message	string	Detaljerad felbeskrivning och felsökningsinformation.
target	string	Detaljerad felbeskrivning och felsökningsinformation.

Error

Felmodell.

Name	Typ	Description
code	string	Standardiserad sträng för att programmässigt identifiera felet.
details	Details[]	Detaljerade fel.
innererror	string	Mer information om felsökningsfel.
message	string	Detaljerad felbeskrivning och felsökningsinformation.
target	string	Detaljerad felbeskrivning och felsökningsinformation.

SiteAuthSettings

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

Name	Typ	Description
id	string	Resurs-ID.
kind	string	Typ av resurs.
name	string	Resursnamn.
properties.aadClaimsAuthorization	string	Hämtar en JSON-sträng som innehåller inställningarna för Azure AD Acl.
properties.additionalLoginParams	string[]	Inloggningsparametrar som ska skickas till OpenID Connect-auktoriseringsslutpunkten när en användare loggar in. Varje parameter måste vara i formatet "key=value".
properties.allowedAudiences	string[]	Tillåtna målgruppsvärden att tänka på när du verifierar JSON-webbtoken som utfärdats av Azure Active Directory. Observera att värdet `ClientID` alltid betraktas som en tillåten målgrupp, oavsett den här inställningen.
properties.allowedExternalRedirectUrls	string[]	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.
properties.authFilePath	string	Sökvägen till konfigurationsfilen som innehåller autentiseringsinställningar. Om sökvägen är relativ kommer platsens rotkatalog att baseras.
properties.clientId	string	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
properties.clientSecret	string	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
properties.clientSecretCertificateThumbprint	string	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.
properties.clientSecretSettingName	string	Namnet på appinställningen som innehåller klienthemligheten för det förlitande partprogrammet.
properties.configVersion	string	ConfigVersion för funktionen Autentisering/auktorisering som används för den aktuella appen. Inställningen i det här värdet kan styra kontrollplanets beteende för autentisering/auktorisering.
properties.defaultProvider	BuiltInAuthenticationProvider	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".
properties.enabled	boolean	`true`om funktionen Autentisering/auktorisering är aktiverad för den aktuella appen; annars . `false`
properties.facebookAppId	string	App-ID för den Facebook app som används för inloggning. Den här inställningen krävs för att aktivera Facebook Inloggning. Facebook inloggningsdokumentation:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	Apphemligheten för den Facebook app som används för Facebook inloggning. Den här inställningen krävs för att aktivera Facebook Inloggning. Facebook inloggningsdokumentation:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	Namnet på appinställningen som innehåller apphemligheten som används för Facebook Inloggning.
properties.facebookOAuthScopes	string[]	OAuth 2.0-omfång som begärs som en del av Facebook inloggningsautentisering. Den här inställningen är valfri. Facebook inloggningsdokumentation:https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	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
properties.gitHubClientSecret	string	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.
properties.gitHubClientSecretSettingName	string	Namnet på appinställningen som innehåller klienthemligheten för Github-appen som används för GitHub-inloggning.
properties.gitHubOAuthScopes	string[]	OAuth 2.0-omfång som begärs som en del av GitHub-inloggningsautentisering. Den här inställningen är valfri
properties.googleClientId	string	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/
properties.googleClientSecret	string	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/
properties.googleClientSecretSettingName	string	Appinställningsnamnet som innehåller klienthemligheten som är associerad med Google-webbappen.
properties.googleOAuthScopes	string[]	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/
properties.isAuthFromFile	string	"sant" om autentiseringskonfigurationsinställningarna ska läsas från en fil, annars "falskt"
properties.issuer	string	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-identifiering: http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	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
properties.microsoftAccountClientSecret	string	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
properties.microsoftAccountClientSecretSettingName	string	Appinställningsnamnet som innehåller OAuth 2.0-klienthemligheten som skapades för appen som används för autentisering.
properties.microsoftAccountOAuthScopes	string[]	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
properties.runtimeVersion	string	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.
properties.tokenRefreshExtensionHours	number	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.
properties.tokenStoreEnabled	boolean	`true`att durably lagrar plattformsspecifika säkerhetstoken som hämtas under inloggningsflöden; annars . `false` Standardvärdet är `false`.
properties.twitterConsumerKey	string	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
properties.twitterConsumerSecret	string	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
properties.twitterConsumerSecretSettingName	string	Appinställningsnamnet som innehåller OAuth 1.0a-konsumenthemligheten för Twitter-programmet som används för inloggning.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	Åtgärden som ska vidtas när en oautentiserad klient försöker komma åt appen.
properties.validateIssuer	boolean	Hämtar ett värde som anger om utfärdaren ska vara en giltig HTTPS-URL och verifieras som sådan.
type	string	Resurstyp.

UnauthenticatedClientAction

Åtgärden som ska vidtas när en oautentiserad klient försöker komma åt appen.

Name	Typ	Description
AllowAnonymous	string
RedirectToLoginPage	string

Dela via