Web Apps - Get Auth Settings
Beschrijving voor Het verkrijgen van de verificatie-/autorisatie-instellingen van een app.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list?api-version=2024-04-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
name
|
path | True |
string |
Naam van de app. |
resource
|
path | True |
string |
Naam van de resourcegroep waartoe de resource behoort. Regex-patroon: |
subscription
|
path | True |
string |
Uw Azure-abonnements-id. Dit is een tekenreeks met GUID-indeling (bijvoorbeeld 00000000-0000-0000-0000-000000000000000). |
api-version
|
query | True |
string |
API-versie |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Foutreactie van App Service. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
List Auth Settings
Voorbeeldaanvraag
Voorbeeldrespons
{
"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 |
---|---|
Built |
De standaardverificatieprovider die moet worden gebruikt wanneer meerdere providers zijn geconfigureerd. Deze instelling is alleen nodig als meerdere providers zijn geconfigureerd en de niet-geverifieerde clientactie is ingesteld op RedirectToLoginPage. |
Default |
Foutreactie van App Service. |
Details | |
Error |
Foutmodel. |
Site |
Configuratie-instellingen voor de functie Verificatie/autorisatie van Azure App Service. |
Unauthenticated |
De actie die moet worden uitgevoerd wanneer een niet-geverifieerde client probeert toegang te krijgen tot de app. |
BuiltInAuthenticationProvider
De standaardverificatieprovider die moet worden gebruikt wanneer meerdere providers zijn geconfigureerd. Deze instelling is alleen nodig als meerdere providers zijn geconfigureerd en de niet-geverifieerde clientactie is ingesteld op RedirectToLoginPage.
Waarde | Description |
---|---|
AzureActiveDirectory | |
Github | |
MicrosoftAccount | |
DefaultErrorResponse
Foutreactie van App Service.
Name | Type | Description |
---|---|---|
error |
Foutmodel. |
Details
Name | Type | Description |
---|---|---|
code |
string |
Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren. |
message |
string |
Gedetailleerde foutbeschrijving en foutopsporingsgegevens. |
target |
string |
Gedetailleerde foutbeschrijving en foutopsporingsgegevens. |
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 foutopsporingsgegevens. |
target |
string |
Gedetailleerde foutbeschrijving en foutopsporingsgegevens. |
SiteAuthSettings
Configuratie-instellingen voor de functie Verificatie/autorisatie van Azure App Service.
Name | Type | Description |
---|---|---|
id |
string |
Resource-id. |
kind |
string |
Soort resource. |
name |
string |
Resourcenaam. |
properties.aadClaimsAuthorization |
string |
Hiermee haalt u een JSON-tekenreeks op die de Azure AD-Acl-instellingen bevat. |
properties.additionalLoginParams |
string[] |
Aanmeldingsparameters voor het verzenden 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 |
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 querytekenreeksgedeelte van de URL wordt genegeerd. Dit is een geavanceerde instelling die doorgaans alleen nodig is voor back-ends van Windows Store-toepassingen. Houd er rekening mee dat URL's binnen het huidige domein altijd impliciet zijn toegestaan. |
properties.authFilePath |
string |
Het pad van het configuratiebestand met verificatie-instellingen. Als het pad relatief is, wordt de basismap van de site 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-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, dat is 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 functie Verificatie/Autorisatie die wordt gebruikt voor de huidige app. De instelling in deze waarde kan het gedrag van het besturingsvlak voor verificatie/autorisatie bepalen. |
properties.defaultProvider |
De standaardverificatieprovider die moet worden gebruikt wanneer meerdere providers zijn geconfigureerd. Deze instelling is alleen nodig als meerdere providers zijn geconfigureerd en de niet-geverifieerde clientactie is ingesteld op RedirectToLoginPage. |
|
properties.enabled |
boolean |
|
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. Aanmeldingsdocumentatie voor Facebook: 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. Aanmeldingsdocumentatie voor Facebook: 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-aanmelding. |
properties.facebookOAuthScopes |
string[] |
De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van Facebook-aanmeldingsverificatie. Deze instelling is optioneel. Aanmeldingsdocumentatie voor Facebook: 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 Login. 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 Google-aanmelding. 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 Google-aanmelding. 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', 'profiel' en 'e-mail' gebruikt als standaardbereiken. 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 onwaar |
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 directorytenant, bijvoorbeeld |
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 functie Verificatie/Autorisatie 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 API voor het vernieuwen van tokens aan te roepen. De standaardwaarde is 72 uur. |
properties.tokenStoreEnabled |
boolean |
|
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 |
De actie die moet worden uitgevoerd wanneer een niet-geverifieerde client probeert toegang 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 probeert toegang te krijgen tot de app.
Waarde | Description |
---|---|
AllowAnonymous | |
RedirectToLoginPage |