SiteAuthSettings interface

Paket:

@azure/arm-appservice

Konfigurationseinstellungen für das Azure App Service-Authentifizierungs-/Autorisierungsfeature.

Extends

ProxyOnlyResource

Eigenschaften

aadClaimsAuthorization	Ruft eine JSON-Zeichenfolge ab, die die Azure AD-Acl-Einstellungen enthält.
additionalLoginParams	Anmeldeparameter, die an den OpenID Connect-Autorisierungsendpunkt gesendet werden sollen, wenn sich ein Benutzer anmeldet. Jeder Parameter muss sich im Format "key=value" befinden.
allowedAudiences	Zulässige Benutzergruppenwerte beim Überprüfen von JSON-Webtoken, die von Azure Active Directory ausgestellt wurden. Beachten Sie, dass der ClientID-Wert unabhängig von dieser Einstellung immer als zulässige Zielgruppe betrachtet wird.
allowedExternalRedirectUrls	Externe URLs, die als Teil der Anmeldung oder Abmeldung der App umgeleitet werden können. Beachten Sie, dass der Abfragezeichenfolgenteil der URL ignoriert wird. Dies ist eine erweiterte Einstellung, die in der Regel nur von Windows Store-Anwendungs-Back-Ends benötigt wird. Beachten Sie, dass URLs innerhalb der aktuellen Domäne immer implizit zulässig sind.
authFilePath	Der Pfad der Konfigurationsdatei, die Authentifizierungseinstellungen enthält. Wenn der Pfad relativ ist, basiert die Basis auf dem Stammverzeichnis der Website.
clientId	Die Client-ID dieser anwendung der vertrauenden Seite, die als client_id bezeichnet wird. Diese Einstellung ist erforderlich, um die OpenID-Verbindungsauthentifizierung mit Azure Active Directory oder anderen OpenID Connect-Anbietern von Drittanbietern zu aktivieren. Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
clientSecret	Der geheime Clientschlüssel dieser anwendung der vertrauenden Seite (in Azure Active Directory wird dies auch als Schlüssel bezeichnet). Diese Einstellung ist optional. Wenn kein geheimer Clientschlüssel konfiguriert ist, wird der implizite Authentifizierungsfluss von OpenID Connect verwendet, um Endbenutzer zu authentifizieren. Andernfalls wird der OpenID Connect-Autorisierungscodefluss verwendet, um Endbenutzer zu authentifizieren. Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
clientSecretCertificateThumbprint	Eine Alternative zum geheimen Clientschlüssel, d. h. der Fingerabdruck eines Zertifikats, das für Signaturzwecke verwendet wird. Diese Eigenschaft dient als Ersatz für den geheimen Clientschlüssel. Es ist auch optional.
clientSecretSettingName	Der Name der App-Einstellung, der den geheimen Clientschlüssel der Anwendung der vertrauenden Seite enthält.
configVersion	Die ConfigVersion des Authentifizierungs-/Autorisierungsfeatures, das für die aktuelle App verwendet wird. Die Einstellung in diesem Wert kann das Verhalten der Steuerungsebene für die Authentifizierung/Autorisierung steuern.
defaultProvider	Der Standardauthentifizierungsanbieter, der verwendet werden soll, wenn mehrere Anbieter konfiguriert sind. Diese Einstellung ist nur erforderlich, wenn mehrere Anbieter konfiguriert sind und die nicht authentifizierte Clientaktion auf "RedirectToLoginPage" festgelegt ist.
enabled	true, wenn das Feature "Authentifizierung/Autorisierung" für die aktuelle App aktiviert ist; andernfalls false.
facebookAppId	Die App-ID der Facebook-App, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Facebook-Anmeldung zu aktivieren. Facebook-Anmeldedokumentation: https://developers.facebook.com/docs/facebook-login
facebookAppSecret	Das App-Geheimnis der Facebook-App, die für facebook Login verwendet wird. Diese Einstellung ist erforderlich, um die Facebook-Anmeldung zu aktivieren. Facebook-Anmeldedokumentation: https://developers.facebook.com/docs/facebook-login
facebookAppSecretSettingName	Der Name der App-Einstellung, der den geheimen App-Schlüssel enthält, der für die Facebook-Anmeldung verwendet wird.
facebookOAuthScopes	Die OAuth 2.0-Bereiche, die als Teil der Facebook-Anmeldeauthentifizierung angefordert werden. Diese Einstellung ist optional. Facebook-Anmeldedokumentation: https://developers.facebook.com/docs/facebook-login
gitHubClientId	Die Client-ID der GitHub-App, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Github-Anmeldung zu aktivieren.
gitHubClientSecret	Der geheime Clientschlüssel der GitHub-App, der für die Github-Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Github-Anmeldung zu aktivieren.
gitHubClientSecretSettingName	Der Name der App-Einstellung, der den geheimen Clientschlüssel der GitHub-App enthält, die für die GitHub-Anmeldung verwendet wird.
gitHubOAuthScopes	Die OAuth 2.0-Bereiche, die als Teil der GitHub-Anmeldeauthentifizierung angefordert werden. Diese Einstellung ist optional.
googleClientId	Die OpenID Connect-Client-ID für die Google-Webanwendung. Diese Einstellung ist erforderlich, um die Google-Anmeldung zu aktivieren. Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/
googleClientSecret	Der geheime Clientschlüssel, der der Google-Webanwendung zugeordnet ist. Diese Einstellung ist erforderlich, um die Google-Anmeldung zu aktivieren. Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/
googleClientSecretSettingName	Der Name der App-Einstellung, der den geheimen Clientschlüssel enthält, der der Google-Webanwendung zugeordnet ist.
googleOAuthScopes	Die OAuth 2.0-Bereiche, die als Teil der Google Sign-In-Authentifizierung angefordert werden. Diese Einstellung ist optional. Wenn nicht angegeben, werden "openid", "profile" und "email" als Standardbereiche verwendet. Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/
isAuthFromFile	"true", wenn die Einstellungen für die Authentifizierungskonfiguration aus einer Datei gelesen werden sollen, andernfalls "false".
issuer	Der OpenID Connect Issuer-URI, der die Entität darstellt, die Zugriffstoken für diese Anwendung ausgibt. Bei Verwendung von Azure Active Directory ist dieser Wert der URI des Verzeichnismandanten, z. B. https://sts.windows.net/{tenant-guid}/. Bei diesem URI handelt es sich um einen bezeichner mit Groß-/Kleinschreibung für den Tokenherausgeber. Weitere Informationen zur OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
microsoftAccountClientId	Die OAuth 2.0-Client-ID, die für die für die Authentifizierung verwendete App erstellt wurde. Diese Einstellung ist erforderlich, um die Microsoft-Kontoauthentifizierung zu aktivieren. OAuth-Dokumentation zu Microsoft-Konten: https://dev.onedrive.com/auth/msa_oauth.htm
microsoftAccountClientSecret	Der geheime OAuth 2.0-Clientschlüssel, der für die für die Authentifizierung verwendete App erstellt wurde. Diese Einstellung ist erforderlich, um die Microsoft-Kontoauthentifizierung zu aktivieren. OAuth-Dokumentation zu Microsoft-Konten: https://dev.onedrive.com/auth/msa_oauth.htm
microsoftAccountClientSecretSettingName	Der Name der App-Einstellung, der den geheimen OAuth 2.0-Clientschlüssel enthält, der für die für die Authentifizierung verwendete App erstellt wurde.
microsoftAccountOAuthScopes	Die OAuth 2.0-Bereiche, die als Teil der Microsoft-Kontoauthentifizierung angefordert werden. Diese Einstellung ist optional. Wenn nicht angegeben, wird "wl.basic" als Standardbereich verwendet. Dokumentation zu Microsoft-Kontobereichen und -berechtigungen: https://msdn.microsoft.com/en-us/library/dn631845.aspx
runtimeVersion	Die RuntimeVersion des Authentifizierungs-/Autorisierungsfeatures, das für die aktuelle App verwendet wird. Die Einstellung in diesem Wert kann das Verhalten bestimmter Features im Authentifizierungs-/Autorisierungsmodul steuern.
tokenRefreshExtensionHours	Die Anzahl der Stunden nach ablauf des Sitzungstokens, mit der ein Sitzungstoken die Tokenaktualisierungs-API aufrufen kann. Der Standardwert ist 72 Stunden.
tokenStoreEnabled	true, plattformspezifische Sicherheitstoken, die während der Anmeldeflüsse abgerufen werden, dauerhaft zu speichern; andernfalls false. Der Standardwert ist false.
twitterConsumerKey	Der OAuth 1.0a Consumer Key der Twitter-Anwendung, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Twitter-Anmeldung zu aktivieren. Twitter Sign-In Dokumentation: https://dev.twitter.com/web/sign-in
twitterConsumerSecret	Das OAuth 1.0a-Verbrauchergeheimnis der Twitter-Anwendung, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Twitter-Anmeldung zu aktivieren. Twitter Sign-In Dokumentation: https://dev.twitter.com/web/sign-in
twitterConsumerSecretSettingName	Der Name der App-Einstellung, der das OAuth 1.0a-Verbrauchergeheimnis der Twitter-Anwendung enthält, die für die Anmeldung verwendet wird.
unauthenticatedClientAction	Die Auszuführende Aktion, wenn ein nicht authentifizierter Client versucht, auf die App zuzugreifen.
validateIssuer	Ruft einen Wert ab, der angibt, ob der Aussteller eine gültige HTTPS-URL sein soll und als solche überprüft werden soll.

Geerbte Eigenschaften

id	Ressourcen-ID. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
kind	Art der Ressource.
name	Ressourcenname. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
type	Ressourcentyp. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

Details zur Eigenschaft

aadClaimsAuthorization

Ruft eine JSON-Zeichenfolge ab, die die Azure AD-Acl-Einstellungen enthält.

aadClaimsAuthorization?: string

Eigenschaftswert

string

additionalLoginParams

Anmeldeparameter, die an den OpenID Connect-Autorisierungsendpunkt gesendet werden sollen, wenn sich ein Benutzer anmeldet. Jeder Parameter muss sich im Format "key=value" befinden.

additionalLoginParams?: string[]

Eigenschaftswert

string[]

allowedAudiences

Zulässige Benutzergruppenwerte beim Überprüfen von JSON-Webtoken, die von Azure Active Directory ausgestellt wurden. Beachten Sie, dass der ClientID-Wert unabhängig von dieser Einstellung immer als zulässige Zielgruppe betrachtet wird.

allowedAudiences?: string[]

Eigenschaftswert

string[]

allowedExternalRedirectUrls

Externe URLs, die als Teil der Anmeldung oder Abmeldung der App umgeleitet werden können. Beachten Sie, dass der Abfragezeichenfolgenteil der URL ignoriert wird. Dies ist eine erweiterte Einstellung, die in der Regel nur von Windows Store-Anwendungs-Back-Ends benötigt wird. Beachten Sie, dass URLs innerhalb der aktuellen Domäne immer implizit zulässig sind.

allowedExternalRedirectUrls?: string[]

Eigenschaftswert

string[]

authFilePath

Der Pfad der Konfigurationsdatei, die Authentifizierungseinstellungen enthält. Wenn der Pfad relativ ist, basiert die Basis auf dem Stammverzeichnis der Website.

authFilePath?: string

Eigenschaftswert

string

clientId

Die Client-ID dieser anwendung der vertrauenden Seite, die als client_id bezeichnet wird. Diese Einstellung ist erforderlich, um die OpenID-Verbindungsauthentifizierung mit Azure Active Directory oder anderen OpenID Connect-Anbietern von Drittanbietern zu aktivieren. Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html

clientId?: string

Eigenschaftswert

string

clientSecret

Der geheime Clientschlüssel dieser anwendung der vertrauenden Seite (in Azure Active Directory wird dies auch als Schlüssel bezeichnet). Diese Einstellung ist optional. Wenn kein geheimer Clientschlüssel konfiguriert ist, wird der implizite Authentifizierungsfluss von OpenID Connect verwendet, um Endbenutzer zu authentifizieren. Andernfalls wird der OpenID Connect-Autorisierungscodefluss verwendet, um Endbenutzer zu authentifizieren. Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html

clientSecret?: string

Eigenschaftswert

string

clientSecretCertificateThumbprint

Eine Alternative zum geheimen Clientschlüssel, d. h. der Fingerabdruck eines Zertifikats, das für Signaturzwecke verwendet wird. Diese Eigenschaft dient als Ersatz für den geheimen Clientschlüssel. Es ist auch optional.

clientSecretCertificateThumbprint?: string

Eigenschaftswert

string

clientSecretSettingName

Der Name der App-Einstellung, der den geheimen Clientschlüssel der Anwendung der vertrauenden Seite enthält.

clientSecretSettingName?: string

Eigenschaftswert

string

configVersion

Die ConfigVersion des Authentifizierungs-/Autorisierungsfeatures, das für die aktuelle App verwendet wird. Die Einstellung in diesem Wert kann das Verhalten der Steuerungsebene für die Authentifizierung/Autorisierung steuern.

configVersion?: string

Eigenschaftswert

string

defaultProvider

Der Standardauthentifizierungsanbieter, der verwendet werden soll, wenn mehrere Anbieter konfiguriert sind. Diese Einstellung ist nur erforderlich, wenn mehrere Anbieter konfiguriert sind und die nicht authentifizierte Clientaktion auf "RedirectToLoginPage" festgelegt ist.

defaultProvider?: BuiltInAuthenticationProvider

Eigenschaftswert

BuiltInAuthenticationProvider

enabled

true, wenn das Feature "Authentifizierung/Autorisierung" für die aktuelle App aktiviert ist; andernfalls false.

enabled?: boolean

Eigenschaftswert

boolean

facebookAppId

Die App-ID der Facebook-App, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Facebook-Anmeldung zu aktivieren. Facebook-Anmeldedokumentation: https://developers.facebook.com/docs/facebook-login

facebookAppId?: string

Eigenschaftswert

string

facebookAppSecret

Das App-Geheimnis der Facebook-App, die für facebook Login verwendet wird. Diese Einstellung ist erforderlich, um die Facebook-Anmeldung zu aktivieren. Facebook-Anmeldedokumentation: https://developers.facebook.com/docs/facebook-login

facebookAppSecret?: string

Eigenschaftswert

string

facebookAppSecretSettingName

Der Name der App-Einstellung, der den geheimen App-Schlüssel enthält, der für die Facebook-Anmeldung verwendet wird.

facebookAppSecretSettingName?: string

Eigenschaftswert

string

facebookOAuthScopes

Die OAuth 2.0-Bereiche, die als Teil der Facebook-Anmeldeauthentifizierung angefordert werden. Diese Einstellung ist optional. Facebook-Anmeldedokumentation: https://developers.facebook.com/docs/facebook-login

facebookOAuthScopes?: string[]

Eigenschaftswert

string[]

gitHubClientId

Die Client-ID der GitHub-App, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Github-Anmeldung zu aktivieren.

gitHubClientId?: string

Eigenschaftswert

string

gitHubClientSecret

Der geheime Clientschlüssel der GitHub-App, der für die Github-Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Github-Anmeldung zu aktivieren.

gitHubClientSecret?: string

Eigenschaftswert

string

gitHubClientSecretSettingName

Der Name der App-Einstellung, der den geheimen Clientschlüssel der GitHub-App enthält, die für die GitHub-Anmeldung verwendet wird.

gitHubClientSecretSettingName?: string

Eigenschaftswert

string

gitHubOAuthScopes

Die OAuth 2.0-Bereiche, die als Teil der GitHub-Anmeldeauthentifizierung angefordert werden. Diese Einstellung ist optional.

gitHubOAuthScopes?: string[]

Eigenschaftswert

string[]

googleClientId

Die OpenID Connect-Client-ID für die Google-Webanwendung. Diese Einstellung ist erforderlich, um die Google-Anmeldung zu aktivieren. Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/

googleClientId?: string

Eigenschaftswert

string

googleClientSecret

Der geheime Clientschlüssel, der der Google-Webanwendung zugeordnet ist. Diese Einstellung ist erforderlich, um die Google-Anmeldung zu aktivieren. Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/

googleClientSecret?: string

Eigenschaftswert

string

googleClientSecretSettingName

Der Name der App-Einstellung, der den geheimen Clientschlüssel enthält, der der Google-Webanwendung zugeordnet ist.

googleClientSecretSettingName?: string

Eigenschaftswert

string

googleOAuthScopes

Die OAuth 2.0-Bereiche, die als Teil der Google Sign-In-Authentifizierung angefordert werden. Diese Einstellung ist optional. Wenn nicht angegeben, werden "openid", "profile" und "email" als Standardbereiche verwendet. Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/

googleOAuthScopes?: string[]

Eigenschaftswert

string[]

isAuthFromFile

"true", wenn die Einstellungen für die Authentifizierungskonfiguration aus einer Datei gelesen werden sollen, andernfalls "false".

isAuthFromFile?: string

Eigenschaftswert

string

issuer

Der OpenID Connect Issuer-URI, der die Entität darstellt, die Zugriffstoken für diese Anwendung ausgibt. Bei Verwendung von Azure Active Directory ist dieser Wert der URI des Verzeichnismandanten, z. B. https://sts.windows.net/{tenant-guid}/. Bei diesem URI handelt es sich um einen bezeichner mit Groß-/Kleinschreibung für den Tokenherausgeber. Weitere Informationen zur OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html

issuer?: string

Eigenschaftswert

string

microsoftAccountClientId

Die OAuth 2.0-Client-ID, die für die für die Authentifizierung verwendete App erstellt wurde. Diese Einstellung ist erforderlich, um die Microsoft-Kontoauthentifizierung zu aktivieren. OAuth-Dokumentation zu Microsoft-Konten: https://dev.onedrive.com/auth/msa_oauth.htm

microsoftAccountClientId?: string

Eigenschaftswert

string

microsoftAccountClientSecret

Der geheime OAuth 2.0-Clientschlüssel, der für die für die Authentifizierung verwendete App erstellt wurde. Diese Einstellung ist erforderlich, um die Microsoft-Kontoauthentifizierung zu aktivieren. OAuth-Dokumentation zu Microsoft-Konten: https://dev.onedrive.com/auth/msa_oauth.htm

microsoftAccountClientSecret?: string

Eigenschaftswert

string

microsoftAccountClientSecretSettingName

Der Name der App-Einstellung, der den geheimen OAuth 2.0-Clientschlüssel enthält, der für die für die Authentifizierung verwendete App erstellt wurde.

microsoftAccountClientSecretSettingName?: string

Eigenschaftswert

string

microsoftAccountOAuthScopes

Die OAuth 2.0-Bereiche, die als Teil der Microsoft-Kontoauthentifizierung angefordert werden. Diese Einstellung ist optional. Wenn nicht angegeben, wird "wl.basic" als Standardbereich verwendet. Dokumentation zu Microsoft-Kontobereichen und -berechtigungen: https://msdn.microsoft.com/en-us/library/dn631845.aspx

microsoftAccountOAuthScopes?: string[]

Eigenschaftswert

string[]

runtimeVersion

Die RuntimeVersion des Authentifizierungs-/Autorisierungsfeatures, das für die aktuelle App verwendet wird. Die Einstellung in diesem Wert kann das Verhalten bestimmter Features im Authentifizierungs-/Autorisierungsmodul steuern.

runtimeVersion?: string

Eigenschaftswert

string

tokenRefreshExtensionHours

Die Anzahl der Stunden nach ablauf des Sitzungstokens, mit der ein Sitzungstoken die Tokenaktualisierungs-API aufrufen kann. Der Standardwert ist 72 Stunden.

tokenRefreshExtensionHours?: number

Eigenschaftswert

number

tokenStoreEnabled

true, plattformspezifische Sicherheitstoken, die während der Anmeldeflüsse abgerufen werden, dauerhaft zu speichern; andernfalls false. Der Standardwert ist false.

tokenStoreEnabled?: boolean

Eigenschaftswert

boolean

twitterConsumerKey

Der OAuth 1.0a Consumer Key der Twitter-Anwendung, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Twitter-Anmeldung zu aktivieren. Twitter Sign-In Dokumentation: https://dev.twitter.com/web/sign-in

twitterConsumerKey?: string

Eigenschaftswert

string

twitterConsumerSecret

Das OAuth 1.0a-Verbrauchergeheimnis der Twitter-Anwendung, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Twitter-Anmeldung zu aktivieren. Twitter Sign-In Dokumentation: https://dev.twitter.com/web/sign-in

twitterConsumerSecret?: string

Eigenschaftswert

string

twitterConsumerSecretSettingName

Der Name der App-Einstellung, der das OAuth 1.0a-Verbrauchergeheimnis der Twitter-Anwendung enthält, die für die Anmeldung verwendet wird.

twitterConsumerSecretSettingName?: string

Eigenschaftswert

string

unauthenticatedClientAction

Die Auszuführende Aktion, wenn ein nicht authentifizierter Client versucht, auf die App zuzugreifen.

unauthenticatedClientAction?: UnauthenticatedClientAction

Eigenschaftswert

UnauthenticatedClientAction

validateIssuer

Ruft einen Wert ab, der angibt, ob der Aussteller eine gültige HTTPS-URL sein soll und als solche überprüft werden soll.

validateIssuer?: boolean

Eigenschaftswert

boolean

Geerbte Eigenschaftsdetails

id

Ressourcen-ID. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

id?: string

Eigenschaftswert

string

geerbt vonProxyOnlyResource.id

kind

Art der Ressource.

kind?: string

Eigenschaftswert

string

vonProxyOnlyResource.kind geerbt

name

Ressourcenname. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

name?: string

Eigenschaftswert

string

geerbt vonProxyOnlyResource.name

type

Ressourcentyp. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

type?: string

Eigenschaftswert

string

geerbt vonProxyOnlyResource.type