Web Apps - Get Auth Settings

  • 참조
Service:
App Service
API Version:
2023-01-01

앱의 인증/권한 부여 설정을 가져옵니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
name
 path True

string

응용 프로그램의 이름입니다.
resourceGroupName
 path True

string

리소스가 속한 리소스 그룹의 이름입니다.

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

string

Azure 구독 ID. GUID 형식 문자열입니다(예: 00000000-0000-0000-0000-0000-00000000000).
api-version
 query True

string

API 버전

응답

Name 형식 Description
200 OK

SiteAuthSettings

정상
Other Status Codes

DefaultErrorResponse

오류 응답을 App Service.

보안

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
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

Status code:
200 
{
  "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"
  }
}

정의

Name Description
BuiltInAuthenticationProvider

여러 공급자를 구성할 때 사용할 기본 인증 공급자입니다. 이 설정은 여러 공급자가 구성되고 인증되지 않은 클라이언트 작업이 "RedirectToLoginPage"로 설정된 경우에만 필요합니다.
DefaultErrorResponse

오류 응답을 App Service.
Details
Error

오류 모델.
SiteAuthSettings

Azure App Service 인증/권한 부여 기능에 대한 구성 설정입니다.
UnauthenticatedClientAction

인증되지 않은 클라이언트가 앱에 액세스하려고 할 때 수행할 작업입니다.

BuiltInAuthenticationProvider

여러 공급자를 구성할 때 사용할 기본 인증 공급자입니다. 이 설정은 여러 공급자가 구성되고 인증되지 않은 클라이언트 작업이 "RedirectToLoginPage"로 설정된 경우에만 필요합니다.

Name 형식 Description
AzureActiveDirectory

string

Facebook

string

Github

string

Google

string

MicrosoftAccount

string

Twitter

string

DefaultErrorResponse

오류 응답을 App Service.

Name 형식 Description
error

Error

오류 모델.

Details

Name 형식 Description
code

string

프로그래밍 방식으로 오류를 식별하는 표준화된 문자열입니다.
message

string

자세한 오류 설명 및 디버깅 정보입니다.
target

string

자세한 오류 설명 및 디버깅 정보입니다.

Error

오류 모델.

Name 형식 Description
code

string

프로그래밍 방식으로 오류를 식별하는 표준화된 문자열입니다.
details

Details[]

자세한 오류입니다.
innererror

string

디버그 오류에 대한 자세한 정보입니다.
message

string

자세한 오류 설명 및 디버깅 정보입니다.
target

string

자세한 오류 설명 및 디버깅 정보입니다.

SiteAuthSettings

Azure App Service 인증/권한 부여 기능에 대한 구성 설정입니다.

Name 형식 Description
id

string

리소스 ID입니다.
kind

string

리소스 종류입니다.
name

string

리소스 이름입니다.
properties.aadClaimsAuthorization

string

Azure AD Acl 설정을 포함하는 JSON 문자열을 가져옵니다.
properties.additionalLoginParams

string[]

사용자가 로그인할 때 OpenID Connect 권한 부여 엔드포인트로 보낼 로그인 매개 변수입니다. 각 매개 변수는 "key=value" 형식이어야 합니다.
properties.allowedAudiences

string[]

Azure Active Directory에서 발급한 JSON 웹 토큰의 유효성을 검사할 때 고려할 수 있는 대상 그룹 값입니다. 값은 ClientID 이 설정에 관계없이 항상 허용되는 대상 그룹으로 간주됩니다.
properties.allowedExternalRedirectUrls

string[]

앱 로그인 또는 로그아웃의 일부로 리디렉션할 수 있는 외부 URL입니다. URL의 쿼리 문자열 부분은 무시됩니다. 이는 일반적으로 Windows 스토어 애플리케이션 백 엔드에서만 필요한 고급 설정입니다. 현재 도메인 내의 URL은 항상 암시적으로 허용됩니다.
properties.authFilePath

string

인증 설정을 포함하는 구성 파일의 경로입니다. 경로가 상대 경로인 경우 base는 사이트의 루트 디렉터리를 사용합니다.
properties.clientId

string

client_id 알려진 이 신뢰 당사자 애플리케이션의 클라이언트 ID입니다. 이 설정은 Azure Active Directory 또는 다른 타사 OpenID Connect 공급자를 사용하여 OpenID 연결 인증을 사용하도록 설정하는 데 필요합니다. 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 앱의 앱 ID입니다. 이 설정은 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[]

Facebook 로그인 인증의 일부로 요청될 OAuth 2.0 범위입니다. 이 설정은 선택 사항입니다. Facebook 로그인 설명서:https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId

string

로그인에 사용되는 GitHub 앱의 클라이언트 ID입니다. 이 설정은 Github 로그인을 사용하도록 설정하는 데 필요합니다.
properties.gitHubClientSecret

string

Github 로그인에 사용되는 GitHub 앱의 클라이언트 암호입니다. 이 설정은 Github 로그인을 사용하도록 설정하는 데 필요합니다.
properties.gitHubClientSecretSettingName

string

GitHub 로그인에 사용되는 Github 앱의 클라이언트 암호를 포함하는 앱 설정 이름입니다.
properties.gitHubOAuthScopes

string[]

GitHub 로그인 인증의 일부로 요청될 OAuth 2.0 범위입니다. 이 설정은 선택 사항입니다.
properties.googleClientId

string

Google 웹 애플리케이션에 대한 OpenID Connect 클라이언트 ID입니다. 이 설정은 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[]

Google Sign-In 인증의 일부로 요청될 OAuth 2.0 범위입니다. 이 설정은 선택 사항입니다. 지정하지 않으면 "openid", "profile" 및 "email"이 기본 범위로 사용됩니다. Google Sign-In 설명서: https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile

string

인증 구성 설정을 파일에서 읽어야 하는 경우 "true"이고, 그렇지 않으면 "false"입니다.
properties.issuer

string

이 애플리케이션에 대한 액세스 토큰을 발급하는 엔터티를 나타내는 OpenID Connect 발급자 URI입니다. 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 클라이언트 ID입니다. 이 설정은 Microsoft 계정 인증을 사용하도록 설정하는 데 필요합니다. Microsoft 계정 OAuth 설명서: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret

string

인증에 사용되는 앱에 대해 만들어진 OAuth 2.0 클라이언트 암호입니다. 이 설정은 Microsoft 계정 인증을 사용하도록 설정하는 데 필요합니다. Microsoft 계정 OAuth 설명서: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName

string

인증에 사용되는 앱에 대해 만들어진 OAuth 2.0 클라이언트 암호를 포함하는 앱 설정 이름입니다.
properties.microsoftAccountOAuthScopes

string[]

Microsoft 계정 인증의 일부로 요청될 OAuth 2.0 범위입니다. 이 설정은 선택 사항입니다. 지정하지 않으면 "wl.basic"이 기본 scope 사용됩니다. Microsoft 계정 범위 및 권한 설명서: 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

로그인에 사용되는 Twitter 애플리케이션의 OAuth 1.0a 소비자 키입니다. 이 설정은 Twitter 로그인을 사용하도록 설정하는 데 필요합니다. Twitter Sign-In 설명서: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecret

string

로그인에 사용되는 Twitter 애플리케이션의 OAuth 1.0a 소비자 암호입니다. 이 설정은 Twitter 로그인을 사용하도록 설정하는 데 필요합니다. Twitter Sign-In 설명서: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecretSettingName

string

로그인에 사용되는 Twitter 애플리케이션의 OAuth 1.0a 소비자 암호를 포함하는 앱 설정 이름입니다.
properties.unauthenticatedClientAction

UnauthenticatedClientAction

인증되지 않은 클라이언트가 앱에 액세스하려고 할 때 수행할 작업입니다.
properties.validateIssuer

boolean

발급자를 유효한 HTTPS URL로 지정하고 유효성을 검사해야 하는지 여부를 나타내는 값을 가져옵니다.
type

string

리소스 종류.

UnauthenticatedClientAction

인증되지 않은 클라이언트가 앱에 액세스하려고 할 때 수행할 작업입니다.

Name 형식 Description
AllowAnonymous

string

RedirectToLoginPage

string