Web Apps - Update Auth Settings

Referentie

Service:: App Service

API Version:: 2023-12-01

Beschrijving voor Updates de verificatie-/autorisatie-instellingen die zijn gekoppeld aan de web-app.

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

URI-parameters

Name	In	Vereist	Type	Description
name	path	True	string	Naam van web-app.
resourceGroupName	path	True	string	Naam van de resourcegroep waartoe de resource behoort. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Uw Azure-abonnements-id. Dit is een tekenreeks met GUID-indeling (bijvoorbeeld 000000000-0000-0000-0000-000000000000).
api-version	query	True	string	API-versie

Aanvraagbody

Name	Type	Description
kind	string	Soort resource.
properties.aadClaimsAuthorization	string	Hiermee haalt u een JSON-tekenreeks op met de Azure AD ACL-instellingen.
properties.additionalLoginParams	string[]	Aanmeldingsparameters die moeten worden verzonden naar het OpenID Connect-autorisatie-eindpunt wanneer een gebruiker zich aanmeldt. Elke parameter moet de notatie 'key=value' hebben.
properties.allowedAudiences	string[]	Toegestane doelgroepwaarden om rekening mee te houden bij het valideren van JSON-webtokens die zijn uitgegeven door Azure Active Directory. Houd er rekening mee dat de `ClientID` waarde altijd wordt beschouwd als een toegestane doelgroep, ongeacht deze instelling.
properties.allowedExternalRedirectUrls	string[]	Externe URL's waarnaar kan worden omgeleid als onderdeel van het aanmelden of afmelden bij de app. Houd er rekening mee dat het queryreeksgedeelte van de URL wordt genegeerd. Dit is een geavanceerde instelling die doorgaans alleen nodig is voor back-ends van Windows Store-toepassingen. URL's binnen het huidige domein zijn altijd impliciet toegestaan.
properties.authFilePath	string	Het pad van het configuratiebestand met verificatie-instellingen. Als het pad relatief is, wordt de hoofdmap van de site als basis gebruikt.
properties.clientId	string	De client-id van deze relying party-toepassing, bekend als de client_id. Deze instelling is vereist voor het inschakelen van OpenID-verbindingsverificatie met Azure Active Directory of andere OpenID Connect-providers van derden. Meer informatie over OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret	string	Het clientgeheim van deze relying party-toepassing (in Azure Active Directory wordt dit ook wel de sleutel genoemd). Deze instelling is optioneel. Als er geen clientgeheim is geconfigureerd, wordt de impliciete verificatiestroom van OpenID Connect gebruikt om eindgebruikers te verifiëren. Anders wordt de OpenID Connect-autorisatiecodestroom gebruikt om eindgebruikers te verifiëren. Meer informatie over OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecretCertificateThumbprint	string	Een alternatief voor het clientgeheim, namelijk de vingerafdruk van een certificaat dat wordt gebruikt voor ondertekeningsdoeleinden. Deze eigenschap fungeert als vervanging voor het clientgeheim. Het is ook optioneel.
properties.clientSecretSettingName	string	De naam van de app-instelling die het clientgeheim van de relying party-toepassing bevat.
properties.configVersion	string	De ConfigVersion van de verificatie-/autorisatiefunctie die wordt gebruikt voor de huidige app. De instelling in deze waarde kan het gedrag van het besturingsvlak voor verificatie/autorisatie bepalen.
properties.defaultProvider	BuiltInAuthenticationProvider	De standaardverificatieprovider die moet worden gebruikt wanneer meerdere providers zijn geconfigureerd. Deze instelling is alleen nodig als er meerdere providers zijn geconfigureerd en de niet-geverifieerde clientactie is ingesteld op 'RedirectToLoginPage'.
properties.enabled	boolean	`true` als de functie Verificatie/Autorisatie is ingeschakeld voor de huidige app; anders, `false`.
properties.facebookAppId	string	De app-id van de Facebook app die wordt gebruikt voor aanmelding. Deze instelling is vereist voor het inschakelen van Facebook Aanmelding. Facebook Login-documentatie:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	Het app-geheim van de Facebook app die wordt gebruikt voor Facebook aanmelding. Deze instelling is vereist voor het inschakelen van Facebook Aanmelding. Facebook Login-documentatie:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	De naam van de app-instelling die het app-geheim bevat dat wordt gebruikt voor Facebook Aanmelden.
properties.facebookOAuthScopes	string[]	De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van Facebook aanmeldingsverificatie. Deze instelling is optioneel. Facebook Login-documentatie:https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	De client-id van de GitHub-app die wordt gebruikt voor aanmelding. Deze instelling is vereist voor het inschakelen van Github-aanmelding
properties.gitHubClientSecret	string	Het clientgeheim van de GitHub-app die wordt gebruikt voor github-aanmelding. Deze instelling is vereist voor het inschakelen van Github-aanmelding.
properties.gitHubClientSecretSettingName	string	De naam van de app-instelling die het clientgeheim bevat van de Github-app die wordt gebruikt voor GitHub-aanmelding.
properties.gitHubOAuthScopes	string[]	De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van GitHub-aanmeldingsverificatie. Deze instelling is optioneel
properties.googleClientId	string	De OpenID Connect-client-id voor de Google-webtoepassing. Deze instelling is vereist voor het inschakelen van Aanmelden bij Google. Documentatie voor Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	Het clientgeheim dat is gekoppeld aan de Google-webtoepassing. Deze instelling is vereist voor het inschakelen van Aanmelden bij Google. Documentatie voor Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	De naam van de app-instelling die het clientgeheim bevat dat is gekoppeld aan de Google-webtoepassing.
properties.googleOAuthScopes	string[]	De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van Google Sign-In-verificatie. Deze instelling is optioneel. Als u dit niet opgeeft, worden 'openid', 'profiel' en 'e-mail' als standaardbereiken gebruikt. Documentatie voor Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile	string	'true' als de configuratie-instellingen voor verificatie moeten worden gelezen uit een bestand, anders 'false'
properties.issuer	string	De OpenID Connect Issuer-URI die de entiteit vertegenwoordigt die toegangstokens voor deze toepassing uitgeeft. Wanneer u Azure Active Directory gebruikt, is deze waarde de URI van de maptenant, bijvoorbeeld https://sts.windows.net/{tenant-guid}/. Deze URI is een hoofdlettergevoelige id voor de tokenverlener. Meer informatie over OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	De OAuth 2.0-client-id die is gemaakt voor de app die wordt gebruikt voor verificatie. Deze instelling is vereist voor het inschakelen van Microsoft-accountverificatie. OAuth-documentatie voor Microsoft-account: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	Het OAuth 2.0-clientgeheim dat is gemaakt voor de app die wordt gebruikt voor verificatie. Deze instelling is vereist voor het inschakelen van Microsoft-accountverificatie. OAuth-documentatie voor Microsoft-account: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName	string	De naam van de app-instelling met het OAuth 2.0-clientgeheim dat is gemaakt voor de app die wordt gebruikt voor verificatie.
properties.microsoftAccountOAuthScopes	string[]	De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van microsoft-accountverificatie. Deze instelling is optioneel. Als dit niet is opgegeven, wordt 'wl.basic' gebruikt als het standaardbereik. Documentatie voor Microsoft-accountbereiken en -machtigingen: https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	De RuntimeVersion van de verificatie-/autorisatiefunctie die wordt gebruikt voor de huidige app. De instelling in deze waarde kan het gedrag van bepaalde functies in de module Verificatie/autorisatie bepalen.
properties.tokenRefreshExtensionHours	number	Het aantal uren na het verlopen van het sessietoken dat een sessietoken kan worden gebruikt om de tokenvernieuwings-API aan te roepen. Standaard is dit 72 uur.
properties.tokenStoreEnabled	boolean	`true` om platformspecifieke beveiligingstokens die tijdens aanmeldingsstromen worden verkregen, duurzaam op te slaan; anders, `false`. De standaardwaarde is `false`.
properties.twitterConsumerKey	string	De OAuth 1.0a-consumentensleutel van de Twitter-toepassing die wordt gebruikt voor aanmelding. Deze instelling is vereist voor het inschakelen van Twitter-aanmelding. Documentatie voor Twitter Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecret	string	Het OAuth 1.0a-consumentengeheim van de Twitter-toepassing die wordt gebruikt voor aanmelding. Deze instelling is vereist voor het inschakelen van Twitter-aanmelding. Documentatie voor Twitter Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecretSettingName	string	De naam van de app-instelling die het OAuth 1.0a-consumentengeheim bevat van de Twitter-toepassing die wordt gebruikt voor aanmelding.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	De actie die moet worden uitgevoerd wanneer een niet-geverifieerde client toegang probeert te krijgen tot de app.
properties.validateIssuer	boolean	Hiermee wordt een waarde opgehaald die aangeeft of de verlener een geldige HTTPS-URL moet zijn en als zodanig moet worden gevalideerd.

Antwoorden

Name	Type	Description
200 OK	SiteAuthSettings	OK
Other Status Codes	DefaultErrorResponse	App Service foutreactie.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

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

Definities

Name	Description
BuiltInAuthenticationProvider	De standaardverificatieprovider die moet worden gebruikt wanneer meerdere providers zijn geconfigureerd. Deze instelling is alleen nodig als er meerdere providers zijn geconfigureerd en de niet-geverifieerde clientactie is ingesteld op 'RedirectToLoginPage'.
DefaultErrorResponse	App Service foutreactie.
Details
Error	Foutmodel.
SiteAuthSettings	Configuratie-instellingen voor de functie Azure App Service Verificatie/Autorisatie.
UnauthenticatedClientAction	De actie die moet worden uitgevoerd wanneer een niet-geverifieerde client toegang probeert te krijgen tot de app.

BuiltInAuthenticationProvider

De standaardverificatieprovider die moet worden gebruikt wanneer meerdere providers zijn geconfigureerd. Deze instelling is alleen nodig als er meerdere providers zijn geconfigureerd en de niet-geverifieerde clientactie is ingesteld op 'RedirectToLoginPage'.

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

DefaultErrorResponse

App Service foutreactie.

Name	Type	Description
error	Error	Foutmodel.

Details

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.

Error

Foutmodel.

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
details	Details[]	Gedetailleerde fouten.
innererror	string	Meer informatie over foutopsporing.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.

SiteAuthSettings

Configuratie-instellingen voor de functie Azure App Service Verificatie/Autorisatie.

Name	Type	Description
id	string	Resource-id.
kind	string	Soort resource.
name	string	Resourcenaam.
properties.aadClaimsAuthorization	string	Hiermee haalt u een JSON-tekenreeks op met de Azure AD ACL-instellingen.
properties.additionalLoginParams	string[]	Aanmeldingsparameters die moeten worden verzonden naar het OpenID Connect-autorisatie-eindpunt wanneer een gebruiker zich aanmeldt. Elke parameter moet de notatie 'key=value' hebben.
properties.allowedAudiences	string[]	Toegestane doelgroepwaarden waarmee rekening moet worden gehouden bij het valideren van JSON-webtokens die zijn uitgegeven door Azure Active Directory. Houd er rekening mee dat de `ClientID` waarde altijd wordt beschouwd als een toegestane doelgroep, ongeacht deze instelling.
properties.allowedExternalRedirectUrls	string[]	Externe URL's waarnaar kan worden omgeleid als onderdeel van het aanmelden of afmelden bij de app. Houd er rekening mee dat het queryreeksgedeelte van de URL wordt genegeerd. Dit is een geavanceerde instelling die doorgaans alleen nodig is voor back-ends van Windows Store-toepassingen. Url's binnen het huidige domein zijn altijd impliciet toegestaan.
properties.authFilePath	string	Het pad van het configuratiebestand met verificatie-instellingen. Als het pad relatief is, wordt de hoofdmap van de site als basis gebruikt.
properties.clientId	string	De client-id van deze relying party-toepassing, ook wel de client_id genoemd. Deze instelling is vereist voor het inschakelen van OpenID Connection-verificatie met Azure Active Directory of andere OpenID Connect-providers van derden. Meer informatie over OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret	string	Het clientgeheim van deze relying party-toepassing (in Azure Active Directory wordt dit ook wel de sleutel genoemd). Deze instelling is optioneel. Als er geen clientgeheim is geconfigureerd, wordt de impliciete verificatiestroom van OpenID Connect gebruikt om eindgebruikers te verifiëren. Anders wordt de OpenID Connect-autorisatiecodestroom gebruikt om eindgebruikers te verifiëren. Meer informatie over OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecretCertificateThumbprint	string	Een alternatief voor het clientgeheim, namelijk de vingerafdruk van een certificaat dat wordt gebruikt voor ondertekeningsdoeleinden. Deze eigenschap fungeert als vervanging voor het clientgeheim. Het is ook optioneel.
properties.clientSecretSettingName	string	De naam van de app-instelling die het clientgeheim van de relying party-toepassing bevat.
properties.configVersion	string	De configuratieversie van de verificatie-/autorisatiefunctie die wordt gebruikt voor de huidige app. De instelling in deze waarde kan het gedrag van het besturingsvlak voor verificatie/autorisatie bepalen.
properties.defaultProvider	BuiltInAuthenticationProvider	De standaardverificatieprovider die moet worden gebruikt wanneer meerdere providers zijn geconfigureerd. Deze instelling is alleen nodig als er meerdere providers zijn geconfigureerd en de niet-geverifieerde clientactie is ingesteld op 'RedirectToLoginPage'.
properties.enabled	boolean	`true` als de functie Verificatie/Autorisatie is ingeschakeld voor de huidige app; anders, `false`.
properties.facebookAppId	string	De app-id van de Facebook-app die wordt gebruikt voor aanmelding. Deze instelling is vereist voor het inschakelen van Facebook Aanmelding. Facebook aanmeldingsdocumentatie:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	Het app-geheim van de Facebook app die wordt gebruikt voor Facebook aanmelding. Deze instelling is vereist voor het inschakelen van Facebook Aanmelding. Facebook aanmeldingsdocumentatie:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	De naam van de app-instelling die het app-geheim bevat dat wordt gebruikt voor Facebook Aanmelden.
properties.facebookOAuthScopes	string[]	De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van Facebook aanmeldingsverificatie. Deze instelling is optioneel. Facebook aanmeldingsdocumentatie:https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	De client-id van de GitHub-app die wordt gebruikt voor aanmelding. Deze instelling is vereist voor het inschakelen van GitHub-aanmelding
properties.gitHubClientSecret	string	Het clientgeheim van de GitHub-app die wordt gebruikt voor Github-aanmelding. Deze instelling is vereist voor het inschakelen van Github-aanmelding.
properties.gitHubClientSecretSettingName	string	De naam van de app-instelling die het clientgeheim bevat van de Github-app die wordt gebruikt voor GitHub-aanmelding.
properties.gitHubOAuthScopes	string[]	De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van GitHub-aanmeldingsverificatie. Deze instelling is optioneel
properties.googleClientId	string	De OpenID Connect-client-id voor de Google-webtoepassing. Deze instelling is vereist voor het inschakelen van Aanmelden bij Google. Documentatie voor Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	Het clientgeheim dat is gekoppeld aan de Google-webtoepassing. Deze instelling is vereist voor het inschakelen van Aanmelden bij Google. Documentatie voor Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	De naam van de app-instelling die het clientgeheim bevat dat is gekoppeld aan de Google-webtoepassing.
properties.googleOAuthScopes	string[]	De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van Google Sign-In-verificatie. Deze instelling is optioneel. Als dit niet is opgegeven, worden 'openid', 'profile' en 'email' als standaardbereiken gebruikt. Documentatie voor Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile	string	'true' als de configuratie-instellingen voor verificatie moeten worden gelezen uit een bestand, anders 'false'
properties.issuer	string	De OpenID Connect Issuer-URI die de entiteit vertegenwoordigt die toegangstokens voor deze toepassing uitgeeft. Wanneer u Azure Active Directory gebruikt, is deze waarde de URI van de maptenant, bijvoorbeeld https://sts.windows.net/{tenant-guid}/. Deze URI is een hoofdlettergevoelige id voor de tokenverlener. Meer informatie over OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	De OAuth 2.0-client-id die is gemaakt voor de app die wordt gebruikt voor verificatie. Deze instelling is vereist voor het inschakelen van Microsoft-accountverificatie. OAuth-documentatie voor Microsoft-account: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	Het OAuth 2.0-clientgeheim dat is gemaakt voor de app die wordt gebruikt voor verificatie. Deze instelling is vereist voor het inschakelen van Microsoft-accountverificatie. OAuth-documentatie voor Microsoft-account: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName	string	De naam van de app-instelling die het OAuth 2.0-clientgeheim bevat dat is gemaakt voor de app die wordt gebruikt voor verificatie.
properties.microsoftAccountOAuthScopes	string[]	De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van microsoft-accountverificatie. Deze instelling is optioneel. Als dit niet is opgegeven, wordt 'wl.basic' gebruikt als het standaardbereik. Documentatie over Microsoft-accountbereiken en -machtigingen: https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	De RuntimeVersion van de verificatie-/autorisatiefunctie die wordt gebruikt voor de huidige app. De instelling in deze waarde kan het gedrag van bepaalde functies in de module Verificatie/autorisatie bepalen.
properties.tokenRefreshExtensionHours	number	Het aantal uren na het verlopen van het sessietoken dat een sessietoken kan worden gebruikt om de vernieuwings-API van het token aan te roepen. Standaard is dit 72 uur.
properties.tokenStoreEnabled	boolean	`true` om platformspecifieke beveiligingstokens die tijdens aanmeldingsstromen worden verkregen, duurzaam op te slaan; anders, `false`. De standaardwaarde is `false`.
properties.twitterConsumerKey	string	De OAuth 1.0a-consumentensleutel van de Twitter-toepassing die wordt gebruikt voor aanmelding. Deze instelling is vereist voor het inschakelen van Twitter-aanmelding. Documentatie voor Twitter Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecret	string	Het OAuth 1.0a-consumentengeheim van de Twitter-toepassing die wordt gebruikt voor aanmelding. Deze instelling is vereist voor het inschakelen van Twitter-aanmelding. Documentatie voor Twitter Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecretSettingName	string	De naam van de app-instelling die het OAuth 1.0a-consumentengeheim bevat van de Twitter-toepassing die wordt gebruikt voor aanmelding.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	De actie die moet worden uitgevoerd wanneer een niet-geverifieerde client toegang probeert te krijgen tot de app.
properties.validateIssuer	boolean	Hiermee wordt een waarde opgehaald die aangeeft of de verlener een geldige HTTPS-URL moet zijn en als zodanig moet worden gevalideerd.
type	string	Resourcetype.

UnauthenticatedClientAction

De actie die moet worden uitgevoerd wanneer een niet-geverifieerde client toegang probeert te krijgen tot de app.

Name	Type	Description
AllowAnonymous	string
RedirectToLoginPage	string