Web Apps - Get Auth Settings

Описание для возвращает параметры проверки подлинности и авторизации приложения.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list?api-version=2023-01-01

Параметры URI

Имя В Обязательно Тип Описание
name
path True

string

Имя приложения

resourceGroupName
path True

string

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

Regex pattern: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

Идентификатор вашей подписки Azure. Это строка в формате GUID (например, 000000000-0000-0000-0000-000000000000000000000).

api-version
query True

string

Версия API

Ответы

Имя Тип Описание
200 OK

SiteAuthSettings

ОК

Other Status Codes

DefaultErrorResponse

Служба приложений ответ об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

List Auth Settings

Sample Request

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings/list?api-version=2023-01-01

Sample Response

{
  "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"
  }
}

Определения

Имя Описание
BuiltInAuthenticationProvider

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

DefaultErrorResponse

Служба приложений ответ об ошибке.

Details
Error

Модель ошибок.

SiteAuthSettings

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

UnauthenticatedClientAction

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

BuiltInAuthenticationProvider

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

Имя Тип Описание
AzureActiveDirectory

string

Facebook

string

Github

string

Google

string

MicrosoftAccount

string

Twitter

string

DefaultErrorResponse

Служба приложений ответ об ошибке.

Имя Тип Описание
error

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. Обратите внимание, что ClientID значение всегда считается разрешенной аудиторией, независимо от этого параметра.

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

BuiltInAuthenticationProvider

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

properties.enabled

boolean

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

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 Login. Этот параметр является необязательным

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) клиента каталога, например https://sts.windows.net/{tenant-guid}/. Этот универсальный код ресурса (URI) является идентификатором с учетом регистра для издателя маркера. Дополнительные сведения об обнаружении OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html

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

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

properties.tokenRefreshExtensionHours

number

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

properties.tokenStoreEnabled

boolean

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

properties.twitterConsumerKey

string

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

properties.twitterConsumerSecret

string

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

properties.twitterConsumerSecretSettingName

string

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

properties.unauthenticatedClientAction

UnauthenticatedClientAction

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

properties.validateIssuer

boolean

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

type

string

Тип ресурса.

UnauthenticatedClientAction

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

Имя Тип Описание
AllowAnonymous

string

RedirectToLoginPage

string