Web Apps - Get Auth Settings

リファレンス

Service:: App Service

API Version:: 2023-12-01

の説明アプリの認証/承認設定を取得します。

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

URI パラメーター

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

応答

名前	型	説明
200 OK	SiteAuthSettings	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	ユーザーアカウントの借用

例

List Auth Settings

Sample Request

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings/list?api-version=2023-12-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"
  }
}

定義

名前	説明
BuiltInAuthenticationProvider	複数のプロバイダーが構成されている場合に使用する既定の認証プロバイダー。この設定は、複数のプロバイダーが構成されていて、認証されていないクライアントアクションが "RedirectToLoginPage" に設定されている場合にのみ必要です。
DefaultErrorResponse	エラー応答をApp Serviceします。
Details
Error	エラーモデル。
SiteAuthSettings	Azure App Service認証/承認機能の構成設定。
UnauthenticatedClientAction	認証されていないクライアントがアプリへのアクセスを試みたときに実行するアクション。

BuiltInAuthenticationProvider

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

名前	型	説明
AzureActiveDirectory	string
Facebook	string
Github	string
Google	string
MicrosoftAccount	string
Twitter	string

DefaultErrorResponse

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

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

Details

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

Error

エラーモデル。

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
details	Details[]	詳細なエラー。
innererror	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 Web トークンを検証するときに考慮する対象ユーザーの値を許可しました。この設定に `ClientID` 関係なく、値は常に許可対象ユーザーと見なされることに注意してください。
properties.allowedExternalRedirectUrls	string[]	アプリへのログインまたはログアウトの一環としてにリダイレクトできる外部 URL。 URL のクエリ文字列部分は無視されることに注意してください。これは、通常、Windows ストアアプリケーションバックエンドでのみ必要な詳細設定です。現在のドメイン内の URL は常に暗黙的に許可されることに注意してください。
properties.authFilePath	string	認証設定を含む構成ファイルのパス。パスが相対パスの場合、base はサイトのルートディレクトリになります。
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[]	ログイン認証の一部として要求される OAuth 2.0 スコープFacebook。この設定はオプションです。 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 検出の詳細については、以下を参照してください。 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	トークン更新 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	string
RedirectToLoginPage	string