Web Apps - Get Auth Settings Slot
Opis pobierania ustawień uwierzytelniania/autoryzacji aplikacji.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list?api-version=2023-12-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
name
|
path | True |
string |
Nazwa aplikacji. |
resource
|
path | True |
string |
Nazwa grupy zasobów, do której należy zasób. Wzorzec wyrażenia regularnego: |
slot
|
path | True |
string |
Nazwa miejsca wdrożenia. Jeśli miejsce nie zostanie określone, interfejs API pobierze ustawienia miejsca produkcyjnego. |
subscription
|
path | True |
string |
Identyfikator subskrypcji platformy Azure. Jest to ciąg w formacie GUID (np. 00000000-0000-0000-0000-0000-000000000000). |
api-version
|
query | True |
string |
Wersja interfejsu API |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
App Service odpowiedź na błąd. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Definicje
Nazwa | Opis |
---|---|
Built |
Domyślny dostawca uwierzytelniania używany podczas konfigurowania wielu dostawców. To ustawienie jest wymagane tylko wtedy, gdy skonfigurowano wielu dostawców, a akcja nieuwierzytelnionego klienta jest ustawiona na wartość "RedirectToLoginPage". |
Default |
App Service odpowiedź na błąd. |
Details | |
Error |
Model błędu. |
Site |
Ustawienia konfiguracji funkcji uwierzytelniania/autoryzacji Azure App Service. |
Unauthenticated |
Akcja do wykonania, gdy nieuwierzytelniony klient próbuje uzyskać dostęp do aplikacji. |
BuiltInAuthenticationProvider
Domyślny dostawca uwierzytelniania używany podczas konfigurowania wielu dostawców. To ustawienie jest wymagane tylko wtedy, gdy skonfigurowano wielu dostawców, a akcja nieuwierzytelnionego klienta jest ustawiona na wartość "RedirectToLoginPage".
Nazwa | Typ | Opis |
---|---|---|
AzureActiveDirectory |
string |
|
string |
||
Github |
string |
|
string |
||
MicrosoftAccount |
string |
|
string |
DefaultErrorResponse
App Service odpowiedź na błąd.
Nazwa | Typ | Opis |
---|---|---|
error |
Model błędu. |
Details
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Ustandaryzowany ciąg w celu programowego identyfikowania błędu. |
message |
string |
Szczegółowy opis błędu i informacje o debugowaniu. |
target |
string |
Szczegółowy opis błędu i informacje o debugowaniu. |
Error
Model błędu.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Ustandaryzowany ciąg w celu programowego identyfikowania błędu. |
details |
Details[] |
Szczegółowe błędy. |
innererror |
string |
Więcej informacji na temat debugowania błędu. |
message |
string |
Szczegółowy opis błędu i informacje o debugowaniu. |
target |
string |
Szczegółowy opis błędu i informacje o debugowaniu. |
SiteAuthSettings
Ustawienia konfiguracji funkcji uwierzytelniania/autoryzacji Azure App Service.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator zasobu. |
kind |
string |
Rodzaj zasobu. |
name |
string |
Nazwa zasobu. |
properties.aadClaimsAuthorization |
string |
Pobiera ciąg JSON zawierający ustawienia listy Acl Azure AD. |
properties.additionalLoginParams |
string[] |
Parametry logowania wysyłane do punktu końcowego autoryzacji OpenID Connect po zalogowaniu się użytkownika. Każdy parametr musi mieć postać "key=value". |
properties.allowedAudiences |
string[] |
Dozwolone wartości odbiorców do rozważenia podczas weryfikowania tokenów sieci Web JSON wystawionych przez usługę Azure Active Directory. Należy pamiętać, że |
properties.allowedExternalRedirectUrls |
string[] |
Zewnętrzne adresy URL, do których można przekierować w ramach logowania lub wylogowania się z aplikacji. Należy pamiętać, że część ciągu zapytania adresu URL jest ignorowana. Jest to zaawansowane ustawienie zwykle wymagane tylko przez zaplecza aplikacji ze Sklepu Windows. Należy pamiętać, że adresy URL w bieżącej domenie są zawsze dozwolone niejawnie. |
properties.authFilePath |
string |
Ścieżka pliku konfiguracji zawierającego ustawienia uwierzytelniania. Jeśli ścieżka jest względna, baza będzie katalog główny lokacji. |
properties.clientId |
string |
Identyfikator klienta tej aplikacji jednostki uzależnionej, znany jako client_id. To ustawienie jest wymagane do włączenia uwierzytelniania połączenia OpenID z usługą Azure Active Directory lub innymi dostawcami openID Connect innej firmy. Więcej informacji na temat programu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html |
properties.clientSecret |
string |
Klucz tajny klienta tej aplikacji jednostki uzależnionej (w usłudze Azure Active Directory jest to również nazywane kluczem). To ustawienie jest opcjonalne. Jeśli nie skonfigurowano wpisu tajnego klienta, przepływ niejawnego uwierzytelniania openID Connect jest używany do uwierzytelniania użytkowników końcowych. W przeciwnym razie przepływ kodu autoryzacji OpenID Connect jest używany do uwierzytelniania użytkowników końcowych. Więcej informacji na temat programu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html |
properties.clientSecretCertificateThumbprint |
string |
Alternatywą dla klucza tajnego klienta jest odcisk palca certyfikatu używanego do celów podpisywania. Ta właściwość działa jako zamiennik klucza tajnego klienta. Jest również opcjonalny. |
properties.clientSecretSettingName |
string |
Nazwa ustawienia aplikacji zawierająca wpis tajny klienta aplikacji jednostki uzależnionej. |
properties.configVersion |
string |
ConfigVersion funkcji Uwierzytelniania/autoryzacji używanej dla bieżącej aplikacji. Ustawienie w tej wartości może kontrolować zachowanie płaszczyzny sterowania dla uwierzytelniania/autoryzacji. |
properties.defaultProvider |
Domyślny dostawca uwierzytelniania używany podczas konfigurowania wielu dostawców. To ustawienie jest wymagane tylko wtedy, gdy skonfigurowano wielu dostawców, a akcja nieuwierzytelnionego klienta jest ustawiona na wartość "RedirectToLoginPage". |
|
properties.enabled |
boolean |
|
properties.facebookAppId |
string |
Identyfikator aplikacji Facebook używany do logowania. To ustawienie jest wymagane do włączenia logowania Facebook. dokumentacja logowania Facebook:https://developers.facebook.com/docs/facebook-login |
properties.facebookAppSecret |
string |
Wpis tajny aplikacji Facebook używany do logowania Facebook. To ustawienie jest wymagane do włączenia logowania Facebook. dokumentacja logowania Facebook:https://developers.facebook.com/docs/facebook-login |
properties.facebookAppSecretSettingName |
string |
Nazwa ustawienia aplikacji zawierająca wpis tajny aplikacji używany do logowania Facebook. |
properties.facebookOAuthScopes |
string[] |
Zakresy protokołu OAuth 2.0, które będą wymagane w ramach uwierzytelniania logowania Facebook. To ustawienie jest opcjonalne. dokumentacja logowania Facebook:https://developers.facebook.com/docs/facebook-login |
properties.gitHubClientId |
string |
Identyfikator klienta aplikacji GitHub używanej do logowania. To ustawienie jest wymagane do włączenia logowania do usługi GitHub |
properties.gitHubClientSecret |
string |
Klucz tajny klienta aplikacji GitHub używany do logowania w usłudze GitHub. To ustawienie jest wymagane do włączenia logowania w usłudze GitHub. |
properties.gitHubClientSecretSettingName |
string |
Nazwa ustawienia aplikacji zawierająca wpis tajny klienta aplikacji GitHub używanej do logowania w usłudze GitHub. |
properties.gitHubOAuthScopes |
string[] |
Zakresy protokołu OAuth 2.0, które będą wymagane w ramach uwierzytelniania logowania w usłudze GitHub. To ustawienie jest opcjonalne |
properties.googleClientId |
string |
Identyfikator klienta OpenID Connect dla aplikacji internetowej Google. To ustawienie jest wymagane do włączenia logowania Google. Dokumentacja usługi Google Sign-In: https://developers.google.com/identity/sign-in/web/ |
properties.googleClientSecret |
string |
Klucz tajny klienta skojarzony z aplikacją internetową Google. To ustawienie jest wymagane do włączenia logowania Google. Dokumentacja usługi Google Sign-In: https://developers.google.com/identity/sign-in/web/ |
properties.googleClientSecretSettingName |
string |
Nazwa ustawienia aplikacji zawierająca klucz tajny klienta skojarzony z aplikacją internetową Google. |
properties.googleOAuthScopes |
string[] |
Zakresy OAuth 2.0, które będą wymagane w ramach uwierzytelniania google Sign-In. To ustawienie jest opcjonalne. Jeśli nie określono, "openid", "profile" i "email" są używane jako zakresy domyślne. Dokumentacja usługi Google Sign-In: https://developers.google.com/identity/sign-in/web/ |
properties.isAuthFromFile |
string |
"true", jeśli ustawienia konfiguracji uwierzytelniania powinny być odczytywane z pliku, "false" w przeciwnym razie |
properties.issuer |
string |
Identyfikator URI wystawcy OpenID Connect reprezentujący jednostkę, która wystawia tokeny dostępu dla tej aplikacji. W przypadku korzystania z usługi Azure Active Directory ta wartość to identyfikator URI dzierżawy katalogu, np. https://sts.windows.net/{tenant-guid}/. Ten identyfikator URI jest identyfikatorem poufnym wielkości liter dla wystawcy tokenu. Więcej informacji na temat rozwiązania OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html |
properties.microsoftAccountClientId |
string |
Identyfikator klienta OAuth 2.0 utworzony dla aplikacji używanej do uwierzytelniania. To ustawienie jest wymagane do włączenia uwierzytelniania konta Microsoft. Dokumentacja protokołu OAuth konta Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm |
properties.microsoftAccountClientSecret |
string |
Klucz tajny klienta OAuth 2.0 utworzony dla aplikacji używanej do uwierzytelniania. To ustawienie jest wymagane do włączenia uwierzytelniania konta Microsoft. Dokumentacja protokołu OAuth konta Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm |
properties.microsoftAccountClientSecretSettingName |
string |
Nazwa ustawienia aplikacji zawierająca klucz tajny klienta OAuth 2.0, który został utworzony dla aplikacji używanej do uwierzytelniania. |
properties.microsoftAccountOAuthScopes |
string[] |
Zakresy protokołu OAuth 2.0, które będą wymagane w ramach uwierzytelniania konta Microsoft. To ustawienie jest opcjonalne. Jeśli nie zostanie określony, parametr "wl.basic" jest używany jako zakres domyślny. Dokumentacja zakresów i uprawnień konta Microsoft: https://msdn.microsoft.com/en-us/library/dn631845.aspx |
properties.runtimeVersion |
string |
RuntimeVersion funkcji uwierzytelniania/autoryzacji używanej dla bieżącej aplikacji. Ustawienie w tej wartości może kontrolować zachowanie niektórych funkcji w module Uwierzytelnianie/autoryzacja. |
properties.tokenRefreshExtensionHours |
number |
Liczba godzin po wygaśnięciu tokenu sesji, za pomocą którego można wywołać interfejs API odświeżania tokenu. Wartość domyślna to 72 godziny. |
properties.tokenStoreEnabled |
boolean |
|
properties.twitterConsumerKey |
string |
Klucz konsumenta OAuth 1.0a aplikacji Twitter używany do logowania. To ustawienie jest wymagane do włączenia logowania w usłudze Twitter. Dokumentacja usługi Twitter Sign-In: https://dev.twitter.com/web/sign-in |
properties.twitterConsumerSecret |
string |
Wpis tajny użytkownika OAuth 1.0a aplikacji Twitter używany do logowania. To ustawienie jest wymagane do włączenia logowania w usłudze Twitter. Dokumentacja usługi Twitter Sign-In: https://dev.twitter.com/web/sign-in |
properties.twitterConsumerSecretSettingName |
string |
Nazwa ustawienia aplikacji zawierająca klucz tajny użytkownika OAuth 1.0a aplikacji Twitter używany do logowania. |
properties.unauthenticatedClientAction |
Akcja do wykonania, gdy nieuwierzytelniony klient próbuje uzyskać dostęp do aplikacji. |
|
properties.validateIssuer |
boolean |
Pobiera wartość wskazującą, czy wystawca powinien być prawidłowym adresem URL HTTPS i być zweryfikowany jako taki. |
type |
string |
Typ zasobu. |
UnauthenticatedClientAction
Akcja do wykonania, gdy nieuwierzytelniony klient próbuje uzyskać dostęp do aplikacji.
Nazwa | Typ | Opis |
---|---|---|
AllowAnonymous |
string |
|
RedirectToLoginPage |
string |