Web Apps - Get Auth Settings V2

リファレンス

サービス:: App Service

API バージョン:: 2024-04-01

V2 形式を使用したアプリのサイトの認証/承認設定の説明

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2/list?api-version=2024-04-01

URI パラメーター

名前	/	必須	型	説明
name	path	True	string	アプリの名前。
resourceGroupName	path	True	string	リソースが属するリソースグループの名前。正規表現パターン: `^[-\w\._\(\)]+[^\.]$`
subscriptionId	path	True	string	Azure サブスクリプション ID。これは GUID 形式の文字列です (例: 000000000-0000-0000-0000-000000000000)。
api-version	query	True	string	API バージョン

応答

名前	型	説明
200 OK	SiteAuthSettingsV2	わかりました
Other Status Codes	DefaultErrorResponse	App Service エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

List Auth Settings V2

要求のサンプル

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


/**
 * Samples for WebApps GetAuthSettingsV2.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.json
     */
    /**
     * Sample code: List Auth Settings V2.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAuthSettingsV2(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().getAuthSettingsV2WithResponse("testrg123", "sitef6141",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python list_auth_settings_v2.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.web_apps.get_auth_settings_v2(
        resource_group_name="testrg123",
        name="sitef6141",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.json
func ExampleWebAppsClient_GetAuthSettingsV2() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebAppsClient().GetAuthSettingsV2(ctx, "testrg123", "sitef6141", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SiteAuthSettingsV2 = armappservice.SiteAuthSettingsV2{
	// 	Name: to.Ptr("authsettingsv2"),
	// 	Type: to.Ptr("Microsoft.Web/sites/authsettingsv2"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettingsv2"),
	// 	Kind: to.Ptr("app"),
	// 	Properties: &armappservice.SiteAuthSettingsV2Properties{
	// 		GlobalValidation: &armappservice.GlobalValidation{
	// 			ExcludedPaths: []*string{
	// 				to.Ptr("/nosecrets/Path")},
	// 				RequireAuthentication: to.Ptr(true),
	// 				UnauthenticatedClientAction: to.Ptr(armappservice.UnauthenticatedClientActionV2Return403),
	// 			},
	// 			HTTPSettings: &armappservice.HTTPSettings{
	// 				ForwardProxy: &armappservice.ForwardProxy{
	// 					Convention: to.Ptr(armappservice.ForwardProxyConventionStandard),
	// 					CustomHostHeaderName: to.Ptr("authHeader"),
	// 					CustomProtoHeaderName: to.Ptr("customProtoHeader"),
	// 				},
	// 				RequireHTTPS: to.Ptr(true),
	// 				Routes: &armappservice.HTTPSettingsRoutes{
	// 					APIPrefix: to.Ptr("/authv2/"),
	// 				},
	// 			},
	// 			IdentityProviders: &armappservice.IdentityProviders{
	// 				Google: &armappservice.Google{
	// 					Enabled: to.Ptr(true),
	// 					Login: &armappservice.LoginScopes{
	// 						Scopes: []*string{
	// 							to.Ptr("admin")},
	// 						},
	// 						Registration: &armappservice.ClientRegistration{
	// 							ClientID: to.Ptr("42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"),
	// 							ClientSecretSettingName: to.Ptr("ClientSecret"),
	// 						},
	// 						Validation: &armappservice.AllowedAudiencesValidation{
	// 							AllowedAudiences: []*string{
	// 								to.Ptr("https://example.com")},
	// 							},
	// 						},
	// 					},
	// 					Login: &armappservice.Login{
	// 						AllowedExternalRedirectUrls: []*string{
	// 							to.Ptr("https://someurl.com")},
	// 							CookieExpiration: &armappservice.CookieExpiration{
	// 								Convention: to.Ptr(armappservice.CookieExpirationConventionIdentityProviderDerived),
	// 								TimeToExpiration: to.Ptr("2022:09-01T00:00Z"),
	// 							},
	// 							Nonce: &armappservice.Nonce{
	// 								ValidateNonce: to.Ptr(true),
	// 							},
	// 							PreserveURLFragmentsForLogins: to.Ptr(true),
	// 							Routes: &armappservice.LoginRoutes{
	// 								LogoutEndpoint: to.Ptr("https://app.com/logout"),
	// 							},
	// 							TokenStore: &armappservice.TokenStore{
	// 								Enabled: to.Ptr(true),
	// 								FileSystem: &armappservice.FileSystemTokenStore{
	// 									Directory: to.Ptr("/wwwroot/sites/example"),
	// 								},
	// 								TokenRefreshExtensionHours: to.Ptr[float64](96),
	// 							},
	// 						},
	// 						Platform: &armappservice.AuthPlatform{
	// 							ConfigFilePath: to.Ptr("/auth/config.json"),
	// 							Enabled: to.Ptr(true),
	// 							RuntimeVersion: to.Ptr("~1"),
	// 						},
	// 					},
	// 				}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Gets site's Authentication / Authorization settings for apps via the V2 format
 *
 * @summary Description for Gets site's Authentication / Authorization settings for apps via the V2 format
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.json
 */
async function listAuthSettingsV2() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.getAuthSettingsV2(resourceGroupName, name);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.json
// this example is just showing the usage of "WebApps_GetAuthSettingsV2" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this WebSiteResource created on azure
// for more information of creating WebSiteResource, please refer to the document of WebSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "sitef6141";
ResourceIdentifier webSiteResourceId = WebSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteResource webSite = client.GetWebSiteResource(webSiteResourceId);

// invoke the operation
SiteAuthSettingsV2 result = await webSite.GetAuthSettingsV2Async();

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettingsv2",
  "name": "authsettingsv2",
  "type": "Microsoft.Web/sites/authsettingsv2",
  "kind": "app",
  "properties": {
    "platform": {
      "enabled": true,
      "runtimeVersion": "~1",
      "configFilePath": "/auth/config.json"
    },
    "globalValidation": {
      "requireAuthentication": true,
      "unauthenticatedClientAction": "Return403",
      "excludedPaths": [
        "/nosecrets/Path"
      ]
    },
    "identityProviders": {
      "google": {
        "enabled": true,
        "registration": {
          "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com",
          "clientSecretSettingName": "ClientSecret"
        },
        "login": {
          "scopes": [
            "admin"
          ]
        },
        "validation": {
          "allowedAudiences": [
            "https://example.com"
          ]
        }
      }
    },
    "login": {
      "routes": {
        "logoutEndpoint": "https://app.com/logout"
      },
      "tokenStore": {
        "enabled": true,
        "tokenRefreshExtensionHours": 96,
        "fileSystem": {
          "directory": "/wwwroot/sites/example"
        }
      },
      "preserveUrlFragmentsForLogins": true,
      "allowedExternalRedirectUrls": [
        "https://someurl.com"
      ],
      "cookieExpiration": {
        "convention": "IdentityProviderDerived",
        "timeToExpiration": "2022:09-01T00:00Z"
      },
      "nonce": {
        "validateNonce": true
      }
    },
    "httpSettings": {
      "requireHttps": true,
      "routes": {
        "apiPrefix": "/authv2/"
      },
      "forwardProxy": {
        "convention": "Standard",
        "customHostHeaderName": "authHeader",
        "customProtoHeaderName": "customProtoHeader"
      }
    }
  }
}

定義

名前	説明
AllowedAudiencesValidation	許可対象ユーザー検証フローの構成設定。
AllowedPrincipals	Azure Active Directory で許可されるプリンシパルの構成設定。
Apple	Apple プロバイダーの構成設定。
AppleRegistration	Apple プロバイダーの登録の構成設定
AppRegistration	アプリ ID とアプリシークレットを持つプロバイダーのアプリ登録の構成設定
AuthPlatform	App Service 認証/承認のプラットフォームの構成設定。
AzureActiveDirectory	Azure Active Directory プロバイダーの構成設定。
AzureActiveDirectoryLogin	Azure Active Directory ログインフローの構成設定。
AzureActiveDirectoryRegistration	Azure Active Directory アプリ登録の構成設定。
AzureActiveDirectoryValidation	Azure Active Directory トークン検証フローの構成設定。
AzureStaticWebApps	Azure Static Web Apps プロバイダーの構成設定。
AzureStaticWebAppsRegistration	Azure Static Web Apps プロバイダーの登録の構成設定
BlobStorageTokenStore	BLOB ストレージが使用されている場合のトークンのストレージの構成設定。
ClientCredentialMethod	ユーザーの認証に使用するメソッド。
ClientRegistration	クライアント ID とクライアントシークレットを持つプロバイダーのアプリ登録の構成設定
CookieExpiration	セッション Cookie の有効期限の構成設定。
CookieExpirationConvention	セッション Cookie の有効期限を決定するときに使用される規則。
CustomOpenIdConnectProvider	カスタム Open ID Connect プロバイダーの構成設定。
DefaultAuthorizationPolicy	Azure Active Directory の既定の承認ポリシーの構成設定。
DefaultErrorResponse	App Service エラー応答。
Details
Error	エラーモデル。
Facebook	Facebook プロバイダーの構成設定。
FileSystemTokenStore	ファイルシステムが使用されている場合のトークンのストレージの構成設定。
ForwardProxy	要求の実行に使用される転送プロキシの構成設定。
ForwardProxyConvention	要求の URL を決定するために使用される規則。
GitHub	GitHub プロバイダーの構成設定。
GlobalValidation	App Service 認証/承認を使用するユーザーの検証フローを決定する構成設定。
Google	Google プロバイダーの構成設定。
HttpSettings	App Service の認証/承認に対して行われた認証要求と承認要求の HTTP 要求の構成設定。
HttpSettingsRoutes	HTTP 要求のパスの構成設定。
IdentityProviders	App Service の認証/承認の構成に使用される各 ID プロバイダーの構成設定。
JwtClaimChecks	JWT 要求の検証中に行う必要があるチェックの構成設定。
LegacyMicrosoftAccount	従来の Microsoft アカウントプロバイダーの構成設定。
Login	App Service 認証/承認を使用するユーザーのログインフローの構成設定。
LoginRoutes	ログイン要求とログアウト要求に使用されるエンドポイントを指定するルート。
LoginScopes	要求する必要があるスコープを含む、ログインフローの構成設定。
Nonce	ログインフローで使用される nonce の構成設定。
OpenIdConnectClientCredential	カスタム Open ID Connect プロバイダーの認証クライアント資格情報。
OpenIdConnectConfig	カスタム Open ID Connect プロバイダーに使用されるエンドポイントの構成設定。
OpenIdConnectLogin	カスタム Open ID Connect プロバイダーのログインフローの構成設定。
OpenIdConnectRegistration	カスタム Open ID Connect プロバイダーのアプリ登録の構成設定。
SiteAuthSettingsV2	Azure App Service 認証/承認 V2 機能の構成設定。
TokenStore	トークンストアの構成設定。
Twitter	Twitter プロバイダーの構成設定。
TwitterRegistration	Twitter プロバイダーのアプリ登録の構成設定。
UnauthenticatedClientActionV2	認証されていないクライアントがアプリにアクセスしようとしたときに実行するアクション。

AllowedAudiencesValidation

Object

許可対象ユーザー検証フローの構成設定。

名前	型	説明
allowedAudiences	string[]	JWT トークンを検証する対象ユーザーの許可リストの構成設定。

AllowedPrincipals

Object

Azure Active Directory で許可されるプリンシパルの構成設定。

名前	型	説明
groups	string[]	許可されるグループの一覧。
identities	string[]	許可されている ID の一覧。

Apple

Object

Apple プロバイダーの構成設定。

名前	型	説明
enabled	boolean	設定された登録にもかかわらず Apple プロバイダーを有効にしてはならない場合に `false` します。それ以外の場合は、`true`します。
login	LoginScopes	ログインフローの構成設定。
registration	AppleRegistration	Apple 登録の構成設定。

AppleRegistration

Object

Apple プロバイダーの登録の構成設定

名前	型	説明
clientId	string	ログインに使用されるアプリのクライアント ID。
clientSecretSettingName	string	クライアントシークレットを含むアプリ設定名。

AppRegistration

Object

アプリ ID とアプリシークレットを持つプロバイダーのアプリ登録の構成設定

名前	型	説明
appId	string	ログインに使用されるアプリのアプリ ID。
appSecretSettingName	string	アプリシークレットを含むアプリ設定名。

AuthPlatform

Object

App Service 認証/承認のプラットフォームの構成設定。

名前	型	説明
configFilePath	string	認証設定がファイルから取得された場合に含まれる構成ファイルのパス。パスが相対パスの場合、ベースはサイトのルートディレクトリになります。
enabled	boolean	現在のアプリに対して認証/承認機能が有効になっているかどうかを `true` します。それ以外の場合は、`false`します。
runtimeVersion	string	現在のアプリで使用されている認証/承認機能の RuntimeVersion。この値の設定は、認証/承認モジュールの特定の機能の動作を制御できます。

AzureActiveDirectory

Object

Azure Active Directory プロバイダーの構成設定。

名前	型	説明
enabled	boolean	セットの登録にもかかわらず Azure Active Directory プロバイダーを有効にしない場合は `false` します。それ以外の場合は、`true`します。
isAutoProvisioned	boolean	Azure AD 構成がファーストパーティツールを使用して自動プロビジョニングされたかどうかを示す値を取得します。これは、主に Azure 管理ポータルをサポートすることを目的とした内部フラグです。ユーザーは、このプロパティの読み取りまたは書き込みを行うべきではありません。
login	AzureActiveDirectoryLogin	Azure Active Directory ログインフローの構成設定。
registration	AzureActiveDirectoryRegistration	Azure Active Directory アプリ登録の構成設定。
validation	AzureActiveDirectoryValidation	Azure Active Directory トークン検証フローの構成設定。

AzureActiveDirectoryLogin

Object

Azure Active Directory ログインフローの構成設定。

名前	型	説明
disableWWWAuthenticate	boolean	www 認証プロバイダーを要求から省略する必要がある場合に `true` します。それ以外の場合は、`false`します。
loginParameters	string[]	ユーザーがログインしたときに OpenID Connect 承認エンドポイントに送信するログインパラメーター。各パラメーターは、"key=value" の形式である必要があります。

AzureActiveDirectoryRegistration

Object

Azure Active Directory アプリ登録の構成設定。

名前	型	説明
clientId	string	この証明書利用者アプリケーションのクライアント ID (client_idと呼ばれます)。この設定は、Azure Active Directory または他のサードパーティの OpenID Connect プロバイダーで OpenID 接続認証を有効にするために必要です。 OpenID Connect の詳細: http://openid.net/specs/openid-connect-core-1_0.html
clientSecretCertificateIssuer	string	クライアントシークレットの拇印の代わりに、署名目的で使用される証明書の発行者です。このプロパティは、クライアントシークレット証明書の拇印の代わりとして機能します。また、省略可能です。
clientSecretCertificateSubjectAlternativeName	string	クライアントシークレットの拇印の代わりに、署名目的で使用される証明書のサブジェクトの別名です。このプロパティは、クライアントシークレット証明書の拇印の代わりとして機能します。また、省略可能です。
clientSecretCertificateThumbprint	string	クライアントシークレットの代わりに、署名目的で使用される証明書の拇印です。このプロパティは、クライアントシークレットの代わりに機能します。また、省略可能です。
clientSecretSettingName	string	証明書利用者アプリケーションのクライアントシークレットを含むアプリ設定名。
openIdIssuer	string	このアプリケーションのアクセストークンを発行するエンティティを表す OpenID Connect 発行者 URI。 Azure Active Directory を使用する場合、この値はディレクトリテナントの URI です (例: `https://login.microsoftonline.com/v2.0/{tenant-guid}/`)。この URI は、トークン発行者の大文字と小文字を区別する識別子です。 OpenID Connect Discovery の詳細: http://openid.net/specs/openid-connect-discovery-1_0.html

AzureActiveDirectoryValidation

Object

Azure Active Directory トークン検証フローの構成設定。

名前	型	説明
allowedAudiences	string[]	認証/承認要求を成功させる対象ユーザーの一覧。
defaultAuthorizationPolicy	DefaultAuthorizationPolicy	既定の承認ポリシーの構成設定。
jwtClaimChecks	JwtClaimChecks	JWT 要求の検証中に行う必要があるチェックの構成設定。

AzureStaticWebApps

Object

Azure Static Web Apps プロバイダーの構成設定。

名前	型	説明
enabled	boolean	設定された登録にもかかわらず Azure Static Web Apps プロバイダーを有効にしてはならない場合に `false` します。それ以外の場合は、`true`します。
registration	AzureStaticWebAppsRegistration	Azure Static Web Apps 登録の構成設定。

AzureStaticWebAppsRegistration

Object

Azure Static Web Apps プロバイダーの登録の構成設定

名前	型	説明
clientId	string	ログインに使用されるアプリのクライアント ID。

BlobStorageTokenStore

Object

BLOB ストレージが使用されている場合のトークンのストレージの構成設定。

名前	型	説明
sasUrlSettingName	string	トークンを含む BLOB ストレージの SAS URL を含むアプリ設定の名前。

ClientCredentialMethod

Enumeration

ユーザーの認証に使用するメソッド。

値	説明
ClientSecretPost

ClientRegistration

Object

クライアント ID とクライアントシークレットを持つプロバイダーのアプリ登録の構成設定

名前	型	説明
clientId	string	ログインに使用されるアプリのクライアント ID。
clientSecretSettingName	string	クライアントシークレットを含むアプリ設定名。

CookieExpiration

Object

セッション Cookie の有効期限の構成設定。

名前	型	説明
convention	CookieExpirationConvention	セッション Cookie の有効期限を決定するときに使用される規則。
timeToExpiration	string	セッション Cookie の有効期限が切れる要求の後の時間。

CookieExpirationConvention

Enumeration

セッション Cookie の有効期限を決定するときに使用される規則。

値	説明
FixedTime
IdentityProviderDerived

CustomOpenIdConnectProvider

Object

カスタム Open ID Connect プロバイダーの構成設定。

名前	型	説明
enabled	boolean	カスタム Open ID プロバイダープロバイダーを有効にしない場合に `false` します。それ以外の場合は、`true`します。
login	OpenIdConnectLogin	カスタム Open ID Connect プロバイダーのログインフローの構成設定。
registration	OpenIdConnectRegistration	カスタム Open ID Connect プロバイダーのアプリ登録の構成設定。

DefaultAuthorizationPolicy

Object

Azure Active Directory の既定の承認ポリシーの構成設定。

名前	型	説明
allowedApplications	string[]	Azure Active Directory で許可されるアプリケーションの構成設定。
allowedPrincipals	AllowedPrincipals	Azure Active Directory で許可されるプリンシパルの構成設定。

DefaultErrorResponse

Object

App Service エラー応答。

名前	型	説明
error	Error	エラーモデル。

Details

Object

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

Error

Object

エラーモデル。

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
details	Details[]	詳細なエラー。
innererror	string	デバッグエラーの詳細。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

Facebook

Object

Facebook プロバイダーの構成設定。

名前	型	説明
enabled	boolean	設定された登録にもかかわらず Facebook プロバイダーを有効にしてはならない場合に `false` します。それ以外の場合は、`true`します。
graphApiVersion	string	ログイン時に使用する Facebook API のバージョン。
login	LoginScopes	ログインフローの構成設定。
registration	AppRegistration	Facebook プロバイダーのアプリ登録の構成設定。

FileSystemTokenStore

Object

ファイルシステムが使用されている場合のトークンのストレージの構成設定。

名前	型	説明
directory	string	トークンが格納されるディレクトリ。

ForwardProxy

Object

要求の実行に使用される転送プロキシの構成設定。

名前	型	説明
convention	ForwardProxyConvention	要求の URL を決定するために使用される規則。
customHostHeaderName	string	要求のホストを含むヘッダーの名前。
customProtoHeaderName	string	要求のスキームを含むヘッダーの名前。

ForwardProxyConvention

Enumeration

要求の URL を決定するために使用される規則。

値	説明
Custom
NoProxy
Standard

GitHub

Object

GitHub プロバイダーの構成設定。

名前	型	説明
enabled	boolean	設定された登録にもかかわらず GitHub プロバイダーを有効にすべきでない場合は `false` します。それ以外の場合は、`true`します。
login	LoginScopes	ログインフローの構成設定。
registration	ClientRegistration	GitHub プロバイダーのアプリ登録の構成設定。

GlobalValidation

Object

App Service 認証/承認を使用するユーザーの検証フローを決定する構成設定。

名前	型	説明
excludedPaths	string[]	認証されていないフローがログインページにリダイレクトされないパス。
redirectToProvider	string	複数のプロバイダーが構成されている場合に使用する既定の認証プロバイダー。この設定は、複数のプロバイダーが構成されていて、認証されていないクライアントアクションが "RedirectToLoginPage" に設定されている場合にのみ必要です。
requireAuthentication	boolean	認証フローが必要な場合は `true` 要求が行われます。それ以外の場合は、`false`します。
unauthenticatedClientAction	UnauthenticatedClientActionV2	認証されていないクライアントがアプリにアクセスしようとしたときに実行するアクション。

Google

Object

Google プロバイダーの構成設定。

名前	型	説明
enabled	boolean	設定された登録にもかかわらず Google プロバイダーを有効にしてはならない場合に `false` します。それ以外の場合は、`true`します。
login	LoginScopes	ログインフローの構成設定。
registration	ClientRegistration	Google プロバイダーのアプリ登録の構成設定。
validation	AllowedAudiencesValidation	Azure Active Directory トークン検証フローの構成設定。

HttpSettings

Object

App Service の認証/承認に対して行われた認証要求と承認要求の HTTP 要求の構成設定。

名前	型	説明
forwardProxy	ForwardProxy	要求の実行に使用される転送プロキシの構成設定。
requireHttps	boolean	HTTPS スキームを持たない認証/承認応答が許容される場合に `false` します。それ以外の場合は、`true`します。
routes	HttpSettingsRoutes	HTTP 要求のパスの構成設定。

HttpSettingsRoutes

Object

HTTP 要求のパスの構成設定。

名前	型	説明
apiPrefix	string	すべての認証/承認パスの前に置くプレフィックス。

IdentityProviders

Object

App Service の認証/承認の構成に使用される各 ID プロバイダーの構成設定。

名前	型	説明
apple	Apple	Apple プロバイダーの構成設定。
azureActiveDirectory	AzureActiveDirectory	Azure Active Directory プロバイダーの構成設定。
azureStaticWebApps	AzureStaticWebApps	Azure Static Web Apps プロバイダーの構成設定。
customOpenIdConnectProviders	<string, CustomOpenIdConnectProvider>	各カスタム Open ID Connect プロバイダーのエイリアスの名前を、カスタム Open ID Connect プロバイダーの構成設定にマップします。
facebook	Facebook	Facebook プロバイダーの構成設定。
gitHub	GitHub	GitHub プロバイダーの構成設定。
google	Google	Google プロバイダーの構成設定。
legacyMicrosoftAccount	LegacyMicrosoftAccount	従来の Microsoft アカウントプロバイダーの構成設定。
twitter	Twitter	Twitter プロバイダーの構成設定。

JwtClaimChecks

Object

JWT 要求の検証中に行う必要があるチェックの構成設定。

名前	型	説明
allowedClientApplications	string[]	許可されているクライアントアプリケーションの一覧。
allowedGroups	string[]	許可されるグループの一覧。

LegacyMicrosoftAccount

Object

従来の Microsoft アカウントプロバイダーの構成設定。

名前	型	説明
enabled	boolean	セットの登録にもかかわらず、従来の Microsoft アカウントプロバイダーを有効にしてはならない場合に `false` します。それ以外の場合は、`true`します。
login	LoginScopes	ログインフローの構成設定。
registration	ClientRegistration	従来の Microsoft アカウントプロバイダーのアプリ登録の構成設定。
validation	AllowedAudiencesValidation	従来の Microsoft アカウントプロバイダートークン検証フローの構成設定。

Object

App Service 認証/承認を使用するユーザーのログインフローの構成設定。

名前	型	説明
allowedExternalRedirectUrls	string[]	アプリのログインまたはログアウトの一環としてリダイレクトできる外部 URL。 URL のクエリ文字列部分は無視されることに注意してください。これは、通常、Windows ストアアプリケーションバックエンドでのみ必要な詳細設定です。現在のドメイン内の URL は常に暗黙的に許可されることに注意してください。
cookieExpiration	CookieExpiration	セッション Cookie の有効期限の構成設定。
nonce	Nonce	ログインフローで使用される nonce の構成設定。
preserveUrlFragmentsForLogins	boolean	ログイン要求が行われた後も要求のフラグメントが保持される場合に `true` します。それ以外の場合は、`false`します。
routes	LoginRoutes	ログイン要求とログアウト要求に使用されるエンドポイントを指定するルート。
tokenStore	TokenStore	トークンストアの構成設定。

LoginRoutes

Object

ログイン要求とログアウト要求に使用されるエンドポイントを指定するルート。

名前	型	説明
logoutEndpoint	string	ログアウト要求を行うエンドポイント。

LoginScopes

Object

要求する必要があるスコープを含む、ログインフローの構成設定。

名前	型	説明
scopes	string[]	認証中に要求する必要があるスコープの一覧。

Nonce

Object

ログインフローで使用される nonce の構成設定。

名前	型	説明
nonceExpirationInterval	string	nonce の有効期限が切れる要求の後の時間。
validateNonce	boolean	ログインフローの完了中に nonce を検証しない場合に `false` します。それ以外の場合は、`true`します。

OpenIdConnectClientCredential

Object

カスタム Open ID Connect プロバイダーの認証クライアント資格情報。

名前	型	説明
clientSecretSettingName	string	カスタム Open ID Connect プロバイダーのクライアントシークレットを含むアプリ設定。
method	ClientCredentialMethod	ユーザーの認証に使用するメソッド。

OpenIdConnectConfig

Object

カスタム Open ID Connect プロバイダーに使用されるエンドポイントの構成設定。

名前	型	説明
authorizationEndpoint	string	承認要求を行うために使用するエンドポイント。
certificationUri	string	トークンの検証に必要なキーを提供するエンドポイント。
issuer	string	トークンを発行するエンドポイント。
tokenEndpoint	string	トークンの要求に使用するエンドポイント。
wellKnownOpenIdConfiguration	string	プロバイダーのすべての構成エンドポイントを含むエンドポイント。

OpenIdConnectLogin

Object

カスタム Open ID Connect プロバイダーのログインフローの構成設定。

名前	型	説明
nameClaimType	string	ユーザー名を含む要求の名前。
scopes	string[]	認証中に要求する必要があるスコープの一覧。

OpenIdConnectRegistration

Object

カスタム Open ID Connect プロバイダーのアプリ登録の構成設定。

名前	型	説明
clientCredential	OpenIdConnectClientCredential	カスタム Open ID Connect プロバイダーの認証資格情報。
clientId	string	カスタム Open ID Connect プロバイダーのクライアント ID。
openIdConnectConfiguration	OpenIdConnectConfig	カスタム Open ID Connect プロバイダーに使用されるエンドポイントの構成設定。

SiteAuthSettingsV2

Object

Azure App Service 認証/承認 V2 機能の構成設定。

名前	型	説明
id	string	リソース ID。
kind	string	リソースの種類。
name	string	リソース名。
properties.globalValidation	GlobalValidation	App Service 認証/承認を使用するユーザーの検証フローを決定する構成設定。
properties.httpSettings	HttpSettings	App Service の認証/承認に対して行われた認証要求と承認要求の HTTP 要求の構成設定。
properties.identityProviders	IdentityProviders	App Service の認証/承認の構成に使用される各 ID プロバイダーの構成設定。
properties.login	Login	App Service 認証/承認を使用するユーザーのログインフローの構成設定。
properties.platform	AuthPlatform	App Service 認証/承認のプラットフォームの構成設定。
type	string	リソースの種類。

TokenStore

Object

トークンストアの構成設定。

名前	型	説明
azureBlobStorage	BlobStorageTokenStore	BLOB ストレージが使用されている場合のトークンのストレージの構成設定。
enabled	boolean	ログインフロー中に取得されたプラットフォーム固有のセキュリティトークンを永続的に格納 `true`。それ以外の場合は、`false`します。既定値は `false`です。
fileSystem	FileSystemTokenStore	ファイルシステムが使用されている場合のトークンのストレージの構成設定。
tokenRefreshExtensionHours	number	セッショントークンがトークン更新 API の呼び出しに使用できるセッショントークンの有効期限後の時間数。既定値は 72 時間です。

Twitter

Object

Twitter プロバイダーの構成設定。

名前	型	説明
enabled	boolean	設定された登録にもかかわらず Twitter プロバイダーを有効にしてはならない場合に `false` します。それ以外の場合は、`true`します。
registration	TwitterRegistration	Twitter プロバイダーのアプリ登録の構成設定。

TwitterRegistration

Object

Twitter プロバイダーのアプリ登録の構成設定。

名前	型	説明
consumerKey	string	サインインに使用される Twitter アプリケーションの OAuth 1.0a コンシューマーキー。この設定は、Twitter サインインを有効にするために必要です。 Twitter Sign-In ドキュメント: https://dev.twitter.com/web/sign-in
consumerSecretSettingName	string	サインインに使用される Twitter アプリケーションの OAuth 1.0a コンシューマーシークレットを含むアプリ設定名。

UnauthenticatedClientActionV2

Enumeration

認証されていないクライアントがアプリにアクセスしようとしたときに実行するアクション。

値	説明
AllowAnonymous
RedirectToLoginPage
Return401
Return403