Web Apps - Update Auth Settings

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

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

URI パラメーター

名前 / 必須 型 説明
name
path True

string

アプリの名前。

resourceGroupName
path True

string

minLength: 1
maxLength: 90

リソース グループの名前。 名前は大文字と小文字を区別しません。

subscriptionId
path True

string (uuid)

ターゲット サブスクリプションの ID。 値は UUID である必要があります。

api-version
query True

string

minLength: 1

この操作に使用する API バージョン。

要求本文

名前 型 説明
kind

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

認証設定を含む構成ファイルのパス。 パスが相対パスの場合、ベースはサイトのルート ディレクトリになります。

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

Azureの運用は無事に完了しました。

Other Status Codes

DefaultErrorResponse

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

名前 説明
user_impersonation あなたのユーザー アカウントになりすます

例

Update Auth Settings

要求のサンプル

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

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

応答のサンプル

{
  "name": "authsettings",
  "type": "Microsoft.Web/sites/authsettings",
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings",
  "kind": "app",
  "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"
  }
}

定義

名前 説明
BuiltInAuthenticationProvider

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

DefaultErrorResponse

App Service エラー応答。

DefaultErrorResponseError

エラー モデル。

DefaultErrorResponseErrorDetailsItem

詳細なエラー。

SiteAuthSettings

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

UnauthenticatedClientAction

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

BuiltInAuthenticationProvider

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

値 説明
AzureActiveDirectory
Facebook
Google
MicrosoftAccount
Twitter
Github

DefaultErrorResponse

App Service エラー応答。

名前 型 説明
error

DefaultErrorResponseError

エラー モデル。

DefaultErrorResponseError

エラー モデル。

名前 型 説明
code

string

プログラムでエラーを識別するための標準化された文字列。

details

DefaultErrorResponseErrorDetailsItem[]

詳細なエラー。

innererror

string

エラーのデバッグに関する詳細情報。

message

string

詳細なエラーの説明とデバッグ情報。

target

string

詳細なエラーの説明とデバッグ情報。

DefaultErrorResponseErrorDetailsItem

詳細なエラー。

名前 型 説明
code

string

プログラムでエラーを識別するための標準化された文字列。

message

string

詳細なエラーの説明とデバッグ情報。

target

string

詳細なエラーの説明とデバッグ情報。

SiteAuthSettings

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ウェブトークンの検証時にオーディエンス値を考慮できるようにしました。 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

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

値 説明
RedirectToLoginPage
AllowAnonymous