SiteAuthSettingsProperties interface

Pakket:

@azure-rest/arm-appservice

SiteAuthSettings-resourcespecifieke eigenschappen

Eigenschappen

aadClaimsAuthorization	Hiermee haalt u een JSON-tekenreeks op die de Azure AD-Acl-instellingen bevat.
additionalLoginParams	Aanmeldingsparameters voor het verzenden naar het OpenID Connect-autorisatie-eindpunt wanneer een gebruiker zich aanmeldt. Elke parameter moet de notatie key=value hebben.
allowedAudiences	Toegestane doelgroepwaarden om rekening mee te houden bij het valideren van JWT's 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.
allowedExternalRedirectUrls	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.
authFilePath	Het pad van het configuratiebestand met verificatie-instellingen. Als het pad relatief is, wordt de basismap van de site gebruikt.
clientId	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
clientSecret	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
clientSecretCertificateThumbprint	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.
clientSecretSettingName	De naam van de app-instelling die het clientgeheim van de relying party-toepassing bevat.
configVersion	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.
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.
enabled	true als de verificatie-/autorisatiefunctie is ingeschakeld voor de huidige app; anders, false.
facebookAppId	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
facebookAppSecret	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
facebookAppSecretSettingName	De naam van de app-instelling die het app-geheim bevat dat wordt gebruikt voor Facebook-aanmelding.
facebookOAuthScopes	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
gitHubClientId	De client-id van de GitHub-app die wordt gebruikt voor aanmelding. Deze instelling is vereist voor het inschakelen van GitHub-aanmelding
gitHubClientSecret	Het clientgeheim van de GitHub-app die wordt gebruikt voor GitHub Login. Deze instelling is vereist voor het inschakelen van GitHub-aanmelding.
gitHubClientSecretSettingName	De naam van de app-instelling die het clientgeheim bevat van de GitHub-app die wordt gebruikt voor GitHub-aanmelding.
gitHubOAuthScopes	De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van GitHub-aanmeldingsverificatie. Deze instelling is optioneel
googleClientId	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/
googleClientSecret	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/
googleClientSecretSettingName	De naam van de app-instelling die het clientgeheim bevat dat is gekoppeld aan de Google-webtoepassing.
googleOAuthScopes	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/
isAuthFromFile	'true' als de configuratie-instellingen voor verificatie moeten worden gelezen uit een bestand, anders onwaar
issuer	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 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
microsoftAccountClientId	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
microsoftAccountClientSecret	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
microsoftAccountClientSecretSettingName	De naam van de app-instelling met het OAuth 2.0-clientgeheim dat is gemaakt voor de app die wordt gebruikt voor verificatie.
microsoftAccountOAuthScopes	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
runtimeVersion	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.
tokenRefreshExtensionHours	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.
tokenStoreEnabled	true voor het duurzaam opslaan van platformspecifieke beveiligingstokens die worden verkregen tijdens aanmeldingsstromen; anders, false. De standaardwaarde is false.
twitterConsumerKey	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
twitterConsumerSecret	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
twitterConsumerSecretSettingName	De naam van de app-instelling die het OAuth 1.0a-consumentengeheim bevat van de Twitter-toepassing die wordt gebruikt voor aanmelding.
unauthenticatedClientAction	De actie die moet worden uitgevoerd wanneer een niet-geverifieerde client probeert toegang te krijgen tot de app.
validateIssuer	Hiermee wordt een waarde opgehaald die aangeeft of de verlener een geldige HTTPS-URL moet zijn en als zodanig moet worden gevalideerd.

Eigenschapdetails

aadClaimsAuthorization

Hiermee haalt u een JSON-tekenreeks op die de Azure AD-Acl-instellingen bevat.

aadClaimsAuthorization?: string

Waarde van eigenschap

string

additionalLoginParams

Aanmeldingsparameters voor het verzenden naar het OpenID Connect-autorisatie-eindpunt wanneer een gebruiker zich aanmeldt. Elke parameter moet de notatie key=value hebben.

additionalLoginParams?: string[]

Waarde van eigenschap

string[]

allowedAudiences

Toegestane doelgroepwaarden om rekening mee te houden bij het valideren van JWT's 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.

allowedAudiences?: string[]

Waarde van eigenschap

string[]

allowedExternalRedirectUrls

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.

allowedExternalRedirectUrls?: string[]

Waarde van eigenschap

string[]

authFilePath

Het pad van het configuratiebestand met verificatie-instellingen. Als het pad relatief is, wordt de basismap van de site gebruikt.

authFilePath?: string

Waarde van eigenschap

string

clientId

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

clientId?: string

Waarde van eigenschap

string

clientSecret

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

clientSecret?: string

Waarde van eigenschap

string

clientSecretCertificateThumbprint

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.

clientSecretCertificateThumbprint?: string

Waarde van eigenschap

string

clientSecretSettingName

De naam van de app-instelling die het clientgeheim van de relying party-toepassing bevat.

clientSecretSettingName?: string

Waarde van eigenschap

string

configVersion

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.

configVersion?: string

Waarde van eigenschap

string

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.

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

Waarde van eigenschap

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

enabled

true als de verificatie-/autorisatiefunctie is ingeschakeld voor de huidige app; anders, false.

enabled?: boolean

Waarde van eigenschap

boolean

facebookAppId

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

facebookAppId?: string

Waarde van eigenschap

string

facebookAppSecret

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

facebookAppSecret?: string

Waarde van eigenschap

string

facebookAppSecretSettingName

De naam van de app-instelling die het app-geheim bevat dat wordt gebruikt voor Facebook-aanmelding.

facebookAppSecretSettingName?: string

Waarde van eigenschap

string

facebookOAuthScopes

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

facebookOAuthScopes?: string[]

Waarde van eigenschap

string[]

gitHubClientId

De client-id van de GitHub-app die wordt gebruikt voor aanmelding. Deze instelling is vereist voor het inschakelen van GitHub-aanmelding

gitHubClientId?: string

Waarde van eigenschap

string

gitHubClientSecret

Het clientgeheim van de GitHub-app die wordt gebruikt voor GitHub Login. Deze instelling is vereist voor het inschakelen van GitHub-aanmelding.

gitHubClientSecret?: string

Waarde van eigenschap

string

gitHubClientSecretSettingName

De naam van de app-instelling die het clientgeheim bevat van de GitHub-app die wordt gebruikt voor GitHub-aanmelding.

gitHubClientSecretSettingName?: string

Waarde van eigenschap

string

gitHubOAuthScopes

De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van GitHub-aanmeldingsverificatie. Deze instelling is optioneel

gitHubOAuthScopes?: string[]

Waarde van eigenschap

string[]

googleClientId

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/

googleClientId?: string

Waarde van eigenschap

string

googleClientSecret

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/

googleClientSecret?: string

Waarde van eigenschap

string

googleClientSecretSettingName

De naam van de app-instelling die het clientgeheim bevat dat is gekoppeld aan de Google-webtoepassing.

googleClientSecretSettingName?: string

Waarde van eigenschap

string

googleOAuthScopes

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/

googleOAuthScopes?: string[]

Waarde van eigenschap

string[]

isAuthFromFile

'true' als de configuratie-instellingen voor verificatie moeten worden gelezen uit een bestand, anders onwaar

isAuthFromFile?: string

Waarde van eigenschap

string

issuer

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

issuer?: string

Waarde van eigenschap

string

microsoftAccountClientId

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

microsoftAccountClientId?: string

Waarde van eigenschap

string

microsoftAccountClientSecret

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

microsoftAccountClientSecret?: string

Waarde van eigenschap

string

microsoftAccountClientSecretSettingName

De naam van de app-instelling met het OAuth 2.0-clientgeheim dat is gemaakt voor de app die wordt gebruikt voor verificatie.

microsoftAccountClientSecretSettingName?: string

Waarde van eigenschap

string

microsoftAccountOAuthScopes

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

microsoftAccountOAuthScopes?: string[]

Waarde van eigenschap

string[]

runtimeVersion

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.

runtimeVersion?: string

Waarde van eigenschap

string

tokenRefreshExtensionHours

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.

tokenRefreshExtensionHours?: number

Waarde van eigenschap

number

tokenStoreEnabled

true voor het duurzaam opslaan van platformspecifieke beveiligingstokens die worden verkregen tijdens aanmeldingsstromen; anders, false. De standaardwaarde is false.

tokenStoreEnabled?: boolean

Waarde van eigenschap

boolean

twitterConsumerKey

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

twitterConsumerKey?: string

Waarde van eigenschap

string

twitterConsumerSecret

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

twitterConsumerSecret?: string

Waarde van eigenschap

string

twitterConsumerSecretSettingName

De naam van de app-instelling die het OAuth 1.0a-consumentengeheim bevat van de Twitter-toepassing die wordt gebruikt voor aanmelding.

twitterConsumerSecretSettingName?: string

Waarde van eigenschap

string

unauthenticatedClientAction

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

unauthenticatedClientAction?: "RedirectToLoginPage" | "AllowAnonymous"

Waarde van eigenschap

"RedirectToLoginPage" | "AllowAnonymous"

validateIssuer

Hiermee wordt een waarde opgehaald die aangeeft of de verlener een geldige HTTPS-URL moet zijn en als zodanig moet worden gevalideerd.

validateIssuer?: boolean

Waarde van eigenschap

boolean