Web Apps - Update Auth Settings

サービス:

App Service

API バージョン:

2024-04-01

「Web アプリに関連付けられている認証/承認設定を更新する」の説明。

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

URI パラメーター

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

要求本文

名前	型	説明
kind	string	リソースの種類。
properties.aadClaimsAuthorization	string	Azure AD Acl 設定を含む JSON 文字列を取得します。
properties.additionalLoginParams	string[]	ユーザーがログインしたときに OpenID Connect 承認エンドポイントに送信するログイン パラメーター。 各パラメーターは、"key=value" の形式である必要があります。
properties.allowedAudiences	string[]	Azure Active Directory によって発行された JSON Web トークンを検証するときに考慮する対象ユーザーの値を許可します。 ClientID 値は、この設定に関係なく、常に許可対象ユーザーと見なされることに注意してください。
properties.allowedExternalRedirectUrls	string[]	アプリのログインまたはログアウトの一環としてリダイレクトできる外部 URL。 URL のクエリ文字列部分は無視されることに注意してください。 これは、通常、Windows ストア アプリケーション バックエンドでのみ必要な詳細設定です。 現在のドメイン内の URL は常に暗黙的に許可されることに注意してください。
properties.authFilePath	string	認証設定を含む構成ファイルのパス。 パスが相対パスの場合、ベースはサイトのルート ディレクトリになります。
properties.clientId	string	この証明書利用者アプリケーションのクライアント ID (client_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 Web アプリケーションの OpenID Connect クライアント ID。 この設定は、Google サインインを有効にするために必要です。 Google Sign-In ドキュメント: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	Google Web アプリケーションに関連付けられているクライアント シークレット。 この設定は、Google サインインを有効にするために必要です。 Google Sign-In ドキュメント: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	Google Web アプリケーションに関連付けられているクライアント シークレットを含むアプリ設定名。
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 Discovery の詳細: 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" が使用されます。 Microsoft アカウントのスコープとアクセス許可に関するドキュメント: https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	現在のアプリで使用されている認証/承認機能の RuntimeVersion。 この値の設定は、認証/承認モジュールの特定の機能の動作を制御できます。
properties.tokenRefreshExtensionHours	number (double)	セッション トークンがトークン更新 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 で、そのように検証される必要があるかどうかを示す値を取得します。

応答

名前	型	説明
200 OK	SiteAuthSettings	わかりました
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	ユーザー アカウントを偽装する

例

Update Auth Settings

要求のサンプル

HTTP

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

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

Java

import com.azure.resourcemanager.appservice.fluent.models.SiteAuthSettingsInner;
import com.azure.resourcemanager.appservice.models.BuiltInAuthenticationProvider;
import com.azure.resourcemanager.appservice.models.UnauthenticatedClientAction;
import java.util.Arrays;

/**
 * Samples for WebApps UpdateAuthSettings.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettings.json
     */
    /**
     * Sample code: Update Auth Settings.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateAuthSettings(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().updateAuthSettingsWithResponse("testrg123", "sitef6141",
            new SiteAuthSettingsInner().withEnabled(true).withRuntimeVersion("~1")
                .withUnauthenticatedClientAction(UnauthenticatedClientAction.REDIRECT_TO_LOGIN_PAGE)
                .withTokenStoreEnabled(true)
                .withAllowedExternalRedirectUrls(
                    Arrays.asList("sitef6141.customdomain.net", "sitef6141.customdomain.info"))
                .withDefaultProvider(BuiltInAuthenticationProvider.GOOGLE).withTokenRefreshExtensionHours(120.0D)
                .withClientId("42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"),
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python update_auth_settings.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.update_auth_settings(
        resource_group_name="testrg123",
        name="sitef6141",
        site_auth_settings={
            "properties": {
                "allowedExternalRedirectUrls": ["sitef6141.customdomain.net", "sitef6141.customdomain.info"],
                "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com",
                "defaultProvider": "Google",
                "enabled": True,
                "runtimeVersion": "~1",
                "tokenRefreshExtensionHours": 120,
                "tokenStoreEnabled": True,
                "unauthenticatedClientAction": "RedirectToLoginPage",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettings.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

Go

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/UpdateAuthSettings.json
func ExampleWebAppsClient_UpdateAuthSettings() {
	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().UpdateAuthSettings(ctx, "testrg123", "sitef6141", armappservice.SiteAuthSettings{
		Properties: &armappservice.SiteAuthSettingsProperties{
			AllowedExternalRedirectUrls: []*string{
				to.Ptr("sitef6141.customdomain.net"),
				to.Ptr("sitef6141.customdomain.info")},
			ClientID:                    to.Ptr("42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"),
			DefaultProvider:             to.Ptr(armappservice.BuiltInAuthenticationProviderGoogle),
			Enabled:                     to.Ptr(true),
			RuntimeVersion:              to.Ptr("~1"),
			TokenRefreshExtensionHours:  to.Ptr[float64](120),
			TokenStoreEnabled:           to.Ptr(true),
			UnauthenticatedClientAction: to.Ptr(armappservice.UnauthenticatedClientActionRedirectToLoginPage),
		},
	}, 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.SiteAuthSettings = armappservice.SiteAuthSettings{
	// 	Name: to.Ptr("authsettings"),
	// 	Type: to.Ptr("Microsoft.Web/sites/authsettings"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings"),
	// 	Kind: to.Ptr("app"),
	// 	Properties: &armappservice.SiteAuthSettingsProperties{
	// 		AllowedExternalRedirectUrls: []*string{
	// 			to.Ptr("sitef6141.customdomain.net"),
	// 			to.Ptr("sitef6141.customdomain.info")},
	// 			ClientID: to.Ptr("42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"),
	// 			DefaultProvider: to.Ptr(armappservice.BuiltInAuthenticationProviderGoogle),
	// 			Enabled: to.Ptr(true),
	// 			RuntimeVersion: to.Ptr("~1"),
	// 			TokenRefreshExtensionHours: to.Ptr[float64](120),
	// 			TokenStoreEnabled: to.Ptr(true),
	// 			UnauthenticatedClientAction: to.Ptr(armappservice.UnauthenticatedClientActionRedirectToLoginPage),
	// 		},
	// 	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Description for Updates the Authentication / Authorization settings associated with web app.
 *
 * @summary Description for Updates the Authentication / Authorization settings associated with web app.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettings.json
 */
async function updateAuthSettings() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const siteAuthSettings = {
    allowedExternalRedirectUrls: ["sitef6141.customdomain.net", "sitef6141.customdomain.info"],
    clientId: "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com",
    defaultProvider: "Google",
    enabled: true,
    runtimeVersion: "~1",
    tokenRefreshExtensionHours: 120,
    tokenStoreEnabled: true,
    unauthenticatedClientAction: "RedirectToLoginPage",
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.updateAuthSettings(resourceGroupName, name, siteAuthSettings);
  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

dotnet

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/UpdateAuthSettings.json
// this example is just showing the usage of "WebApps_UpdateAuthSettings" 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
SiteAuthSettings siteAuthSettings = new SiteAuthSettings()
{
    IsEnabled = true,
    RuntimeVersion = "~1",
    UnauthenticatedClientAction = UnauthenticatedClientAction.RedirectToLoginPage,
    IsTokenStoreEnabled = true,
    AllowedExternalRedirectUrls =
    {
    "sitef6141.customdomain.net","sitef6141.customdomain.info"
    },
    DefaultProvider = BuiltInAuthenticationProvider.Google,
    TokenRefreshExtensionHours = 120,
    ClientId = "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com",
};
SiteAuthSettings result = await webSite.UpdateAuthSettingsAsync(siteAuthSettings);

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/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	App Service エラー応答。
Details
Error	エラー モデル。
SiteAuthSettings	Azure App Service の認証/承認機能の構成設定。
UnauthenticatedClientAction	認証されていないクライアントがアプリにアクセスしようとしたときに実行するアクション。

BuiltInAuthenticationProvider

列挙

複数のプロバイダーが構成されている場合に使用する既定の認証プロバイダー。 この設定は、複数のプロバイダーが構成されていて、認証されていないクライアント アクションが "RedirectToLoginPage" に設定されている場合にのみ必要です。

値	説明
AzureActiveDirectory
Facebook
Github
Google
MicrosoftAccount
Twitter

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	エラーの詳細な説明とデバッグ情報。

SiteAuthSettings

Object

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

名前	型	説明
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 Web トークンを検証するときに考慮する対象ユーザーの値を許可します。 ClientID 値は、この設定に関係なく、常に許可対象ユーザーと見なされることに注意してください。
properties.allowedExternalRedirectUrls	string[]	アプリのログインまたはログアウトの一環としてリダイレクトできる外部 URL。 URL のクエリ文字列部分は無視されることに注意してください。 これは、通常、Windows ストア アプリケーション バックエンドでのみ必要な詳細設定です。 現在のドメイン内の URL は常に暗黙的に許可されることに注意してください。
properties.authFilePath	string	認証設定を含む構成ファイルのパス。 パスが相対パスの場合、ベースはサイトのルート ディレクトリになります。
properties.clientId	string	この証明書利用者アプリケーションのクライアント ID (client_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 Web アプリケーションの OpenID Connect クライアント ID。 この設定は、Google サインインを有効にするために必要です。 Google Sign-In ドキュメント: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	Google Web アプリケーションに関連付けられているクライアント シークレット。 この設定は、Google サインインを有効にするために必要です。 Google Sign-In ドキュメント: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	Google Web アプリケーションに関連付けられているクライアント シークレットを含むアプリ設定名。
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 Discovery の詳細: 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" が使用されます。 Microsoft アカウントのスコープとアクセス許可に関するドキュメント: https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	現在のアプリで使用されている認証/承認機能の RuntimeVersion。 この値の設定は、認証/承認モジュールの特定の機能の動作を制御できます。
properties.tokenRefreshExtensionHours	number (double)	セッション トークンがトークン更新 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

列挙

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

値	説明
AllowAnonymous
RedirectToLoginPage