Web Apps - Get Auth Settings
Описание получения параметров проверки подлинности и авторизации приложения.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list?api-version=2024-04-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
name
|
path | True |
string |
Имя приложения. |
resource
|
path | True |
string |
Имя группы ресурсов, к которой принадлежит ресурс. Шаблон регулярного выражения: |
subscription
|
path | True |
string |
Идентификатор подписки Azure. Это строка с форматом GUID (например, 0000000000-0000-0000-0000-00000000000000000000000000000). |
api-version
|
query | True |
string |
Версия API |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
ХОРОШО |
|
Other Status Codes |
Ответ об ошибке службы приложений. |
Безопасность
azure_auth
Поток OAuth2 Azure Active Directory
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
List Auth Settings
Образец запроса
Пример ответа
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings",
"name": "authsettings",
"type": "Microsoft.Web/sites/authsettings",
"kind": "app",
"properties": {
"enabled": true,
"runtimeVersion": "~1",
"unauthenticatedClientAction": "RedirectToLoginPage",
"tokenStoreEnabled": true,
"allowedExternalRedirectUrls": [
"sitef6141.customdomain.net",
"sitef6141.customdomain.info"
],
"defaultProvider": "Google",
"tokenRefreshExtensionHours": 120,
"clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"
}
}
Определения
Имя | Описание |
---|---|
Built |
Поставщик проверки подлинности по умолчанию, используемый при настройке нескольких поставщиков. Этот параметр необходим только в том случае, если настроено несколько поставщиков, а для действия клиента, не прошедших проверку подлинности, задано значение RedirectToLoginPage. |
Default |
Ответ об ошибке службы приложений. |
Details | |
Error |
Модель ошибок. |
Site |
Параметры конфигурации для функции проверки подлинности и авторизации службы приложений Azure. |
Unauthenticated |
Действие, которое необходимо предпринять, когда клиент, не прошедший проверку подлинности, пытается получить доступ к приложению. |
BuiltInAuthenticationProvider
Поставщик проверки подлинности по умолчанию, используемый при настройке нескольких поставщиков. Этот параметр необходим только в том случае, если настроено несколько поставщиков, а для действия клиента, не прошедших проверку подлинности, задано значение RedirectToLoginPage.
Значение | Описание |
---|---|
AzureActiveDirectory | |
Github | |
MicrosoftAccount | |
DefaultErrorResponse
Ответ об ошибке службы приложений.
Имя | Тип | Описание |
---|---|---|
error |
Модель ошибок. |
Details
Имя | Тип | Описание |
---|---|---|
code |
string |
Стандартизованная строка для программной идентификации ошибки. |
message |
string |
Подробные сведения об ошибке и сведения об отладке. |
target |
string |
Подробные сведения об ошибке и сведения об отладке. |
Error
Модель ошибок.
Имя | Тип | Описание |
---|---|---|
code |
string |
Стандартизованная строка для программной идентификации ошибки. |
details |
Details[] |
Подробные ошибки. |
innererror |
string |
Дополнительные сведения об ошибке отладки. |
message |
string |
Подробные сведения об ошибке и сведения об отладке. |
target |
string |
Подробные сведения об ошибке и сведения об отладке. |
SiteAuthSettings
Параметры конфигурации для функции проверки подлинности и авторизации службы приложений Azure.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса. |
kind |
string |
Тип ресурса. |
name |
string |
Имя ресурса. |
properties.aadClaimsAuthorization |
string |
Возвращает строку JSON, содержащую параметры Acl Azure AD. |
properties.additionalLoginParams |
string[] |
Параметры входа для отправки в конечную точку авторизации OpenID Connect при входе пользователя. Каждый параметр должен находиться в форме "key=value". |
properties.allowedAudiences |
string[] |
Разрешены значения аудитории, которые следует учитывать при проверке веб-маркеров JSON, выданных Azure Active Directory. Обратите внимание, что значение |
properties.allowedExternalRedirectUrls |
string[] |
Внешние URL-адреса, которые можно перенаправить в рамках входа или выхода из приложения. Обратите внимание, что часть строки запроса URL-адреса игнорируется. Это расширенный параметр, который обычно требуется только серверной части приложения Магазина Windows. Обратите внимание, что URL-адреса в текущем домене всегда неявно разрешены. |
properties.authFilePath |
string |
Путь к файлу конфигурации с параметрами проверки подлинности. Если путь является относительным, база будет корневой каталог сайта. |
properties.clientId |
string |
Идентификатор клиента этого проверяющего приложения, известного как client_id. Этот параметр необходим для включения проверки подлинности подключения OpenID с Помощью Azure Active Directory или других сторонних поставщиков OpenID Connect. Дополнительные сведения о OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html |
properties.clientSecret |
string |
Секрет клиента этого приложения проверяющей стороны (в Azure Active Directory это также называется ключом). Этот параметр является необязательным. Если секрет клиента не настроен, поток неявной проверки подлинности OpenID Connect используется для проверки подлинности конечных пользователей. В противном случае поток кода авторизации OpenID Connect используется для проверки подлинности конечных пользователей. Дополнительные сведения о OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html |
properties.clientSecretCertificateThumbprint |
string |
Альтернатива секрету клиента— отпечаток сертификата, используемого для подписывания. Это свойство выступает в качестве замены секрета клиента. Это также необязательно. |
properties.clientSecretSettingName |
string |
Имя параметра приложения, содержащее секрет клиента приложения проверяющей стороны. |
properties.configVersion |
string |
Функция ConfigVersion функции проверки подлинности и авторизации, используемая для текущего приложения. Параметр в этом значении может управлять поведением плоскости управления для проверки подлинности или авторизации. |
properties.defaultProvider |
Поставщик проверки подлинности по умолчанию, используемый при настройке нескольких поставщиков. Этот параметр необходим только в том случае, если настроено несколько поставщиков, а для действия клиента, не прошедших проверку подлинности, задано значение RedirectToLoginPage. |
|
properties.enabled |
boolean |
|
properties.facebookAppId |
string |
Идентификатор приложения Facebook, используемого для входа. Этот параметр необходим для включения входа в Facebook. Документация по входу в Facebook: https://developers.facebook.com/docs/facebook-login |
properties.facebookAppSecret |
string |
Секрет приложения Facebook, используемого для входа в Facebook. Этот параметр необходим для включения входа в Facebook. Документация по входу в Facebook: https://developers.facebook.com/docs/facebook-login |
properties.facebookAppSecretSettingName |
string |
Имя параметра приложения, содержащее секрет приложения, используемый для входа в Facebook. |
properties.facebookOAuthScopes |
string[] |
Области OAuth 2.0, которые будут запрашиваться в рамках проверки подлинности входа в Facebook. Этот параметр является необязательным. Документация по входу в Facebook: https://developers.facebook.com/docs/facebook-login |
properties.gitHubClientId |
string |
Идентификатор клиента приложения GitHub, используемого для входа. Этот параметр необходим для включения входа в Github |
properties.gitHubClientSecret |
string |
Секрет клиента приложения GitHub, используемого для входа в Github. Этот параметр необходим для включения входа в Github. |
properties.gitHubClientSecretSettingName |
string |
Имя параметра приложения, содержащее секрет клиента приложения Github, используемого для входа в GitHub. |
properties.gitHubOAuthScopes |
string[] |
Области OAuth 2.0, которые будут запрашиваться в рамках проверки подлинности входа GitHub. Этот параметр является необязательным |
properties.googleClientId |
string |
Идентификатор клиента OpenID Connect для веб-приложения Google. Этот параметр необходим для включения входа Google. Документация по Google Sign-In: https://developers.google.com/identity/sign-in/web/ |
properties.googleClientSecret |
string |
Секрет клиента, связанный с веб-приложением Google. Этот параметр необходим для включения входа Google. Документация по Google Sign-In: https://developers.google.com/identity/sign-in/web/ |
properties.googleClientSecretSettingName |
string |
Имя параметра приложения, содержащее секрет клиента, связанный с веб-приложением Google. |
properties.googleOAuthScopes |
string[] |
Области OAuth 2.0, которые будут запрашиваться в рамках проверки подлинности Google Sign-In. Этот параметр является необязательным. Если не указано, "openid", "profile" и "email" используются в качестве областей по умолчанию. Документация по Google Sign-In: https://developers.google.com/identity/sign-in/web/ |
properties.isAuthFromFile |
string |
Значение true, если параметры конфигурации проверки подлинности должны быть прочитаны из файла, значение false в противном случае |
properties.issuer |
string |
URI издателя OpenID Connect, представляющий сущность, которая выдает маркеры доступа для этого приложения.
При использовании Azure Active Directory это значение является универсальным кодом ресурса (URI) клиента каталога, например |
properties.microsoftAccountClientId |
string |
Идентификатор клиента OAuth 2.0, созданный для приложения, используемого для проверки подлинности. Этот параметр необходим для включения проверки подлинности учетной записи Майкрософт. Документация по OAuth учетной записи Майкрософт: https://dev.onedrive.com/auth/msa_oauth.htm |
properties.microsoftAccountClientSecret |
string |
Секрет клиента OAuth 2.0, созданный для приложения, используемого для проверки подлинности. Этот параметр необходим для включения проверки подлинности учетной записи Майкрософт. Документация по OAuth учетной записи Майкрософт: https://dev.onedrive.com/auth/msa_oauth.htm |
properties.microsoftAccountClientSecretSettingName |
string |
Имя параметра приложения, содержащее секрет клиента OAuth 2.0, созданный для приложения, используемого для проверки подлинности. |
properties.microsoftAccountOAuthScopes |
string[] |
Области OAuth 2.0, которые будут запрашиваться в рамках проверки подлинности учетной записи Майкрософт. Этот параметр является необязательным. Если значение не указано, значение wl.basic используется в качестве области по умолчанию. Документация по областям и разрешениям учетной записи Майкрософт: https://msdn.microsoft.com/en-us/library/dn631845.aspx |
properties.runtimeVersion |
string |
Среда выполнения функции проверки подлинности и авторизации, используемая для текущего приложения. Параметр в этом значении может управлять поведением определенных функций в модуле проверки подлинности и авторизации. |
properties.tokenRefreshExtensionHours |
number |
Количество часов после истечения срока действия маркера сеанса, которое можно использовать для вызова API обновления маркера. Значение по умолчанию — 72 часа. |
properties.tokenStoreEnabled |
boolean |
|
properties.twitterConsumerKey |
string |
Ключ потребителя OAuth 1.0a приложения Twitter, используемого для входа. Этот параметр необходим для включения входа в Twitter. Документация Sign-In Twitter: https://dev.twitter.com/web/sign-in |
properties.twitterConsumerSecret |
string |
Секрет потребителя OAuth 1.0a приложения Twitter, используемого для входа. Этот параметр необходим для включения входа в Twitter. Документация Sign-In Twitter: https://dev.twitter.com/web/sign-in |
properties.twitterConsumerSecretSettingName |
string |
Имя параметра приложения, содержащее секрет потребителя OAuth 1.0a приложения Twitter, используемого для входа. |
properties.unauthenticatedClientAction |
Действие, которое необходимо предпринять, когда клиент, не прошедший проверку подлинности, пытается получить доступ к приложению. |
|
properties.validateIssuer |
boolean |
Возвращает значение, указывающее, должен ли издатель быть допустимым URL-адресом HTTPS и проверяться таким образом. |
type |
string |
Тип ресурса. |
UnauthenticatedClientAction
Действие, которое необходимо предпринять, когда клиент, не прошедший проверку подлинности, пытается получить доступ к приложению.
Значение | Описание |
---|---|
AllowAnonymous | |
RedirectToLoginPage |