Web Apps - Update Auth Settings V2

Service:

App Service

API Version:

2023-12-01

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

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

URI パラメーター

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

要求本文

名前	型	説明
kind	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認証/承認のプラットフォームの構成設定。

応答

名前	型	説明
200 OK	SiteAuthSettingsV2	OK
Other Status Codes	DefaultErrorResponse	エラー応答をApp Serviceします。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

Update Auth Settings V2

Sample Request

HTTP

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

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

Sample Response

Status code:

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

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

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

AllowedPrincipals

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

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

Apple

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

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

AppleRegistration

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

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

AppRegistration

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

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

AuthPlatform

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

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

AzureActiveDirectory

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

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

AzureActiveDirectoryLogin

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

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

AzureActiveDirectoryRegistration

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 検出の詳細については、以下を参照してください。 http://openid.net/specs/openid-connect-discovery-1_0.html

AzureActiveDirectoryValidation

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

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

AzureStaticWebApps

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

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

AzureStaticWebAppsRegistration

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

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

BlobStorageTokenStore

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

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

ClientCredentialMethod

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

名前	型	説明
ClientSecretPost	string

ClientRegistration

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

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

CookieExpiration

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

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

CookieExpirationConvention

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

名前	型	説明
FixedTime	string
IdentityProviderDerived	string

CustomOpenIdConnectProvider

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

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

DefaultAuthorizationPolicy

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

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

DefaultErrorResponse

エラー応答をApp Serviceします。

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

Details

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

Error

エラー モデル。

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

Facebook

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

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

FileSystemTokenStore

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

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

ForwardProxy

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

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

ForwardProxyConvention

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

名前	型	説明
Custom	string
NoProxy	string
Standard	string

GitHub

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

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

GlobalValidation

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

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

Google

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

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

HttpSettings

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

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

HttpSettingsRoutes

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

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

IdentityProviders

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

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

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

LegacyMicrosoftAccount

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

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

Login

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

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

LoginRoutes

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

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

LoginScopes

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

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

Nonce

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

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

OpenIdConnectClientCredential

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

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

OpenIdConnectConfig

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

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

OpenIdConnectLogin

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

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

OpenIdConnectRegistration

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

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

SiteAuthSettingsV2

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

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

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

Twitter

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

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

TwitterRegistration

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

認証されていないクライアントがアプリへのアクセスを試みたときに実行するアクション。

名前	型	説明
AllowAnonymous	string
RedirectToLoginPage	string
Return401	string
Return403	string