SiteAuthSettingsProperties interface

Paquet:

@azure-rest/arm-appservice

Propriétés spécifiques à la ressource SiteAuthSettings

Propriétés

aadClaimsAuthorization	Obtient une chaîne JSON contenant les paramètres Acl Azure AD.
additionalLoginParams	Paramètres de connexion à envoyer au point de terminaison d’autorisation OpenID Connect lorsqu’un utilisateur se connecte. Chaque paramètre doit se trouver sous la forme « key=value ».
allowedAudiences	Valeurs d’audience autorisées à prendre en compte lors de la validation des JWT émis par Azure Active Directory. Notez que la valeur ClientID est toujours considérée comme un public autorisé, quel que soit ce paramètre.
allowedExternalRedirectUrls	URL externes pouvant être redirigées dans le cadre de la connexion ou de la déconnexion de l’application. Notez que la partie chaîne de requête de l’URL est ignorée. Il s’agit d’un paramètre avancé généralement nécessaire uniquement par les back-ends d’application du Windows Store. Notez que les URL du domaine actuel sont toujours implicitement autorisées.
authFilePath	Chemin du fichier de configuration contenant les paramètres d’authentification. Si le chemin d’accès est relatif, la base va le répertoire racine du site.
clientId	ID client de cette application de partie de confiance, appelé client_id. Ce paramètre est requis pour activer l’authentification de connexion OpenID avec Azure Active Directory ou d’autres fournisseurs OpenID Connect tiers. Plus d’informations sur OpenID Connect : http://openid.net/specs/openid-connect-core-1_0.html
clientSecret	Clé secrète client de cette application de partie de confiance (dans Azure Active Directory, elle est également appelée clé). Ce paramètre est facultatif. Si aucune clé secrète client n’est configurée, le flux d’authentification implicite OpenID Connect est utilisé pour authentifier les utilisateurs finaux. Sinon, le flux de code d’autorisation OpenID Connect est utilisé pour authentifier les utilisateurs finaux. Plus d’informations sur OpenID Connect : http://openid.net/specs/openid-connect-core-1_0.html
clientSecretCertificateThumbprint	Alternative à la clé secrète client, c’est-à-dire l’empreinte numérique d’un certificat utilisé à des fins de signature. Cette propriété remplace la clé secrète client. Il est également facultatif.
clientSecretSettingName	Nom du paramètre d’application qui contient la clé secrète client de l’application de partie de confiance.
configVersion	ConfigVersion de la fonctionnalité d’authentification/autorisation utilisée pour l’application actuelle. Le paramètre de cette valeur peut contrôler le comportement du plan de contrôle pour l’authentification/autorisation.
defaultProvider	Fournisseur d’authentification par défaut à utiliser quand plusieurs fournisseurs sont configurés. Ce paramètre est nécessaire uniquement si plusieurs fournisseurs sont configurés et que l’action cliente non authentifiée est définie sur « RedirectToLoginPage ».
enabled	true si la fonctionnalité d’authentification/autorisation est activée pour l’application actuelle ; sinon, false.
facebookAppId	ID d’application de l’application Facebook utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Facebook. Documentation de connexion Facebook : https://developers.facebook.com/docs/facebook-login
facebookAppSecret	Secret d’application de l’application Facebook utilisée pour Facebook Login. Ce paramètre est requis pour activer la connexion Facebook. Documentation de connexion Facebook : https://developers.facebook.com/docs/facebook-login
facebookAppSecretSettingName	Nom du paramètre d’application qui contient le secret d’application utilisé pour La connexion Facebook.
facebookOAuthScopes	Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification de connexion Facebook. Ce paramètre est facultatif. Documentation de connexion Facebook : https://developers.facebook.com/docs/facebook-login
gitHubClientId	ID client de l’application GitHub utilisée pour la connexion. Ce paramètre est requis pour activer la connexion GitHub
gitHubClientSecret	Clé secrète client de l’application GitHub utilisée pour Github Login. Ce paramètre est requis pour activer la connexion Github.
gitHubClientSecretSettingName	Nom du paramètre d’application qui contient la clé secrète client de l’application Github utilisée pour GitHub Login.
gitHubOAuthScopes	Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification de connexion GitHub. Ce paramètre est facultatif
googleClientId	ID client OpenID Connect pour l’application web Google. Ce paramètre est requis pour activer la connexion Google. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/
googleClientSecret	Clé secrète client associée à l’application web Google. Ce paramètre est requis pour activer la connexion Google. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/
googleClientSecretSettingName	Nom du paramètre d’application qui contient la clé secrète client associée à l’application web Google.
googleOAuthScopes	Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification Google Sign-In. Ce paramètre est facultatif. S’il n’est pas spécifié, « openid », « profil » et « e-mail » sont utilisés comme étendues par défaut. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/
isAuthFromFile	« true » si les paramètres de configuration d’authentification doivent être lus à partir d’un fichier, « false » sinon
issuer	URI de l’émetteur OpenID Connect qui représente l’entité qui émet des jetons d’accès pour cette application. Lorsque vous utilisez Azure Active Directory, cette valeur est l’URI du locataire d’annuaire, par exemple https://sts.windows.net/{tenant-guid}/. Cet URI est un identificateur sensible à la casse pour l’émetteur de jeton. Plus d’informations sur la découverte OpenID Connect : http://openid.net/specs/openid-connect-discovery-1_0.html
microsoftAccountClientId	ID client OAuth 2.0 créé pour l’application utilisée pour l’authentification. Ce paramètre est requis pour activer l’authentification de compte Microsoft. Documentation OAuth du compte Microsoft : https://dev.onedrive.com/auth/msa_oauth.htm
microsoftAccountClientSecret	Secret client OAuth 2.0 créé pour l’application utilisée pour l’authentification. Ce paramètre est requis pour activer l’authentification de compte Microsoft. Documentation OAuth du compte Microsoft : https://dev.onedrive.com/auth/msa_oauth.htm
microsoftAccountClientSecretSettingName	Nom du paramètre d’application contenant la clé secrète client OAuth 2.0 créée pour l’application utilisée pour l’authentification.
microsoftAccountOAuthScopes	Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification du compte Microsoft. Ce paramètre est facultatif. S’il n’est pas spécifié, « wl.basic » est utilisé comme étendue par défaut. Documentation sur les étendues et autorisations des comptes Microsoft : https://msdn.microsoft.com/en-us/library/dn631845.aspx
runtimeVersion	RuntimeVersion de la fonctionnalité d’authentification/autorisation utilisée pour l’application actuelle. Le paramètre de cette valeur peut contrôler le comportement de certaines fonctionnalités dans le module d’authentification/autorisation.
tokenRefreshExtensionHours	Nombre d’heures après l’expiration du jeton de session qu’un jeton de session peut être utilisé pour appeler l’API d’actualisation du jeton. La valeur par défaut est 72 heures.
tokenStoreEnabled	true pour stocker durablement des jetons de sécurité spécifiques à la plateforme obtenus pendant les flux de connexion ; sinon, false. La valeur par défaut est false.
twitterConsumerKey	Clé de consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Twitter. Documentation Sign-In Twitter : https://dev.twitter.com/web/sign-in
twitterConsumerSecret	Secret consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Twitter. Documentation Sign-In Twitter : https://dev.twitter.com/web/sign-in
twitterConsumerSecretSettingName	Nom du paramètre d’application qui contient le secret consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion.
unauthenticatedClientAction	Action à entreprendre lorsqu’un client non authentifié tente d’accéder à l’application.
validateIssuer	Obtient une valeur indiquant si l’émetteur doit être une URL HTTPS valide et être validée en tant que telle.

Détails de la propriété

aadClaimsAuthorization

Obtient une chaîne JSON contenant les paramètres Acl Azure AD.

aadClaimsAuthorization?: string

Valeur de propriété

string

additionalLoginParams

Paramètres de connexion à envoyer au point de terminaison d’autorisation OpenID Connect lorsqu’un utilisateur se connecte. Chaque paramètre doit se trouver sous la forme « key=value ».

additionalLoginParams?: string[]

Valeur de propriété

string[]

allowedAudiences

Valeurs d’audience autorisées à prendre en compte lors de la validation des JWT émis par Azure Active Directory. Notez que la valeur ClientID est toujours considérée comme un public autorisé, quel que soit ce paramètre.

allowedAudiences?: string[]

Valeur de propriété

string[]

allowedExternalRedirectUrls

URL externes pouvant être redirigées dans le cadre de la connexion ou de la déconnexion de l’application. Notez que la partie chaîne de requête de l’URL est ignorée. Il s’agit d’un paramètre avancé généralement nécessaire uniquement par les back-ends d’application du Windows Store. Notez que les URL du domaine actuel sont toujours implicitement autorisées.

allowedExternalRedirectUrls?: string[]

Valeur de propriété

string[]

authFilePath

Chemin du fichier de configuration contenant les paramètres d’authentification. Si le chemin d’accès est relatif, la base va le répertoire racine du site.

authFilePath?: string

Valeur de propriété

string

clientId

ID client de cette application de partie de confiance, appelé client_id. Ce paramètre est requis pour activer l’authentification de connexion OpenID avec Azure Active Directory ou d’autres fournisseurs OpenID Connect tiers. Plus d’informations sur OpenID Connect : http://openid.net/specs/openid-connect-core-1_0.html

clientId?: string

Valeur de propriété

string

clientSecret

Clé secrète client de cette application de partie de confiance (dans Azure Active Directory, elle est également appelée clé). Ce paramètre est facultatif. Si aucune clé secrète client n’est configurée, le flux d’authentification implicite OpenID Connect est utilisé pour authentifier les utilisateurs finaux. Sinon, le flux de code d’autorisation OpenID Connect est utilisé pour authentifier les utilisateurs finaux. Plus d’informations sur OpenID Connect : http://openid.net/specs/openid-connect-core-1_0.html

clientSecret?: string

Valeur de propriété

string

clientSecretCertificateThumbprint

Alternative à la clé secrète client, c’est-à-dire l’empreinte numérique d’un certificat utilisé à des fins de signature. Cette propriété remplace la clé secrète client. Il est également facultatif.

clientSecretCertificateThumbprint?: string

Valeur de propriété

string

clientSecretSettingName

Nom du paramètre d’application qui contient la clé secrète client de l’application de partie de confiance.

clientSecretSettingName?: string

Valeur de propriété

string

configVersion

ConfigVersion de la fonctionnalité d’authentification/autorisation utilisée pour l’application actuelle. Le paramètre de cette valeur peut contrôler le comportement du plan de contrôle pour l’authentification/autorisation.

configVersion?: string

Valeur de propriété

string

defaultProvider

Fournisseur d’authentification par défaut à utiliser quand plusieurs fournisseurs sont configurés. Ce paramètre est nécessaire uniquement si plusieurs fournisseurs sont configurés et que l’action cliente non authentifiée est définie sur « RedirectToLoginPage ».

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

Valeur de propriété

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

enabled

true si la fonctionnalité d’authentification/autorisation est activée pour l’application actuelle ; sinon, false.

enabled?: boolean

Valeur de propriété

boolean

facebookAppId

ID d’application de l’application Facebook utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Facebook. Documentation de connexion Facebook : https://developers.facebook.com/docs/facebook-login

facebookAppId?: string

Valeur de propriété

string

facebookAppSecret

Secret d’application de l’application Facebook utilisée pour Facebook Login. Ce paramètre est requis pour activer la connexion Facebook. Documentation de connexion Facebook : https://developers.facebook.com/docs/facebook-login

facebookAppSecret?: string

Valeur de propriété

string

facebookAppSecretSettingName

Nom du paramètre d’application qui contient le secret d’application utilisé pour La connexion Facebook.

facebookAppSecretSettingName?: string

Valeur de propriété

string

facebookOAuthScopes

Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification de connexion Facebook. Ce paramètre est facultatif. Documentation de connexion Facebook : https://developers.facebook.com/docs/facebook-login

facebookOAuthScopes?: string[]

Valeur de propriété

string[]

gitHubClientId

ID client de l’application GitHub utilisée pour la connexion. Ce paramètre est requis pour activer la connexion GitHub

gitHubClientId?: string

Valeur de propriété

string

gitHubClientSecret

Clé secrète client de l’application GitHub utilisée pour Github Login. Ce paramètre est requis pour activer la connexion Github.

gitHubClientSecret?: string

Valeur de propriété

string

gitHubClientSecretSettingName

Nom du paramètre d’application qui contient la clé secrète client de l’application Github utilisée pour GitHub Login.

gitHubClientSecretSettingName?: string

Valeur de propriété

string

gitHubOAuthScopes

Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification de connexion GitHub. Ce paramètre est facultatif

gitHubOAuthScopes?: string[]

Valeur de propriété

string[]

googleClientId

ID client OpenID Connect pour l’application web Google. Ce paramètre est requis pour activer la connexion Google. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/

googleClientId?: string

Valeur de propriété

string

googleClientSecret

Clé secrète client associée à l’application web Google. Ce paramètre est requis pour activer la connexion Google. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/

googleClientSecret?: string

Valeur de propriété

string

googleClientSecretSettingName

Nom du paramètre d’application qui contient la clé secrète client associée à l’application web Google.

googleClientSecretSettingName?: string

Valeur de propriété

string

googleOAuthScopes

Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification Google Sign-In. Ce paramètre est facultatif. S’il n’est pas spécifié, « openid », « profil » et « e-mail » sont utilisés comme étendues par défaut. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/

googleOAuthScopes?: string[]

Valeur de propriété

string[]

isAuthFromFile

« true » si les paramètres de configuration d’authentification doivent être lus à partir d’un fichier, « false » sinon

isAuthFromFile?: string

Valeur de propriété

string

issuer

URI de l’émetteur OpenID Connect qui représente l’entité qui émet des jetons d’accès pour cette application. Lorsque vous utilisez Azure Active Directory, cette valeur est l’URI du locataire d’annuaire, par exemple https://sts.windows.net/{tenant-guid}/. Cet URI est un identificateur sensible à la casse pour l’émetteur de jeton. Plus d’informations sur la découverte OpenID Connect : http://openid.net/specs/openid-connect-discovery-1_0.html

issuer?: string

Valeur de propriété

string

microsoftAccountClientId

ID client OAuth 2.0 créé pour l’application utilisée pour l’authentification. Ce paramètre est requis pour activer l’authentification de compte Microsoft. Documentation OAuth du compte Microsoft : https://dev.onedrive.com/auth/msa_oauth.htm

microsoftAccountClientId?: string

Valeur de propriété

string

microsoftAccountClientSecret

Secret client OAuth 2.0 créé pour l’application utilisée pour l’authentification. Ce paramètre est requis pour activer l’authentification de compte Microsoft. Documentation OAuth du compte Microsoft : https://dev.onedrive.com/auth/msa_oauth.htm

microsoftAccountClientSecret?: string

Valeur de propriété

string

microsoftAccountClientSecretSettingName

Nom du paramètre d’application contenant la clé secrète client OAuth 2.0 créée pour l’application utilisée pour l’authentification.

microsoftAccountClientSecretSettingName?: string

Valeur de propriété

string

microsoftAccountOAuthScopes

Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification du compte Microsoft. Ce paramètre est facultatif. S’il n’est pas spécifié, « wl.basic » est utilisé comme étendue par défaut. Documentation sur les étendues et autorisations des comptes Microsoft : https://msdn.microsoft.com/en-us/library/dn631845.aspx

microsoftAccountOAuthScopes?: string[]

Valeur de propriété

string[]

runtimeVersion

RuntimeVersion de la fonctionnalité d’authentification/autorisation utilisée pour l’application actuelle. Le paramètre de cette valeur peut contrôler le comportement de certaines fonctionnalités dans le module d’authentification/autorisation.

runtimeVersion?: string

Valeur de propriété

string

tokenRefreshExtensionHours

Nombre d’heures après l’expiration du jeton de session qu’un jeton de session peut être utilisé pour appeler l’API d’actualisation du jeton. La valeur par défaut est 72 heures.

tokenRefreshExtensionHours?: number

Valeur de propriété

number

tokenStoreEnabled

true pour stocker durablement des jetons de sécurité spécifiques à la plateforme obtenus pendant les flux de connexion ; sinon, false. La valeur par défaut est false.

tokenStoreEnabled?: boolean

Valeur de propriété

boolean

twitterConsumerKey

Clé de consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Twitter. Documentation Sign-In Twitter : https://dev.twitter.com/web/sign-in

twitterConsumerKey?: string

Valeur de propriété

string

twitterConsumerSecret

Secret consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Twitter. Documentation Sign-In Twitter : https://dev.twitter.com/web/sign-in

twitterConsumerSecret?: string

Valeur de propriété

string

twitterConsumerSecretSettingName

Nom du paramètre d’application qui contient le secret consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion.

twitterConsumerSecretSettingName?: string

Valeur de propriété

string

unauthenticatedClientAction

Action à entreprendre lorsqu’un client non authentifié tente d’accéder à l’application.

unauthenticatedClientAction?: "RedirectToLoginPage" | "AllowAnonymous"

Valeur de propriété

"RedirectToLoginPage" | "AllowAnonymous"

validateIssuer

Obtient une valeur indiquant si l’émetteur doit être une URL HTTPS valide et être validée en tant que telle.

validateIssuer?: boolean

Valeur de propriété

boolean