SiteAuthSettings クラス

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

変数はサーバーによってのみ設定され、要求の送信時には無視されます。

継承

azure.mgmt.web.v2020_09_01.models._models_py3.ProxyOnlyResource

SiteAuthSettings

コンストラクター

SiteAuthSettings(*, kind: str | None = None, enabled: bool | None = None, runtime_version: str | None = None, unauthenticated_client_action: str | _models.UnauthenticatedClientAction | None = None, token_store_enabled: bool | None = None, allowed_external_redirect_urls: List[str] | None = None, default_provider: str | _models.BuiltInAuthenticationProvider | None = None, token_refresh_extension_hours: float | None = None, client_id: str | None = None, client_secret: str | None = None, client_secret_setting_name: str | None = None, client_secret_certificate_thumbprint: str | None = None, issuer: str | None = None, validate_issuer: bool | None = None, allowed_audiences: List[str] | None = None, additional_login_params: List[str] | None = None, aad_claims_authorization: str | None = None, google_client_id: str | None = None, google_client_secret: str | None = None, google_client_secret_setting_name: str | None = None, google_o_auth_scopes: List[str] | None = None, facebook_app_id: str | None = None, facebook_app_secret: str | None = None, facebook_app_secret_setting_name: str | None = None, facebook_o_auth_scopes: List[str] | None = None, git_hub_client_id: str | None = None, git_hub_client_secret: str | None = None, git_hub_client_secret_setting_name: str | None = None, git_hub_o_auth_scopes: List[str] | None = None, twitter_consumer_key: str | None = None, twitter_consumer_secret: str | None = None, twitter_consumer_secret_setting_name: str | None = None, microsoft_account_client_id: str | None = None, microsoft_account_client_secret: str | None = None, microsoft_account_client_secret_setting_name: str | None = None, microsoft_account_o_auth_scopes: List[str] | None = None, is_auth_from_file: str | None = None, auth_file_path: str | None = None, **kwargs: Any)

キーワードのみのパラメーター

名前	説明
kind	str リソースの種類。
enabled	bool <code>true</code> 認証/承認機能が現在のアプリに対して有効になっている場合。それ以外の場合は <code>false</code>。
runtime_version	str 現在のアプリで使用されている認証/承認機能の RuntimeVersion。 この値の設定は、認証/承認モジュールの特定の機能の動作を制御できます。
unauthenticated_client_action	str または UnauthenticatedClientAction 認証されていないクライアントがアプリへのアクセスを試みたときに実行するアクション。 既知の値は、"RedirectToLoginPage" と "AllowAnonymous" です。
token_store_enabled	bool <code>true</code> ログイン フロー中に取得されたプラットフォーム固有のセキュリティ トークンを永続的に格納するため。それ以外の場合は <code>false</code>。 既定値は、<code>false</code> です。
allowed_external_redirect_urls	list[str] アプリへのログインまたはログアウトの一環として にリダイレクトできる外部 URL。 URL のクエリ文字列部分は無視されることに注意してください。 これは、通常、Windows ストア アプリケーション バックエンドでのみ必要な詳細設定です。 現在のドメイン内の URL は常に暗黙的に許可されることに注意してください。
default_provider	str または BuiltInAuthenticationProvider 複数のプロバイダーが構成されている場合に使用する既定の認証プロバイダー。 この設定は、複数のプロバイダーが構成されていて、認証されていないクライアント アクションが "RedirectToLoginPage" に設定されている場合にのみ必要です。 既知の値は、"AzureActiveDirectory"、"Facebook"、"Google"、"MicrosoftAccount"、"Twitter"、"Github" です。
token_refresh_extension_hours	float トークン更新 API の呼び出しにセッション トークンを使用できるセッション トークンの有効期限が切れた後の時間数。 既定値は 72 時間です。
client_id	str この証明書利用者アプリケーションのクライアント ID (client_idと呼ばれます)。 この設定は、Azure Active Directory またはその他のサードパーティの OpenID Connect プロバイダーで OpenID 接続認証を有効にするために必要です。 OpenID Connect の詳細については、 を参照してください http://openid.net/specs/openid-connect-core-1_0.html。
client_secret	str この証明書利用者アプリケーションのクライアント シークレット (Azure Active Directory では、これはキーとも呼ばれます)。 この設定はオプションです。 クライアント シークレットが構成されていない場合は、OpenID Connect の暗黙的な認証フローを使用してエンド ユーザーを認証します。 それ以外の場合は、OpenID Connect 承認コード フローを使用してエンド ユーザーを認証します。 OpenID Connect の詳細については、 を参照してください http://openid.net/specs/openid-connect-core-1_0.html。
client_secret_setting_name	str 証明書利用者アプリケーションのクライアント シークレットを含むアプリ設定名。
client_secret_certificate_thumbprint	str クライアント シークレットの代わりに、署名目的で使用される証明書の拇印です。 このプロパティは、クライアント シークレットの代わりに機能します。 また、省略可能です。
issuer	str このアプリケーションのアクセス トークンを発行するエンティティを表す 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。
validate_issuer	bool 発行者が有効な HTTPS URL で、そのように検証される必要があるかどうかを示す値を取得します。
allowed_audiences	list[str] Azure Active Directory によって発行された JWT を検証するときに考慮する対象ユーザーの値を許可しました。 この設定に <code>ClientID</code> 関係なく、値は常に許可対象ユーザーと見なされることに注意してください。
additional_login_params	list[str] ユーザーがログインしたときに OpenID Connect 承認エンドポイントに送信するログイン パラメーター。 各パラメーターは、"key=value" の形式である必要があります。
aad_claims_authorization	str Azure AD Acl の設定を含む JSON 文字列を取得します。
google_client_id	str Google Web アプリケーションの OpenID Connect クライアント ID。 この設定は、Google サインインを有効にするために必要です。 Google Sign-In ドキュメント: https://developers.google.com/identity/sign-in/web/。
google_client_secret	str Google Web アプリケーションに関連付けられているクライアント シークレット。 この設定は、Google サインインを有効にするために必要です。 Google Sign-In ドキュメント: https://developers.google.com/identity/sign-in/web/。
google_client_secret_setting_name	str Google Web アプリケーションに関連付けられているクライアント シークレットを含むアプリ設定名。
google_o_auth_scopes	list[str] Google Sign-In 認証の一部として要求される OAuth 2.0 スコープ。 この設定はオプションです。 指定しない場合、"openid"、"profile"、および "email" が既定のスコープとして使用されます。 Google Sign-In ドキュメント: https://developers.google.com/identity/sign-in/web/。
facebook_app_id	str ログインに使用される Facebook アプリのアプリ ID。 この設定は、Facebook ログインを有効にするために必要です。 Facebook ログインのドキュメント: https://developers.facebook.com/docs/facebook-login。
facebook_app_secret	str Facebook ログインに使用される Facebook アプリのアプリ シークレット。 この設定は、Facebook ログインを有効にするために必要です。 Facebook ログインのドキュメント: https://developers.facebook.com/docs/facebook-login。
facebook_app_secret_setting_name	str Facebook ログインに使用されるアプリ シークレットを含むアプリ設定名。
facebook_o_auth_scopes	list[str] Facebook ログイン認証の一部として要求される OAuth 2.0 スコープ。 この設定はオプションです。 Facebook ログインのドキュメント: https://developers.facebook.com/docs/facebook-login。
git_hub_client_id	str ログインに使用される GitHub アプリのクライアント ID。 この設定は、Github ログインを有効にするために必要です。
git_hub_client_secret	str GitHub ログインに使用される GitHub アプリのクライアント シークレット。 この設定は、Github ログインを有効にするために必要です。
git_hub_client_secret_setting_name	str GitHub ログインに使用される Github アプリのクライアント シークレットを含むアプリ設定名。
git_hub_o_auth_scopes	list[str] GitHub ログイン認証の一部として要求される OAuth 2.0 スコープ。 この設定はオプションです。
twitter_consumer_key	str サインインに使用される Twitter アプリケーションの OAuth 1.0a コンシューマー キー。 この設定は、Twitter サインインを有効にするために必要です。 Twitter Sign-In ドキュメント: https://dev.twitter.com/web/sign-in。
twitter_consumer_secret	str サインインに使用される Twitter アプリケーションの OAuth 1.0a コンシューマー シークレット。 この設定は、Twitter サインインを有効にするために必要です。 Twitter Sign-In ドキュメント: https://dev.twitter.com/web/sign-in。
twitter_consumer_secret_setting_name	str サインインに使用される Twitter アプリケーションの OAuth 1.0a コンシューマー シークレットを含むアプリ設定名。
microsoft_account_client_id	str 認証に使用されるアプリ用に作成された OAuth 2.0 クライアント ID。 この設定は、Microsoft アカウント認証を有効にするために必要です。 Microsoft アカウント OAuth のドキュメント: https://dev.onedrive.com/auth/msa_oauth.htm。
microsoft_account_client_secret	str 認証に使用されるアプリ用に作成された OAuth 2.0 クライアント シークレット。 この設定は、Microsoft アカウント認証を有効にするために必要です。 Microsoft アカウント OAuth のドキュメント: https://dev.onedrive.com/auth/msa_oauth.htm。
microsoft_account_client_secret_setting_name	str 認証に使用されるアプリ用に作成された OAuth 2.0 クライアント シークレットを含むアプリ設定名。
microsoft_account_o_auth_scopes	list[str] Microsoft アカウント認証の一部として要求される OAuth 2.0 スコープ。 この設定はオプションです。 指定しない場合は、既定のスコープとして "wl.basic" が使用されます。 Microsoft アカウントのスコープとアクセス許可に関するドキュメント: https://msdn.microsoft.com/en-us/library/dn631845.aspx。
is_auth_from_file	str 認証構成設定をファイルから読み取る必要がある場合は "true"、それ以外の場合は "false" です。
auth_file_path	str 認証設定を含む構成ファイルのパス。 パスが相対パスの場合、base はサイトのルート ディレクトリになります。

変数

名前	説明
id	str リソース ID。
name	str リソース名。
kind	str リソースの種類。
type	str リソースの種類。
system_data	SystemData このリソースに関連するシステム メタデータ。
enabled	bool <code>true</code> 認証/承認機能が現在のアプリに対して有効になっている場合。それ以外の場合は <code>false</code>。
runtime_version	str 現在のアプリで使用されている認証/承認機能の RuntimeVersion。 この値の設定は、認証/承認モジュールの特定の機能の動作を制御できます。
unauthenticated_client_action	str または UnauthenticatedClientAction 認証されていないクライアントがアプリへのアクセスを試みたときに実行するアクション。 既知の値は、"RedirectToLoginPage" と "AllowAnonymous" です。
token_store_enabled	bool <code>true</code> ログイン フロー中に取得されたプラットフォーム固有のセキュリティ トークンを永続的に格納する。それ以外の場合は <code>false</code>。 既定値は、<code>false</code> です。
allowed_external_redirect_urls	list[str] アプリのログインまたはログアウトの一環として にリダイレクトできる外部 URL。 URL のクエリ文字列部分は無視されることに注意してください。 これは、通常、Windows ストア アプリケーション バックエンドでのみ必要な詳細設定です。 現在のドメイン内の URL は常に暗黙的に許可されることに注意してください。
default_provider	str または BuiltInAuthenticationProvider 複数のプロバイダーが構成されている場合に使用する既定の認証プロバイダー。 この設定は、複数のプロバイダーが構成されていて、認証されていないクライアント アクションが "RedirectToLoginPage" に設定されている場合にのみ必要です。 既知の値は、"AzureActiveDirectory"、"Facebook"、"Google"、"MicrosoftAccount"、"Twitter"、"Github" です。
token_refresh_extension_hours	float セッション トークンの有効期限が切れた後、セッション トークンを使用してトークン更新 API を呼び出すことができる時間数。 既定値は 72 時間です。
client_id	str この証明書利用者アプリケーションのクライアント ID (client_idと呼ばれます)。 この設定は、Azure Active Directory または他のサードパーティの OpenID Connect プロバイダーで OpenID 接続認証を有効にするために必要です。 OpenID Connect の詳細については、以下を参照してください http://openid.net/specs/openid-connect-core-1_0.html。
client_secret	str この証明書利用者アプリケーションのクライアント シークレット (Azure Active Directory では、これはキーとも呼ばれます)。 この設定はオプションです。 クライアント シークレットが構成されていない場合は、OpenID Connect の暗黙的な認証フローを使用してエンド ユーザーを認証します。 それ以外の場合は、OpenID Connect 承認コード フローを使用してエンド ユーザーを認証します。 OpenID Connect の詳細については、以下を参照してください http://openid.net/specs/openid-connect-core-1_0.html。
client_secret_setting_name	str 証明書利用者アプリケーションのクライアント シークレットを含むアプリ設定名。
client_secret_certificate_thumbprint	str クライアント シークレットの代わりに、署名目的で使用される証明書の拇印です。 このプロパティは、クライアント シークレットの代わりに機能します。 また、省略可能です。
issuer	str このアプリケーションのアクセス トークンを発行するエンティティを表す 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してください。
validate_issuer	bool 発行者が有効な HTTPS URL で、そのように検証される必要があるかどうかを示す値を取得します。
allowed_audiences	list[str] Azure Active Directory によって発行された JWT を検証するときに考慮する対象ユーザーの値を許可します。 この設定に <code>ClientID</code> 関係なく、値は常に許可対象ユーザーと見なされることに注意してください。
additional_login_params	list[str] ユーザーがログインしたときに OpenID Connect 承認エンドポイントに送信するログイン パラメーター。 各パラメーターは、"key=value" 形式である必要があります。
aad_claims_authorization	str Azure AD Acl 設定を含む JSON 文字列を取得します。
google_client_id	str Google Web アプリケーションの OpenID Connect クライアント ID。 この設定は、Google サインインを有効にするために必要です。 Google Sign-In ドキュメント: https://developers.google.com/identity/sign-in/web/。
google_client_secret	str Google Web アプリケーションに関連付けられているクライアント シークレット。 この設定は、Google サインインを有効にするために必要です。 Google Sign-In ドキュメント: https://developers.google.com/identity/sign-in/web/。
google_client_secret_setting_name	str Google Web アプリケーションに関連付けられているクライアント シークレットを含むアプリ設定名。
google_o_auth_scopes	list[str] Google Sign-In 認証の一部として要求される OAuth 2.0 スコープ。 この設定はオプションです。 指定しない場合は、"openid"、"profile"、および "email" が既定のスコープとして使用されます。 Google Sign-In ドキュメント: https://developers.google.com/identity/sign-in/web/。
facebook_app_id	str ログインに使用される Facebook アプリのアプリ ID。 この設定は、Facebook ログインを有効にするために必要です。 Facebook ログインのドキュメント: https://developers.facebook.com/docs/facebook-login。
facebook_app_secret	str Facebook ログインに使用される Facebook アプリのアプリ シークレット。 この設定は、Facebook ログインを有効にするために必要です。 Facebook ログインのドキュメント: https://developers.facebook.com/docs/facebook-login。
facebook_app_secret_setting_name	str Facebook ログインに使用されるアプリ シークレットを含むアプリ設定名。
facebook_o_auth_scopes	list[str] Facebook ログイン認証の一部として要求される OAuth 2.0 スコープ。 この設定はオプションです。 Facebook ログインのドキュメント: https://developers.facebook.com/docs/facebook-login。
git_hub_client_id	str ログインに使用される GitHub アプリのクライアント ID。 この設定は、Github ログインを有効にするために必要です。
git_hub_client_secret	str GitHub ログインに使用される GitHub アプリのクライアント シークレット。 この設定は、Github ログインを有効にするために必要です。
git_hub_client_secret_setting_name	str GitHub ログインに使用される Github アプリのクライアント シークレットを含むアプリ設定名。
git_hub_o_auth_scopes	list[str] GitHub ログイン認証の一部として要求される OAuth 2.0 スコープ。 この設定はオプションです。
twitter_consumer_key	str サインインに使用される Twitter アプリケーションの OAuth 1.0a コンシューマー キー。 この設定は、Twitter サインインを有効にするために必要です。 Twitter Sign-In ドキュメント: https://dev.twitter.com/web/sign-in。
twitter_consumer_secret	str サインインに使用される Twitter アプリケーションの OAuth 1.0a コンシューマー シークレット。 この設定は、Twitter サインインを有効にするために必要です。 Twitter Sign-In ドキュメント: https://dev.twitter.com/web/sign-in。
twitter_consumer_secret_setting_name	str サインインに使用される Twitter アプリケーションの OAuth 1.0a コンシューマー シークレットを含むアプリ設定名。
microsoft_account_client_id	str 認証に使用されるアプリ用に作成された OAuth 2.0 クライアント ID。 この設定は、Microsoft アカウント認証を有効にするために必要です。 Microsoft アカウント OAuth のドキュメント: https://dev.onedrive.com/auth/msa_oauth.htm。
microsoft_account_client_secret	str 認証に使用されるアプリ用に作成された OAuth 2.0 クライアント シークレット。 この設定は、Microsoft アカウント認証を有効にするために必要です。 Microsoft アカウント OAuth のドキュメント: https://dev.onedrive.com/auth/msa_oauth.htm。
microsoft_account_client_secret_setting_name	str 認証に使用されるアプリ用に作成された OAuth 2.0 クライアント シークレットを含むアプリ設定名。
microsoft_account_o_auth_scopes	list[str] Microsoft アカウント認証の一部として要求される OAuth 2.0 スコープ。 この設定はオプションです。 指定しない場合は、既定のスコープとして "wl.basic" が使用されます。 Microsoft アカウントのスコープとアクセス許可に関するドキュメント: https://msdn.microsoft.com/en-us/library/dn631845.aspx。
is_auth_from_file	str 認証構成設定をファイルから読み取る必要がある場合は "true" 、それ以外の場合は "false" です。
auth_file_path	str 認証設定を含む構成ファイルのパス。 パスが相対パスの場合、base はサイトのルート ディレクトリになります。