Web Apps - Get Auth Settings V2 Slot
Описание получения параметров проверки подлинности и авторизации сайта для приложений в формате V2
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2/list?api-version=2023-12-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
name
|
path | True |
string |
Имя приложения |
resource
|
path | True |
string |
Имя группы ресурсов, к которой принадлежит ресурс. Regex pattern: |
slot
|
path | True |
string |
Имя слота развертывания. Если слот не указан, API получит параметры рабочего слота. |
subscription
|
path | True |
string |
Идентификатор вашей подписки Azure. Это строка в формате GUID (например, 0000000-0000-0000-0000-0000-000000000000). |
api-version
|
query | True |
string |
Версия API |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
ОК |
|
Other Status Codes |
Служба приложений ответ об ошибке. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Определения
Имя | Описание |
---|---|
Allowed |
Параметры конфигурации потока проверки разрешенных аудиторий. |
Allowed |
Параметры конфигурации разрешенных субъектов Azure Active Directory. |
Apple |
Параметры конфигурации поставщика Apple. |
Apple |
Параметры конфигурации регистрации для поставщика Apple |
App |
Параметры конфигурации регистрации приложения для поставщиков, имеющих идентификаторы приложений и секреты приложения |
Auth |
Параметры конфигурации платформы Служба приложений проверка подлинности и авторизация. |
Azure |
Параметры конфигурации поставщика Azure Active Directory. |
Azure |
Параметры конфигурации потока входа Azure Active Directory. |
Azure |
Параметры конфигурации регистрации приложения Azure Active Directory. |
Azure |
Параметры конфигурации потока проверки маркеров Azure Active Directory. |
Azure |
Параметры конфигурации поставщика Статические веб-приложения Azure. |
Azure |
Параметры конфигурации регистрации для поставщика Статические веб-приложения Azure |
Blob |
Параметры конфигурации хранилища маркеров, если используется хранилище BLOB-объектов. |
Client |
Метод, который должен использоваться для проверки подлинности пользователя. |
Client |
Параметры конфигурации регистрации приложения для поставщиков, имеющих идентификаторы клиентов и секреты клиента |
Cookie |
Параметры конфигурации срока действия файла cookie сеанса. |
Cookie |
Соглашение, используемое при определении срока действия файла cookie сеанса. |
Custom |
Параметры конфигурации настраиваемого поставщика Open ID Connect. |
Default |
Параметры конфигурации политики авторизации Azure Active Directory по умолчанию. |
Default |
Служба приложений ответ об ошибке. |
Details | |
Error |
Модель ошибок. |
Параметры конфигурации поставщика Facebook. |
|
File |
Параметры конфигурации хранилища маркеров, если используется файловая система. |
Forward |
Параметры конфигурации прокси-сервера пересылки, используемого для выполнения запросов. |
Forward |
Соглашение, используемое для определения URL-адреса выполненного запроса. |
Git |
Параметры конфигурации поставщика GitHub. |
Global |
Параметры конфигурации, определяющие поток проверки пользователей, использующих Служба приложений проверка подлинности и авторизация. |
Параметры конфигурации поставщика Google. |
|
Http |
Параметры конфигурации HTTP-запросов для проверки подлинности и запросов авторизации, выполненных в Служба приложений Authentication/Authorization. |
Http |
Параметры конфигурации путей HTTP-запросов. |
Identity |
Параметры конфигурации каждого поставщика удостоверений, используемых для настройки Служба приложений аутентификации и авторизации. |
Jwt |
Параметры конфигурации проверок, которые должны выполняться при проверке утверждений JWT. |
Legacy |
Параметры конфигурации устаревшего поставщика учетных записей Майкрософт. |
Login |
Параметры конфигурации потока входа пользователей, использующих Служба приложений проверка подлинности и авторизация. |
Login |
Маршруты, определяющие конечные точки, используемые для запросов на вход и выход. |
Login |
Параметры конфигурации потока входа, включая области, которые должны быть запрошены. |
Nonce |
Параметры конфигурации nonce, используемого в потоке входа. |
Open |
Учетные данные клиента проверки подлинности настраиваемого поставщика Open ID Connect. |
Open |
Параметры конфигурации конечных точек, используемых для настраиваемого поставщика Open ID Connect. |
Open |
Параметры конфигурации потока входа настраиваемого поставщика Open ID Connect. |
Open |
Параметры конфигурации регистрации приложения для настраиваемого поставщика Open ID Connect. |
Site |
Параметры конфигурации для функции проверки подлинности и авторизации Служба приложений Azure версии 2. |
Token |
Параметры конфигурации хранилища маркеров. |
Параметры конфигурации поставщика Twitter. |
|
Twitter |
Параметры конфигурации регистрации приложения для поставщика Twitter. |
Unauthenticated |
Действие, выполняемое при попытке клиента без проверки подлинности получить доступ к приложению. |
AllowedAudiencesValidation
Параметры конфигурации потока проверки разрешенных аудиторий.
Имя | Тип | Описание |
---|---|---|
allowedAudiences |
string[] |
Параметры конфигурации списка разрешенных аудиторий для проверки маркера JWT. |
AllowedPrincipals
Параметры конфигурации разрешенных субъектов Azure Active Directory.
Имя | Тип | Описание |
---|---|---|
groups |
string[] |
Список разрешенных групп. |
identities |
string[] |
Список разрешенных удостоверений. |
Apple
Параметры конфигурации поставщика Apple.
Имя | Тип | Описание |
---|---|---|
enabled |
boolean |
|
login |
Параметры конфигурации потока входа. |
|
registration |
Параметры конфигурации регистрации Apple. |
AppleRegistration
Параметры конфигурации регистрации для поставщика Apple
Имя | Тип | Описание |
---|---|---|
clientId |
string |
Идентификатор клиента приложения, используемого для входа. |
clientSecretSettingName |
string |
Имя параметра приложения, содержащего секрет клиента. |
AppRegistration
Параметры конфигурации регистрации приложения для поставщиков, имеющих идентификаторы приложений и секреты приложения
Имя | Тип | Описание |
---|---|---|
appId |
string |
Идентификатор приложения, используемого для входа. |
appSecretSettingName |
string |
Имя параметра приложения, содержащего секрет приложения. |
AuthPlatform
Параметры конфигурации платформы Служба приложений проверка подлинности и авторизация.
Имя | Тип | Описание |
---|---|---|
configFilePath |
string |
Путь к файлу конфигурации с параметрами проверки подлинности, если они поступают из файла. Если путь относительный, базовым будет корневой каталог сайта. |
enabled |
boolean |
|
runtimeVersion |
string |
RuntimeVersion функции проверки подлинности и авторизации, используемой для текущего приложения. Параметр в этом значении может управлять поведением определенных функций в модуле Проверка подлинности и авторизация. |
AzureActiveDirectory
Параметры конфигурации поставщика Azure Active Directory.
Имя | Тип | Описание |
---|---|---|
enabled |
boolean |
|
isAutoProvisioned |
boolean |
Возвращает значение, указывающее, была ли конфигурация Azure AD автоматически подготовлена с помощью сторонних инструментов. Это внутренний флаг, предназначенный в основном для поддержки портала управления Azure. Пользователи не должны выполнять чтение или запись в это свойство. |
login |
Параметры конфигурации потока входа Azure Active Directory. |
|
registration |
Параметры конфигурации регистрации приложения Azure Active Directory. |
|
validation |
Параметры конфигурации потока проверки маркеров Azure Active Directory. |
AzureActiveDirectoryLogin
Параметры конфигурации потока входа Azure Active Directory.
Имя | Тип | Описание |
---|---|---|
disableWWWAuthenticate |
boolean |
|
loginParameters |
string[] |
Параметры входа для отправки в конечную точку авторизации OpenID Connect при входе пользователя. Каждый параметр должен иметь вид "key=value". |
AzureActiveDirectoryRegistration
Параметры конфигурации регистрации приложения Azure Active Directory.
Имя | Тип | Описание |
---|---|---|
clientId |
string |
Идентификатор клиента этого приложения проверяющей стороны, известный как client_id. Этот параметр необходим для включения проверки подлинности Подключения OpenID с помощью Azure Active Directory или других сторонних поставщиков OpenID Connect. Дополнительные сведения об OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html |
clientSecretCertificateIssuer |
string |
Альтернатива отпечатку секрета клиента, который является издателем сертификата, используемого для подписывания. Это свойство служит заменой отпечатка сертификата секрета клиента. Он также является необязательным. |
clientSecretCertificateSubjectAlternativeName |
string |
Альтернатива отпечатку секрета клиента, то есть альтернативное имя субъекта сертификата, используемого для подписывания. Это свойство служит заменой отпечатка сертификата секрета клиента. Он также является необязательным. |
clientSecretCertificateThumbprint |
string |
Альтернатива секрету клиента, то есть отпечатку сертификата, используемого для подписывания. Это свойство служит заменой секрета клиента. Он также является необязательным. |
clientSecretSettingName |
string |
Имя параметра приложения, содержащего секрет клиента приложения проверяющей стороны. |
openIdIssuer |
string |
URI издателя OpenID Connect, представляющий сущность, которая выдает маркеры доступа для этого приложения. При использовании Azure Active Directory это значение является универсальным кодом ресурса (URI) клиента каталога, например https://login.microsoftonline.com/v2.0/{tenant-guid}/. Этот универсальный код ресурса (URI) является идентификатором с учетом регистра для издателя маркера. Дополнительные сведения об обнаружении OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html |
AzureActiveDirectoryValidation
Параметры конфигурации потока проверки маркеров Azure Active Directory.
Имя | Тип | Описание |
---|---|---|
allowedAudiences |
string[] |
Список аудиторий, которые могут успешно выполнять запросы проверки подлинности и авторизации. |
defaultAuthorizationPolicy |
Параметры конфигурации политики авторизации по умолчанию. |
|
jwtClaimChecks |
Параметры конфигурации проверок, которые должны выполняться при проверке утверждений JWT. |
AzureStaticWebApps
Параметры конфигурации поставщика Статические веб-приложения Azure.
Имя | Тип | Описание |
---|---|---|
enabled |
boolean |
|
registration |
Параметры конфигурации регистрации Статические веб-приложения Azure. |
AzureStaticWebAppsRegistration
Параметры конфигурации регистрации для поставщика Статические веб-приложения Azure
Имя | Тип | Описание |
---|---|---|
clientId |
string |
Идентификатор клиента приложения, используемого для входа. |
BlobStorageTokenStore
Параметры конфигурации хранилища маркеров, если используется хранилище BLOB-объектов.
Имя | Тип | Описание |
---|---|---|
sasUrlSettingName |
string |
Имя параметра приложения, содержащего URL-адрес SAS хранилища BLOB-объектов, содержащего маркеры. |
ClientCredentialMethod
Метод, который должен использоваться для проверки подлинности пользователя.
Имя | Тип | Описание |
---|---|---|
ClientSecretPost |
string |
ClientRegistration
Параметры конфигурации регистрации приложения для поставщиков, имеющих идентификаторы клиентов и секреты клиента
Имя | Тип | Описание |
---|---|---|
clientId |
string |
Идентификатор клиента приложения, используемого для входа. |
clientSecretSettingName |
string |
Имя параметра приложения, содержащего секрет клиента. |
CookieExpiration
Параметры конфигурации срока действия файла cookie сеанса.
Имя | Тип | Описание |
---|---|---|
convention |
Соглашение, используемое при определении срока действия файла cookie сеанса. |
|
timeToExpiration |
string |
Время после выполнения запроса, когда истечет срок действия файла cookie сеанса. |
CookieExpirationConvention
Соглашение, используемое при определении срока действия файла cookie сеанса.
Имя | Тип | Описание |
---|---|---|
FixedTime |
string |
|
IdentityProviderDerived |
string |
CustomOpenIdConnectProvider
Параметры конфигурации настраиваемого поставщика Open ID Connect.
Имя | Тип | Описание |
---|---|---|
enabled |
boolean |
|
login |
Параметры конфигурации потока входа пользовательского поставщика Open ID Connect. |
|
registration |
Параметры конфигурации регистрации приложения для настраиваемого поставщика Open ID Connect. |
DefaultAuthorizationPolicy
Параметры конфигурации политики авторизации Azure Active Directory по умолчанию.
Имя | Тип | Описание |
---|---|---|
allowedApplications |
string[] |
Параметры конфигурации разрешенных приложений Azure Active Directory. |
allowedPrincipals |
Параметры конфигурации разрешенных субъектов Azure Active Directory. |
DefaultErrorResponse
Служба приложений ответ об ошибке.
Имя | Тип | Описание |
---|---|---|
error |
Модель ошибок. |
Details
Имя | Тип | Описание |
---|---|---|
code |
string |
Стандартизированная строка для программного определения ошибки. |
message |
string |
Подробное описание ошибки и сведения об отладке. |
target |
string |
Подробное описание ошибки и сведения об отладке. |
Error
Модель ошибок.
Имя | Тип | Описание |
---|---|---|
code |
string |
Стандартизированная строка для программной идентификации ошибки. |
details |
Details[] |
Подробные сведения об ошибках. |
innererror |
string |
Дополнительные сведения об ошибке отладки. |
message |
string |
Подробное описание ошибки и сведения об отладке. |
target |
string |
Подробное описание ошибки и сведения об отладке. |
Параметры конфигурации поставщика Facebook.
Имя | Тип | Описание |
---|---|---|
enabled |
boolean |
|
graphApiVersion |
string |
Версия api Facebook, используемого при входе в систему. |
login |
Параметры конфигурации потока входа. |
|
registration |
Параметры конфигурации регистрации приложения для поставщика Facebook. |
FileSystemTokenStore
Параметры конфигурации хранилища маркеров, если используется файловая система.
Имя | Тип | Описание |
---|---|---|
directory |
string |
Каталог, в котором будут храниться маркеры. |
ForwardProxy
Параметры конфигурации прокси-сервера пересылки, используемого для выполнения запросов.
Имя | Тип | Описание |
---|---|---|
convention |
Соглашение, используемое для определения URL-адреса выполненного запроса. |
|
customHostHeaderName |
string |
Имя заголовка, содержащего узел запроса. |
customProtoHeaderName |
string |
Имя заголовка, содержащего схему запроса. |
ForwardProxyConvention
Соглашение, используемое для определения URL-адреса выполненного запроса.
Имя | Тип | Описание |
---|---|---|
Custom |
string |
|
NoProxy |
string |
|
Standard |
string |
GitHub
Параметры конфигурации поставщика GitHub.
Имя | Тип | Описание |
---|---|---|
enabled |
boolean |
|
login |
Параметры конфигурации потока входа. |
|
registration |
Параметры конфигурации регистрации приложения для поставщика GitHub. |
GlobalValidation
Параметры конфигурации, определяющие поток проверки пользователей, использующих Служба приложений проверка подлинности и авторизация.
Имя | Тип | Описание |
---|---|---|
excludedPaths |
string[] |
Пути, для которых поток без проверки подлинности не будет перенаправляться на страницу входа. |
redirectToProvider |
string |
Поставщик проверки подлинности по умолчанию, используемый при настройке нескольких поставщиков. Этот параметр необходим, только если настроено несколько поставщиков и для действия клиента без проверки подлинности задано значение RedirectToLoginPage. |
requireAuthentication |
boolean |
|
unauthenticatedClientAction |
Действие, выполняемое при попытке клиента без проверки подлинности получить доступ к приложению. |
Параметры конфигурации поставщика Google.
Имя | Тип | Описание |
---|---|---|
enabled |
boolean |
|
login |
Параметры конфигурации потока входа. |
|
registration |
Параметры конфигурации регистрации приложения для поставщика Google. |
|
validation |
Параметры конфигурации потока проверки маркеров Azure Active Directory. |
HttpSettings
Параметры конфигурации HTTP-запросов для проверки подлинности и запросов авторизации, выполненных в Служба приложений Authentication/Authorization.
Имя | Тип | Описание |
---|---|---|
forwardProxy |
Параметры конфигурации прокси-сервера пересылки, используемые для выполнения запросов. |
|
requireHttps |
boolean |
|
routes |
Параметры конфигурации http-запросов путей. |
HttpSettingsRoutes
Параметры конфигурации путей HTTP-запросов.
Имя | Тип | Описание |
---|---|---|
apiPrefix |
string |
Префикс, который должен предшествовать всем путям проверки подлинности и авторизации. |
IdentityProviders
Параметры конфигурации каждого поставщика удостоверений, используемых для настройки Служба приложений аутентификации и авторизации.
Имя | Тип | Описание |
---|---|---|
apple |
Параметры конфигурации поставщика Apple. |
|
azureActiveDirectory |
Параметры конфигурации поставщика Azure Active Directory. |
|
azureStaticWebApps |
Параметры конфигурации поставщика Статические веб-приложения Azure. |
|
customOpenIdConnectProviders |
<string,
Custom |
Сопоставление имени псевдонима каждого настраиваемого поставщика Open ID Connect с параметрами конфигурации настраиваемого поставщика Open ID Connect. |
Параметры конфигурации поставщика Facebook. |
||
gitHub |
Параметры конфигурации поставщика GitHub. |
|
Параметры конфигурации поставщика Google. |
||
legacyMicrosoftAccount |
Параметры конфигурации устаревшего поставщика учетных записей Майкрософт. |
|
Параметры конфигурации поставщика Twitter. |
JwtClaimChecks
Параметры конфигурации проверок, которые должны выполняться при проверке утверждений JWT.
Имя | Тип | Описание |
---|---|---|
allowedClientApplications |
string[] |
Список разрешенных клиентских приложений. |
allowedGroups |
string[] |
Список разрешенных групп. |
LegacyMicrosoftAccount
Параметры конфигурации устаревшего поставщика учетных записей Майкрософт.
Имя | Тип | Описание |
---|---|---|
enabled |
boolean |
|
login |
Параметры конфигурации потока входа. |
|
registration |
Параметры конфигурации регистрации приложения для устаревшего поставщика учетных записей Майкрософт. |
|
validation |
Параметры конфигурации устаревшего потока проверки маркеров поставщика учетных записей Майкрософт. |
Login
Параметры конфигурации потока входа пользователей, использующих Служба приложений проверка подлинности и авторизация.
Имя | Тип | Описание |
---|---|---|
allowedExternalRedirectUrls |
string[] |
Внешние URL-адреса, на которые можно перенаправляться при входе в приложение или выходе из него. Обратите внимание, что часть строки запроса в URL-адресе игнорируется. Это расширенный параметр, который обычно требуется только серверной части приложений Магазина Windows. Обратите внимание, что URL-адреса в текущем домене всегда неявно разрешены. |
cookieExpiration |
Параметры конфигурации для истечения срока действия файла cookie сеанса. |
|
nonce |
Параметры конфигурации nonce, используемого в потоке входа. |
|
preserveUrlFragmentsForLogins |
boolean |
|
routes |
Маршруты, определяющие конечные точки, используемые для запросов на вход и выход. |
|
tokenStore |
Параметры конфигурации хранилища маркеров. |
LoginRoutes
Маршруты, определяющие конечные точки, используемые для запросов на вход и выход.
Имя | Тип | Описание |
---|---|---|
logoutEndpoint |
string |
Конечная точка, в которой должен быть выполнен запрос на выход. |
LoginScopes
Параметры конфигурации потока входа, включая области, которые должны быть запрошены.
Имя | Тип | Описание |
---|---|---|
scopes |
string[] |
Список областей, которые следует запрашивать при проверке подлинности. |
Nonce
Параметры конфигурации nonce, используемого в потоке входа.
Имя | Тип | Описание |
---|---|---|
nonceExpirationInterval |
string |
Время после выполнения запроса, в течение которого истекает срок действия nonce. |
validateNonce |
boolean |
|
OpenIdConnectClientCredential
Учетные данные клиента проверки подлинности настраиваемого поставщика Open ID Connect.
Имя | Тип | Описание |
---|---|---|
clientSecretSettingName |
string |
Параметр приложения, содержащий секрет клиента для настраиваемого поставщика Open ID Connect. |
method |
Метод, который должен использоваться для проверки подлинности пользователя. |
OpenIdConnectConfig
Параметры конфигурации конечных точек, используемых для настраиваемого поставщика Open ID Connect.
Имя | Тип | Описание |
---|---|---|
authorizationEndpoint |
string |
Конечная точка, используемая для выполнения запроса авторизации. |
certificationUri |
string |
Конечная точка, которая предоставляет ключи, необходимые для проверки маркера. |
issuer |
string |
Конечная точка, которая выдает маркер. |
tokenEndpoint |
string |
Конечная точка, используемая для запроса маркера. |
wellKnownOpenIdConfiguration |
string |
Конечная точка, содержащая все конечные точки конфигурации для поставщика. |
OpenIdConnectLogin
Параметры конфигурации потока входа настраиваемого поставщика Open ID Connect.
Имя | Тип | Описание |
---|---|---|
nameClaimType |
string |
Имя утверждения, содержащего имя пользователя. |
scopes |
string[] |
Список областей, которые следует запрашивать при проверке подлинности. |
OpenIdConnectRegistration
Параметры конфигурации регистрации приложения для настраиваемого поставщика Open ID Connect.
Имя | Тип | Описание |
---|---|---|
clientCredential |
Учетные данные проверки подлинности настраиваемого поставщика Open ID Connect. |
|
clientId |
string |
Идентификатор клиента настраиваемого поставщика Open ID Connect. |
openIdConnectConfiguration |
Параметры конфигурации конечных точек, используемых для настраиваемого поставщика Open ID Connect. |
SiteAuthSettingsV2
Параметры конфигурации для функции проверки подлинности и авторизации Служба приложений Azure версии 2.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса. |
kind |
string |
Тип ресурса. |
name |
string |
Имя ресурса. |
properties.globalValidation |
Параметры конфигурации, определяющие поток проверки пользователей, использующих Служба приложений проверка подлинности и авторизация. |
|
properties.httpSettings |
Параметры конфигурации HTTP-запросов для проверки подлинности и запросов авторизации, выполненных в Служба приложений Authentication/Authorization. |
|
properties.identityProviders |
Параметры конфигурации каждого поставщика удостоверений, используемых для настройки Служба приложений аутентификации и авторизации. |
|
properties.login |
Параметры конфигурации потока входа пользователей, использующих Служба приложений проверка подлинности и авторизация. |
|
properties.platform |
Параметры конфигурации платформы Служба приложений проверка подлинности и авторизация. |
|
type |
string |
Тип ресурса. |
TokenStore
Параметры конфигурации хранилища маркеров.
Имя | Тип | Описание |
---|---|---|
azureBlobStorage |
Параметры конфигурации хранилища маркеров, если используется хранилище BLOB-объектов. |
|
enabled |
boolean |
|
fileSystem |
Параметры конфигурации хранилища маркеров, если используется файловая система. |
|
tokenRefreshExtensionHours |
number |
Количество часов после истечения срока действия маркера сеанса, которое можно использовать для вызова API обновления маркера. По умолчанию — 72 часа. |
Параметры конфигурации поставщика Twitter.
Имя | Тип | Описание |
---|---|---|
enabled |
boolean |
|
registration |
Параметры конфигурации регистрации приложения для поставщика Twitter. |
TwitterRegistration
Параметры конфигурации регистрации приложения для поставщика Twitter.
Имя | Тип | Описание |
---|---|---|
consumerKey |
string |
Ключ потребителя OAuth 1.0a приложения Twitter, используемого для входа. Этот параметр необходим для включения входа в Twitter. Документация по Sign-In Twitter: https://dev.twitter.com/web/sign-in |
consumerSecretSettingName |
string |
Имя параметра приложения, содержащее секрет потребителя OAuth 1.0a приложения Twitter, используемого для входа. |
UnauthenticatedClientActionV2
Действие, выполняемое при попытке клиента без проверки подлинности получить доступ к приложению.
Имя | Тип | Описание |
---|---|---|
AllowAnonymous |
string |
|
RedirectToLoginPage |
string |
|
Return401 |
string |
|
Return403 |
string |