SiteAuthSettings interface

Пакет:

@azure/arm-appservice

Параметры конфигурации для функции проверки подлинности и авторизации службы приложений Azure.

Extends

ProxyOnlyResource

Свойства

aadClaimsAuthorization	Возвращает строку JSON, содержащую параметры Acl Azure AD.
additionalLoginParams	Параметры входа для отправки в конечную точку авторизации OpenID Connect при входе пользователя. Каждый параметр должен находиться в форме "key=value".
allowedAudiences	Разрешены значения аудитории, которые следует учитывать при проверке веб-маркеров JSON, выданных Azure Active Directory. Обратите внимание, что значение ClientID всегда считается разрешенной аудиторией независимо от этого параметра.
allowedExternalRedirectUrls	Внешние URL-адреса, которые можно перенаправить в рамках входа или выхода из приложения. Обратите внимание, что часть строки запроса URL-адреса игнорируется. Это расширенный параметр, который обычно требуется только серверной части приложения Магазина Windows. Обратите внимание, что URL-адреса в текущем домене всегда неявно разрешены.
authFilePath	Путь к файлу конфигурации с параметрами проверки подлинности. Если путь является относительным, база будет корневой каталог сайта.
clientId	Идентификатор клиента этого проверяющего приложения, известного как client_id. Этот параметр необходим для включения проверки подлинности подключения OpenID с Помощью Azure Active Directory или других сторонних поставщиков OpenID Connect. Дополнительные сведения о OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
clientSecret	Секрет клиента этого приложения проверяющей стороны (в Azure Active Directory это также называется ключом). Этот параметр является необязательным. Если секрет клиента не настроен, поток неявной проверки подлинности OpenID Connect используется для проверки подлинности конечных пользователей. В противном случае поток кода авторизации OpenID Connect используется для проверки подлинности конечных пользователей. Дополнительные сведения о OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
clientSecretCertificateThumbprint	Альтернатива секрету клиента— отпечаток сертификата, используемого для подписывания. Это свойство выступает в качестве замены секрета клиента. Это также необязательно.
clientSecretSettingName	Имя параметра приложения, содержащее секрет клиента приложения проверяющей стороны.
configVersion	Функция ConfigVersion функции проверки подлинности и авторизации, используемая для текущего приложения. Параметр в этом значении может управлять поведением плоскости управления для проверки подлинности или авторизации.
defaultProvider	Поставщик проверки подлинности по умолчанию, используемый при настройке нескольких поставщиков. Этот параметр необходим только в том случае, если настроено несколько поставщиков, а для действия клиента, не прошедших проверку подлинности, задано значение RedirectToLoginPage.
enabled	true, если функция проверки подлинности и авторизации включена для текущего приложения; в противном случае false.
facebookAppId	Идентификатор приложения Facebook, используемого для входа. Этот параметр необходим для включения входа в Facebook. Документация по входу в Facebook: https://developers.facebook.com/docs/facebook-login
facebookAppSecret	Секрет приложения Facebook, используемого для входа в Facebook. Этот параметр необходим для включения входа в Facebook. Документация по входу в Facebook: https://developers.facebook.com/docs/facebook-login
facebookAppSecretSettingName	Имя параметра приложения, содержащее секрет приложения, используемый для входа в Facebook.
facebookOAuthScopes	Области OAuth 2.0, которые будут запрашиваться в рамках проверки подлинности входа в Facebook. Этот параметр является необязательным. Документация по входу в Facebook: https://developers.facebook.com/docs/facebook-login
gitHubClientId	Идентификатор клиента приложения GitHub, используемого для входа. Этот параметр необходим для включения входа в Github
gitHubClientSecret	Секрет клиента приложения GitHub, используемого для входа в Github. Этот параметр необходим для включения входа в Github.
gitHubClientSecretSettingName	Имя параметра приложения, содержащее секрет клиента приложения Github, используемого для входа в GitHub.
gitHubOAuthScopes	Области OAuth 2.0, которые будут запрашиваться в рамках проверки подлинности входа GitHub. Этот параметр является необязательным
googleClientId	Идентификатор клиента OpenID Connect для веб-приложения Google. Этот параметр необходим для включения входа Google. Документация по Google Sign-In: https://developers.google.com/identity/sign-in/web/
googleClientSecret	Секрет клиента, связанный с веб-приложением Google. Этот параметр необходим для включения входа Google. Документация по Google Sign-In: https://developers.google.com/identity/sign-in/web/
googleClientSecretSettingName	Имя параметра приложения, содержащее секрет клиента, связанный с веб-приложением Google.
googleOAuthScopes	Области OAuth 2.0, которые будут запрашиваться в рамках проверки подлинности Google Sign-In. Этот параметр является необязательным. Если не указано, "openid", "profile" и "email" используются в качестве областей по умолчанию. Документация по Google Sign-In: https://developers.google.com/identity/sign-in/web/
isAuthFromFile	Значение true, если параметры конфигурации проверки подлинности должны быть прочитаны из файла, значение false в противном случае
issuer	URI издателя OpenID Connect, представляющий сущность, которая выдает маркеры доступа для этого приложения. При использовании Azure Active Directory это значение является универсальным кодом ресурса (URI) клиента каталога, например https://sts.windows.net/{tenant-guid}/. Этот универсальный код ресурса (URI) — это идентификатор, чувствительный к регистру для издателя маркеров. Дополнительные сведения об обнаружении OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html
microsoftAccountClientId	Идентификатор клиента OAuth 2.0, созданный для приложения, используемого для проверки подлинности. Этот параметр необходим для включения проверки подлинности учетной записи Майкрософт. Документация по OAuth учетной записи Майкрософт: https://dev.onedrive.com/auth/msa_oauth.htm
microsoftAccountClientSecret	Секрет клиента OAuth 2.0, созданный для приложения, используемого для проверки подлинности. Этот параметр необходим для включения проверки подлинности учетной записи Майкрософт. Документация по OAuth учетной записи Майкрософт: https://dev.onedrive.com/auth/msa_oauth.htm
microsoftAccountClientSecretSettingName	Имя параметра приложения, содержащее секрет клиента OAuth 2.0, созданный для приложения, используемого для проверки подлинности.
microsoftAccountOAuthScopes	Области OAuth 2.0, которые будут запрашиваться в рамках проверки подлинности учетной записи Майкрософт. Этот параметр является необязательным. Если значение не указано, значение wl.basic используется в качестве области по умолчанию. Документация по областям и разрешениям учетной записи Майкрософт: https://msdn.microsoft.com/en-us/library/dn631845.aspx
runtimeVersion	Среда выполнения функции проверки подлинности и авторизации, используемая для текущего приложения. Параметр в этом значении может управлять поведением определенных функций в модуле проверки подлинности и авторизации.
tokenRefreshExtensionHours	Количество часов после истечения срока действия маркера сеанса, которое можно использовать для вызова API обновления маркера. Значение по умолчанию — 72 часа.
tokenStoreEnabled	true для безопасного хранения маркеров безопасности для конкретной платформы, полученных во время потоков входа; в противном случае false. Значение по умолчанию — false.
twitterConsumerKey	Ключ потребителя OAuth 1.0a приложения Twitter, используемого для входа. Этот параметр необходим для включения входа в Twitter. Документация Sign-In Twitter: https://dev.twitter.com/web/sign-in
twitterConsumerSecret	Секрет потребителя OAuth 1.0a приложения Twitter, используемого для входа. Этот параметр необходим для включения входа в Twitter. Документация Sign-In Twitter: https://dev.twitter.com/web/sign-in
twitterConsumerSecretSettingName	Имя параметра приложения, содержащее секрет потребителя OAuth 1.0a приложения Twitter, используемого для входа.
unauthenticatedClientAction	Действие, которое необходимо предпринять, когда клиент, не прошедший проверку подлинности, пытается получить доступ к приложению.
validateIssuer	Возвращает значение, указывающее, должен ли издатель быть допустимым URL-адресом HTTPS и проверяться таким образом.

Унаследованные свойства

id	Идентификатор ресурса. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
kind	Тип ресурса.
name	Имя ресурса. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
type	Тип ресурса. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

Сведения о свойстве

aadClaimsAuthorization

Возвращает строку JSON, содержащую параметры Acl Azure AD.

aadClaimsAuthorization?: string

Значение свойства

string

additionalLoginParams

Параметры входа для отправки в конечную точку авторизации OpenID Connect при входе пользователя. Каждый параметр должен находиться в форме "key=value".

additionalLoginParams?: string[]

Значение свойства

string[]

allowedAudiences

Разрешены значения аудитории, которые следует учитывать при проверке веб-маркеров JSON, выданных Azure Active Directory. Обратите внимание, что значение ClientID всегда считается разрешенной аудиторией независимо от этого параметра.

allowedAudiences?: string[]

Значение свойства

string[]

allowedExternalRedirectUrls

Внешние URL-адреса, которые можно перенаправить в рамках входа или выхода из приложения. Обратите внимание, что часть строки запроса URL-адреса игнорируется. Это расширенный параметр, который обычно требуется только серверной части приложения Магазина Windows. Обратите внимание, что URL-адреса в текущем домене всегда неявно разрешены.

allowedExternalRedirectUrls?: string[]

Значение свойства

string[]

authFilePath

Путь к файлу конфигурации с параметрами проверки подлинности. Если путь является относительным, база будет корневой каталог сайта.

authFilePath?: string

Значение свойства

string

clientId

Идентификатор клиента этого проверяющего приложения, известного как client_id. Этот параметр необходим для включения проверки подлинности подключения OpenID с Помощью Azure Active Directory или других сторонних поставщиков OpenID Connect. Дополнительные сведения о OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html

clientId?: string

Значение свойства

string

clientSecret

Секрет клиента этого приложения проверяющей стороны (в Azure Active Directory это также называется ключом). Этот параметр является необязательным. Если секрет клиента не настроен, поток неявной проверки подлинности OpenID Connect используется для проверки подлинности конечных пользователей. В противном случае поток кода авторизации OpenID Connect используется для проверки подлинности конечных пользователей. Дополнительные сведения о OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html

clientSecret?: string

Значение свойства

string

clientSecretCertificateThumbprint

Альтернатива секрету клиента— отпечаток сертификата, используемого для подписывания. Это свойство выступает в качестве замены секрета клиента. Это также необязательно.

clientSecretCertificateThumbprint?: string

Значение свойства

string

clientSecretSettingName

Имя параметра приложения, содержащее секрет клиента приложения проверяющей стороны.

clientSecretSettingName?: string

Значение свойства

string

configVersion

Функция ConfigVersion функции проверки подлинности и авторизации, используемая для текущего приложения. Параметр в этом значении может управлять поведением плоскости управления для проверки подлинности или авторизации.

configVersion?: string

Значение свойства

string

defaultProvider

Поставщик проверки подлинности по умолчанию, используемый при настройке нескольких поставщиков. Этот параметр необходим только в том случае, если настроено несколько поставщиков, а для действия клиента, не прошедших проверку подлинности, задано значение RedirectToLoginPage.

defaultProvider?: BuiltInAuthenticationProvider

Значение свойства

BuiltInAuthenticationProvider

enabled

true, если функция проверки подлинности и авторизации включена для текущего приложения; в противном случае false.

enabled?: boolean

Значение свойства

boolean

facebookAppId

Идентификатор приложения Facebook, используемого для входа. Этот параметр необходим для включения входа в Facebook. Документация по входу в Facebook: https://developers.facebook.com/docs/facebook-login

facebookAppId?: string

Значение свойства

string

facebookAppSecret

Секрет приложения Facebook, используемого для входа в Facebook. Этот параметр необходим для включения входа в Facebook. Документация по входу в Facebook: https://developers.facebook.com/docs/facebook-login

facebookAppSecret?: string

Значение свойства

string

facebookAppSecretSettingName

Имя параметра приложения, содержащее секрет приложения, используемый для входа в Facebook.

facebookAppSecretSettingName?: string

Значение свойства

string

facebookOAuthScopes

Области OAuth 2.0, которые будут запрашиваться в рамках проверки подлинности входа в Facebook. Этот параметр является необязательным. Документация по входу в Facebook: https://developers.facebook.com/docs/facebook-login

facebookOAuthScopes?: string[]

Значение свойства

string[]

gitHubClientId

Идентификатор клиента приложения GitHub, используемого для входа. Этот параметр необходим для включения входа в Github

gitHubClientId?: string

Значение свойства

string

gitHubClientSecret

Секрет клиента приложения GitHub, используемого для входа в Github. Этот параметр необходим для включения входа в Github.

gitHubClientSecret?: string

Значение свойства

string

gitHubClientSecretSettingName

Имя параметра приложения, содержащее секрет клиента приложения Github, используемого для входа в GitHub.

gitHubClientSecretSettingName?: string

Значение свойства

string

gitHubOAuthScopes

Области OAuth 2.0, которые будут запрашиваться в рамках проверки подлинности входа GitHub. Этот параметр является необязательным

gitHubOAuthScopes?: string[]

Значение свойства

string[]

googleClientId

Идентификатор клиента OpenID Connect для веб-приложения Google. Этот параметр необходим для включения входа Google. Документация по Google Sign-In: https://developers.google.com/identity/sign-in/web/

googleClientId?: string

Значение свойства

string

googleClientSecret

Секрет клиента, связанный с веб-приложением Google. Этот параметр необходим для включения входа Google. Документация по Google Sign-In: https://developers.google.com/identity/sign-in/web/

googleClientSecret?: string

Значение свойства

string

googleClientSecretSettingName

Имя параметра приложения, содержащее секрет клиента, связанный с веб-приложением Google.

googleClientSecretSettingName?: string

Значение свойства

string

googleOAuthScopes

Области OAuth 2.0, которые будут запрашиваться в рамках проверки подлинности Google Sign-In. Этот параметр является необязательным. Если не указано, "openid", "profile" и "email" используются в качестве областей по умолчанию. Документация по Google Sign-In: https://developers.google.com/identity/sign-in/web/

googleOAuthScopes?: string[]

Значение свойства

string[]

isAuthFromFile

Значение true, если параметры конфигурации проверки подлинности должны быть прочитаны из файла, значение false в противном случае

isAuthFromFile?: string

Значение свойства

string

issuer

URI издателя OpenID Connect, представляющий сущность, которая выдает маркеры доступа для этого приложения. При использовании Azure Active Directory это значение является универсальным кодом ресурса (URI) клиента каталога, например https://sts.windows.net/{tenant-guid}/. Этот универсальный код ресурса (URI) — это идентификатор, чувствительный к регистру для издателя маркеров. Дополнительные сведения об обнаружении OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html

issuer?: string

Значение свойства

string

microsoftAccountClientId

Идентификатор клиента OAuth 2.0, созданный для приложения, используемого для проверки подлинности. Этот параметр необходим для включения проверки подлинности учетной записи Майкрософт. Документация по OAuth учетной записи Майкрософт: https://dev.onedrive.com/auth/msa_oauth.htm

microsoftAccountClientId?: string

Значение свойства

string

microsoftAccountClientSecret

Секрет клиента OAuth 2.0, созданный для приложения, используемого для проверки подлинности. Этот параметр необходим для включения проверки подлинности учетной записи Майкрософт. Документация по OAuth учетной записи Майкрософт: https://dev.onedrive.com/auth/msa_oauth.htm

microsoftAccountClientSecret?: string

Значение свойства

string

microsoftAccountClientSecretSettingName

Имя параметра приложения, содержащее секрет клиента OAuth 2.0, созданный для приложения, используемого для проверки подлинности.

microsoftAccountClientSecretSettingName?: string

Значение свойства

string

microsoftAccountOAuthScopes

Области OAuth 2.0, которые будут запрашиваться в рамках проверки подлинности учетной записи Майкрософт. Этот параметр является необязательным. Если значение не указано, значение wl.basic используется в качестве области по умолчанию. Документация по областям и разрешениям учетной записи Майкрософт: https://msdn.microsoft.com/en-us/library/dn631845.aspx

microsoftAccountOAuthScopes?: string[]

Значение свойства

string[]

runtimeVersion

Среда выполнения функции проверки подлинности и авторизации, используемая для текущего приложения. Параметр в этом значении может управлять поведением определенных функций в модуле проверки подлинности и авторизации.

runtimeVersion?: string

Значение свойства

string

tokenRefreshExtensionHours

Количество часов после истечения срока действия маркера сеанса, которое можно использовать для вызова API обновления маркера. Значение по умолчанию — 72 часа.

tokenRefreshExtensionHours?: number

Значение свойства

number

tokenStoreEnabled

true для безопасного хранения маркеров безопасности для конкретной платформы, полученных во время потоков входа; в противном случае false. Значение по умолчанию — false.

tokenStoreEnabled?: boolean

Значение свойства

boolean

twitterConsumerKey

Ключ потребителя OAuth 1.0a приложения Twitter, используемого для входа. Этот параметр необходим для включения входа в Twitter. Документация Sign-In Twitter: https://dev.twitter.com/web/sign-in

twitterConsumerKey?: string

Значение свойства

string

twitterConsumerSecret

Секрет потребителя OAuth 1.0a приложения Twitter, используемого для входа. Этот параметр необходим для включения входа в Twitter. Документация Sign-In Twitter: https://dev.twitter.com/web/sign-in

twitterConsumerSecret?: string

Значение свойства

string

twitterConsumerSecretSettingName

Имя параметра приложения, содержащее секрет потребителя OAuth 1.0a приложения Twitter, используемого для входа.

twitterConsumerSecretSettingName?: string

Значение свойства

string

unauthenticatedClientAction

Действие, которое необходимо предпринять, когда клиент, не прошедший проверку подлинности, пытается получить доступ к приложению.

unauthenticatedClientAction?: UnauthenticatedClientAction

Значение свойства

UnauthenticatedClientAction

validateIssuer

Возвращает значение, указывающее, должен ли издатель быть допустимым URL-адресом HTTPS и проверяться таким образом.

validateIssuer?: boolean

Значение свойства

boolean

Сведения об унаследованном свойстве

id

Идентификатор ресурса. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

id?: string

Значение свойства

string

унаследовано отProxyOnlyResource.id

kind

Тип ресурса.

kind?: string

Значение свойства

string

наследуется от прокси-сервера ProxyOnlyResource.kind

name

Имя ресурса. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

name?: string

Значение свойства

string

унаследован отProxyOnlyResource.name

type

Тип ресурса. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

type?: string

Значение свойства

string

Наследуется отProxyOnlyResource.type