SiteAuthSettingsProperties interface

Paket:

@azure-rest/arm-appservice

SiteAuthSettings resursspecifika egenskaper

Egenskaper

aadClaimsAuthorization	Hämtar en JSON-sträng som innehåller Azure AD Acl-inställningarna.
additionalLoginParams	Inloggningsparametrar som ska skickas till OpenID Connect-auktoriseringsslutpunkten när en användare loggar in. Varje parameter måste vara i formatet "key=value".
allowedAudiences	Tillåtna målgruppsvärden att tänka på när du validerar JWT:er som utfärdats av Azure Active Directory. Observera att värdet för ClientID alltid betraktas som en tillåten målgrupp, oavsett den här inställningen.
allowedExternalRedirectUrls	Externa URL:er som kan omdirigeras till som en del av att logga in eller logga ut från appen. Observera att frågesträngens del av URL:en ignoreras. Det här är en avancerad inställning som vanligtvis bara behövs av Windows Store-programservrar. Observera att URL:er inom den aktuella domänen alltid är implicit tillåtna.
authFilePath	Sökvägen till konfigurationsfilen som innehåller autentiseringsinställningar. Om sökvägen är relativ kommer platsens rotkatalog att vara basen.
clientId	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
clientSecret	Klienthemligheten för det här förlitande partprogrammet (i Azure Active Directory kallas detta även för nyckeln). Den här inställningen är valfri. Om ingen klienthemlighet har konfigurerats används implicit autentiseringsflöde i OpenID Connect 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
clientSecretCertificateThumbprint	Ett alternativ till klienthemligheten, som är tumavtrycket för ett certifikat som används i signeringssyfte. Den här egenskapen fungerar som en ersättning för klienthemligheten. Det är också valfritt.
clientSecretSettingName	Namnet på appinställningen som innehåller klienthemligheten för det förlitande partprogrammet.
configVersion	ConfigVersion av funktionen Autentisering/auktorisering som används för den aktuella appen. Inställningen i det här värdet kan styra beteendet för kontrollplanet för autentisering/auktorisering.
defaultProvider	Standardautentiseringsprovidern som ska användas när flera leverantörer konfigureras. Den här inställningen behövs bara om flera leverantörer har konfigurerats och den oautentiserade klientåtgärden är inställd på "RedirectToLoginPage".
enabled	true om funktionen Autentisering/auktorisering är aktiverad för den aktuella appen. annars false.
facebookAppId	App-ID för Facebook-appen som används för inloggning. Den här inställningen krävs för att aktivera Facebook-inloggning. Dokumentation om Facebook-inloggning: https://developers.facebook.com/docs/facebook-login
facebookAppSecret	Apphemligheten för Facebook-appen som används för Facebook-inloggning. Den här inställningen krävs för att aktivera Facebook-inloggning. Dokumentation om Facebook-inloggning: https://developers.facebook.com/docs/facebook-login
facebookAppSecretSettingName	Namnet på appinställningen som innehåller apphemligheten som används för Facebook-inloggning.
facebookOAuthScopes	OAuth 2.0-omfång som kommer att begäras som en del av Facebook-inloggningsautentisering. Den här inställningen är valfri. Dokumentation om Facebook-inloggning: https://developers.facebook.com/docs/facebook-login
gitHubClientId	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
gitHubClientSecret	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.
gitHubClientSecretSettingName	Namnet på appinställningen som innehåller klienthemligheten för Github-appen som används för GitHub-inloggning.
gitHubOAuthScopes	OAuth 2.0-omfång som kommer att begäras som en del av GitHub-inloggningsautentisering. Den här inställningen är valfri
googleClientId	OpenID Connect-klient-ID för Google-webbprogrammet. 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/
googleClientSecret	Klienthemligheten som är associerad med 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/
googleClientSecretSettingName	Namnet på appinställningen som innehåller klienthemligheten som är associerad med Google-webbappen.
googleOAuthScopes	OAuth 2.0-omfång som kommer att begäras som en del av Google Sign-In autentisering. Den här inställningen är valfri. Om det inte anges används "openid", "profile" och "email" som standardomfång. Dokumentation om Google Sign-In: https://developers.google.com/identity/sign-in/web/
isAuthFromFile	"true" om autentiseringskonfigurationsinställningarna ska läsas från en fil, annars "false"
issuer	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 Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
microsoftAccountClientId	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-konto-OAuth: https://dev.onedrive.com/auth/msa_oauth.htm
microsoftAccountClientSecret	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-konto-OAuth: https://dev.onedrive.com/auth/msa_oauth.htm
microsoftAccountClientSecretSettingName	Namnet på appinställningen som innehåller OAuth 2.0-klienthemligheten som skapades för appen som används för autentisering.
microsoftAccountOAuthScopes	OAuth 2.0-omfång som kommer att begäras 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
runtimeVersion	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.
tokenRefreshExtensionHours	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.
tokenStoreEnabled	true att lagra plattformsspecifika säkerhetstoken som hämtas under inloggningsflöden. annars false. Standardvärdet är false.
twitterConsumerKey	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
twitterConsumerSecret	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
twitterConsumerSecretSettingName	Namnet på appinställningen som innehåller OAuth 1.0a-konsumenthemligheten för Twitter-programmet som används för inloggning.
unauthenticatedClientAction	Åtgärden som ska vidtas när en oautentiserad klient försöker komma åt appen.
validateIssuer	Hämtar ett värde som anger om utfärdaren ska vara en giltig HTTPS-URL och verifieras som sådan.

Egenskapsinformation

aadClaimsAuthorization

Hämtar en JSON-sträng som innehåller Azure AD Acl-inställningarna.

aadClaimsAuthorization?: string

Egenskapsvärde

string

additionalLoginParams

Inloggningsparametrar som ska skickas till OpenID Connect-auktoriseringsslutpunkten när en användare loggar in. Varje parameter måste vara i formatet "key=value".

additionalLoginParams?: string[]

Egenskapsvärde

string[]

allowedAudiences

Tillåtna målgruppsvärden att tänka på när du validerar JWT:er som utfärdats av Azure Active Directory. Observera att värdet för ClientID alltid betraktas som en tillåten målgrupp, oavsett den här inställningen.

allowedAudiences?: string[]

Egenskapsvärde

string[]

allowedExternalRedirectUrls

Externa URL:er som kan omdirigeras till som en del av att logga in eller logga ut från appen. Observera att frågesträngens del av URL:en ignoreras. Det här är en avancerad inställning som vanligtvis bara behövs av Windows Store-programservrar. Observera att URL:er inom den aktuella domänen alltid är implicit tillåtna.

allowedExternalRedirectUrls?: string[]

Egenskapsvärde

string[]

authFilePath

Sökvägen till konfigurationsfilen som innehåller autentiseringsinställningar. Om sökvägen är relativ kommer platsens rotkatalog att vara basen.

authFilePath?: string

Egenskapsvärde

string

clientId

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

clientId?: string

Egenskapsvärde

string

clientSecret

Klienthemligheten för det här förlitande partprogrammet (i Azure Active Directory kallas detta även för nyckeln). Den här inställningen är valfri. Om ingen klienthemlighet har konfigurerats används implicit autentiseringsflöde i OpenID Connect 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

clientSecret?: string

Egenskapsvärde

string

clientSecretCertificateThumbprint

Ett alternativ till klienthemligheten, som är tumavtrycket för ett certifikat som används i signeringssyfte. Den här egenskapen fungerar som en ersättning för klienthemligheten. Det är också valfritt.

clientSecretCertificateThumbprint?: string

Egenskapsvärde

string

clientSecretSettingName

Namnet på appinställningen som innehåller klienthemligheten för det förlitande partprogrammet.

clientSecretSettingName?: string

Egenskapsvärde

string

configVersion

ConfigVersion av funktionen Autentisering/auktorisering som används för den aktuella appen. Inställningen i det här värdet kan styra beteendet för kontrollplanet för autentisering/auktorisering.

configVersion?: string

Egenskapsvärde

string

defaultProvider

Standardautentiseringsprovidern som ska användas när flera leverantörer konfigureras. Den här inställningen behövs bara om flera leverantörer har konfigurerats och den oautentiserade klientåtgärden är inställd på "RedirectToLoginPage".

defaultProvider?: "AzureActiveDirectory" | "Facebook" | "Google" | "MicrosoftAccount" | "Twitter" | "Github"

Egenskapsvärde

"AzureActiveDirectory" | "Facebook" | "Google" | "MicrosoftAccount" | "Twitter" | "Github"

enabled

true om funktionen Autentisering/auktorisering är aktiverad för den aktuella appen. annars false.

enabled?: boolean

Egenskapsvärde

boolean

facebookAppId

App-ID för Facebook-appen som används för inloggning. Den här inställningen krävs för att aktivera Facebook-inloggning. Dokumentation om Facebook-inloggning: https://developers.facebook.com/docs/facebook-login

facebookAppId?: string

Egenskapsvärde

string

facebookAppSecret

Apphemligheten för Facebook-appen som används för Facebook-inloggning. Den här inställningen krävs för att aktivera Facebook-inloggning. Dokumentation om Facebook-inloggning: https://developers.facebook.com/docs/facebook-login

facebookAppSecret?: string

Egenskapsvärde

string

facebookAppSecretSettingName

Namnet på appinställningen som innehåller apphemligheten som används för Facebook-inloggning.

facebookAppSecretSettingName?: string

Egenskapsvärde

string

facebookOAuthScopes

OAuth 2.0-omfång som kommer att begäras som en del av Facebook-inloggningsautentisering. Den här inställningen är valfri. Dokumentation om Facebook-inloggning: https://developers.facebook.com/docs/facebook-login

facebookOAuthScopes?: string[]

Egenskapsvärde

string[]

gitHubClientId

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

gitHubClientId?: string

Egenskapsvärde

string

gitHubClientSecret

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.

gitHubClientSecret?: string

Egenskapsvärde

string

gitHubClientSecretSettingName

Namnet på appinställningen som innehåller klienthemligheten för Github-appen som används för GitHub-inloggning.

gitHubClientSecretSettingName?: string

Egenskapsvärde

string

gitHubOAuthScopes

OAuth 2.0-omfång som kommer att begäras som en del av GitHub-inloggningsautentisering. Den här inställningen är valfri

gitHubOAuthScopes?: string[]

Egenskapsvärde

string[]

googleClientId

OpenID Connect-klient-ID för Google-webbprogrammet. 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/

googleClientId?: string

Egenskapsvärde

string

googleClientSecret

Klienthemligheten som är associerad med 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/

googleClientSecret?: string

Egenskapsvärde

string

googleClientSecretSettingName

Namnet på appinställningen som innehåller klienthemligheten som är associerad med Google-webbappen.

googleClientSecretSettingName?: string

Egenskapsvärde

string

googleOAuthScopes

OAuth 2.0-omfång som kommer att begäras som en del av Google Sign-In autentisering. Den här inställningen är valfri. Om det inte anges används "openid", "profile" och "email" som standardomfång. Dokumentation om Google Sign-In: https://developers.google.com/identity/sign-in/web/

googleOAuthScopes?: string[]

Egenskapsvärde

string[]

isAuthFromFile

"true" om autentiseringskonfigurationsinställningarna ska läsas från en fil, annars "false"

isAuthFromFile?: string

Egenskapsvärde

string

issuer

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 Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html

issuer?: string

Egenskapsvärde

string

microsoftAccountClientId

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-konto-OAuth: https://dev.onedrive.com/auth/msa_oauth.htm

microsoftAccountClientId?: string

Egenskapsvärde

string

microsoftAccountClientSecret

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-konto-OAuth: https://dev.onedrive.com/auth/msa_oauth.htm

microsoftAccountClientSecret?: string

Egenskapsvärde

string

microsoftAccountClientSecretSettingName

Namnet på appinställningen som innehåller OAuth 2.0-klienthemligheten som skapades för appen som används för autentisering.

microsoftAccountClientSecretSettingName?: string

Egenskapsvärde

string

microsoftAccountOAuthScopes

OAuth 2.0-omfång som kommer att begäras 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

microsoftAccountOAuthScopes?: string[]

Egenskapsvärde

string[]

runtimeVersion

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.

runtimeVersion?: string

Egenskapsvärde

string

tokenRefreshExtensionHours

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.

tokenRefreshExtensionHours?: number

Egenskapsvärde

number

tokenStoreEnabled

true att lagra plattformsspecifika säkerhetstoken som hämtas under inloggningsflöden. annars false. Standardvärdet är false.

tokenStoreEnabled?: boolean

Egenskapsvärde

boolean

twitterConsumerKey

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

twitterConsumerKey?: string

Egenskapsvärde

string

twitterConsumerSecret

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

twitterConsumerSecret?: string

Egenskapsvärde

string

twitterConsumerSecretSettingName

Namnet på appinställningen som innehåller OAuth 1.0a-konsumenthemligheten för Twitter-programmet som används för inloggning.

twitterConsumerSecretSettingName?: string

Egenskapsvärde

string

unauthenticatedClientAction

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

unauthenticatedClientAction?: "RedirectToLoginPage" | "AllowAnonymous"

Egenskapsvärde

"RedirectToLoginPage" | "AllowAnonymous"

validateIssuer

Hämtar ett värde som anger om utfärdaren ska vara en giltig HTTPS-URL och verifieras som sådan.

validateIssuer?: boolean

Egenskapsvärde

boolean