SiteAuthSettings interface

パッケージ:

@azure/arm-appservice

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

Extends

ProxyOnlyResource

プロパティ

aadClaimsAuthorization	Azure AD Acl 設定を含む JSON 文字列を取得します。
additionalLoginParams	ユーザーがログインしたときに OpenID Connect 承認エンドポイントに送信するログイン パラメーター。 各パラメーターは、"key=value" の形式である必要があります。
allowedAudiences	Azure Active Directory によって発行された JSON Web トークンを検証するときに考慮する対象ユーザーの値を許可します。 ClientID 値は、この設定に関係なく、常に許可対象ユーザーと見なされることに注意してください。
allowedExternalRedirectUrls	アプリのログインまたはログアウトの一環としてリダイレクトできる外部 URL。 URL のクエリ文字列部分は無視されることに注意してください。 これは、通常、Windows ストア アプリケーション バックエンドでのみ必要な詳細設定です。 現在のドメイン内の URL は常に暗黙的に許可されることに注意してください。
authFilePath	認証設定を含む構成ファイルのパス。 パスが相対パスの場合、ベースはサイトのルート ディレクトリになります。
clientId	この証明書利用者アプリケーションのクライアント ID (client_idと呼ばれます)。 この設定は、Azure Active Directory または他のサード パーティの OpenID Connect プロバイダーで OpenID 接続認証を有効にするために必要です。 OpenID Connect の詳細: http://openid.net/specs/openid-connect-core-1_0.html
clientSecret	この証明書利用者アプリケーションのクライアント シークレット (Azure Active Directory では、これはキーとも呼ばれます)。 この設定は省略可能です。 クライアント シークレットが構成されていない場合は、OpenID Connect の暗黙的な認証フローを使用してエンド ユーザーを認証します。 それ以外の場合は、OpenID Connect 承認コード フローを使用してエンド ユーザーを認証します。 OpenID Connect の詳細: http://openid.net/specs/openid-connect-core-1_0.html
clientSecretCertificateThumbprint	クライアント シークレットの代わりに、署名目的で使用される証明書の拇印です。 このプロパティは、クライアント シークレットの代わりに機能します。 また、省略可能です。
clientSecretSettingName	証明書利用者アプリケーションのクライアント シークレットを含むアプリ設定名。
configVersion	現在のアプリで使用されている認証/承認機能の ConfigVersion。 この値の設定は、認証/承認のコントロール プレーンの動作を制御できます。
defaultProvider	複数のプロバイダーが構成されている場合に使用する既定の認証プロバイダー。 この設定は、複数のプロバイダーが構成されていて、認証されていないクライアント アクションが "RedirectToLoginPage" に設定されている場合にのみ必要です。
enabled	現在のアプリに対して認証/承認機能が有効になっているかどうかを true します。それ以外の場合は、falseします。
facebookAppId	ログインに使用される Facebook アプリのアプリ ID。 この設定は、Facebook ログインを有効にするために必要です。 Facebook ログインのドキュメント: https://developers.facebook.com/docs/facebook-login
facebookAppSecret	Facebook ログインに使用される Facebook アプリのアプリ シークレット。 この設定は、Facebook ログインを有効にするために必要です。 Facebook ログインのドキュメント: https://developers.facebook.com/docs/facebook-login
facebookAppSecretSettingName	Facebook ログインに使用されるアプリ シークレットを含むアプリ設定名。
facebookOAuthScopes	Facebook ログイン認証の一部として要求される OAuth 2.0 スコープ。 この設定は省略可能です。 Facebook ログインのドキュメント: https://developers.facebook.com/docs/facebook-login
gitHubClientId	ログインに使用される GitHub アプリのクライアント ID。 この設定は、Github ログインを有効にするために必要です
gitHubClientSecret	GitHub ログインに使用される GitHub アプリのクライアント シークレット。 この設定は、Github ログインを有効にするために必要です。
gitHubClientSecretSettingName	GitHub ログインに使用される GitHub アプリのクライアント シークレットを含むアプリ設定名。
gitHubOAuthScopes	GitHub ログイン認証の一部として要求される OAuth 2.0 スコープ。 この設定は省略可能です
googleClientId	Google Web アプリケーションの OpenID Connect クライアント ID。 この設定は、Google サインインを有効にするために必要です。 Google Sign-In ドキュメント: https://developers.google.com/identity/sign-in/web/
googleClientSecret	Google Web アプリケーションに関連付けられているクライアント シークレット。 この設定は、Google サインインを有効にするために必要です。 Google Sign-In ドキュメント: https://developers.google.com/identity/sign-in/web/
googleClientSecretSettingName	Google Web アプリケーションに関連付けられているクライアント シークレットを含むアプリ設定名。
googleOAuthScopes	Google Sign-In 認証の一部として要求される OAuth 2.0 スコープ。 この設定は省略可能です。 指定しない場合、"openid"、"profile"、および "email" が既定のスコープとして使用されます。 Google Sign-In ドキュメント: https://developers.google.com/identity/sign-in/web/
isAuthFromFile	認証構成設定をファイルから読み取る必要がある場合は "true"、それ以外の場合は "false"
issuer	このアプリケーションのアクセス トークンを発行するエンティティを表す 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
microsoftAccountClientId	認証に使用されるアプリ用に作成された OAuth 2.0 クライアント ID。 この設定は、Microsoft アカウント認証を有効にするために必要です。 Microsoft アカウント OAuth のドキュメント: https://dev.onedrive.com/auth/msa_oauth.htm
microsoftAccountClientSecret	認証に使用されるアプリ用に作成された OAuth 2.0 クライアント シークレット。 この設定は、Microsoft アカウント認証を有効にするために必要です。 Microsoft アカウント OAuth のドキュメント: https://dev.onedrive.com/auth/msa_oauth.htm
microsoftAccountClientSecretSettingName	認証に使用されるアプリ用に作成された OAuth 2.0 クライアント シークレットを含むアプリ設定。
microsoftAccountOAuthScopes	Microsoft アカウント認証の一部として要求される OAuth 2.0 スコープ。 この設定は省略可能です。 指定しない場合は、既定のスコープとして "wl.basic" が使用されます。 Microsoft アカウントのスコープとアクセス許可に関するドキュメント: https://msdn.microsoft.com/en-us/library/dn631845.aspx
runtimeVersion	現在のアプリで使用されている認証/承認機能の RuntimeVersion。 この値の設定は、認証/承認モジュールの特定の機能の動作を制御できます。
tokenRefreshExtensionHours	セッション トークンがトークン更新 API の呼び出しに使用できるセッション トークンの有効期限後の時間数。 既定値は 72 時間です。
tokenStoreEnabled	ログイン フロー中に取得されたプラットフォーム固有のセキュリティ トークンを永続的に格納 true。それ以外の場合は、falseします。 既定値は falseです。
twitterConsumerKey	サインインに使用される Twitter アプリケーションの OAuth 1.0a コンシューマー キー。 この設定は、Twitter サインインを有効にするために必要です。 Twitter Sign-In ドキュメント: https://dev.twitter.com/web/sign-in
twitterConsumerSecret	サインインに使用される Twitter アプリケーションの OAuth 1.0a コンシューマー シークレット。 この設定は、Twitter サインインを有効にするために必要です。 Twitter Sign-In ドキュメント: https://dev.twitter.com/web/sign-in
twitterConsumerSecretSettingName	サインインに使用される Twitter アプリケーションの OAuth 1.0a コンシューマー シークレットを含むアプリ設定名。
unauthenticatedClientAction	認証されていないクライアントがアプリにアクセスしようとしたときに実行するアクション。
validateIssuer	発行者が有効な HTTPS URL で、そのように検証される必要があるかどうかを示す値を取得します。

継承されたプロパティ

id	リソース ID。注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
kind	リソースの種類。
name	リソース名。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
type	リソースの種類。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

プロパティの詳細

aadClaimsAuthorization

Azure AD Acl 設定を含む JSON 文字列を取得します。

aadClaimsAuthorization?: string

プロパティ値

string

additionalLoginParams

ユーザーがログインしたときに OpenID Connect 承認エンドポイントに送信するログイン パラメーター。 各パラメーターは、"key=value" の形式である必要があります。

additionalLoginParams?: string[]

プロパティ値

string[]

allowedAudiences

Azure Active Directory によって発行された JSON Web トークンを検証するときに考慮する対象ユーザーの値を許可します。 ClientID 値は、この設定に関係なく、常に許可対象ユーザーと見なされることに注意してください。

allowedAudiences?: string[]

プロパティ値

string[]

allowedExternalRedirectUrls

アプリのログインまたはログアウトの一環としてリダイレクトできる外部 URL。 URL のクエリ文字列部分は無視されることに注意してください。 これは、通常、Windows ストア アプリケーション バックエンドでのみ必要な詳細設定です。 現在のドメイン内の URL は常に暗黙的に許可されることに注意してください。

allowedExternalRedirectUrls?: string[]

プロパティ値

string[]

authFilePath

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

authFilePath?: string

プロパティ値

string

clientId

この証明書利用者アプリケーションのクライアント ID (client_idと呼ばれます)。 この設定は、Azure Active Directory または他のサード パーティの OpenID Connect プロバイダーで OpenID 接続認証を有効にするために必要です。 OpenID Connect の詳細: http://openid.net/specs/openid-connect-core-1_0.html

clientId?: string

プロパティ値

string

clientSecret

この証明書利用者アプリケーションのクライアント シークレット (Azure Active Directory では、これはキーとも呼ばれます)。 この設定は省略可能です。 クライアント シークレットが構成されていない場合は、OpenID Connect の暗黙的な認証フローを使用してエンド ユーザーを認証します。 それ以外の場合は、OpenID Connect 承認コード フローを使用してエンド ユーザーを認証します。 OpenID Connect の詳細: http://openid.net/specs/openid-connect-core-1_0.html

clientSecret?: string

プロパティ値

string

clientSecretCertificateThumbprint

クライアント シークレットの代わりに、署名目的で使用される証明書の拇印です。 このプロパティは、クライアント シークレットの代わりに機能します。 また、省略可能です。

clientSecretCertificateThumbprint?: string

プロパティ値

string

clientSecretSettingName

証明書利用者アプリケーションのクライアント シークレットを含むアプリ設定名。

clientSecretSettingName?: string

プロパティ値

string

configVersion

現在のアプリで使用されている認証/承認機能の ConfigVersion。 この値の設定は、認証/承認のコントロール プレーンの動作を制御できます。

configVersion?: string

プロパティ値

string

defaultProvider

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

defaultProvider?: BuiltInAuthenticationProvider

プロパティ値

BuiltInAuthenticationProvider

enabled

現在のアプリに対して認証/承認機能が有効になっているかどうかを true します。それ以外の場合は、falseします。

enabled?: boolean

プロパティ値

boolean

facebookAppId

ログインに使用される Facebook アプリのアプリ ID。 この設定は、Facebook ログインを有効にするために必要です。 Facebook ログインのドキュメント: https://developers.facebook.com/docs/facebook-login

facebookAppId?: string

プロパティ値

string

facebookAppSecret

Facebook ログインに使用される Facebook アプリのアプリ シークレット。 この設定は、Facebook ログインを有効にするために必要です。 Facebook ログインのドキュメント: https://developers.facebook.com/docs/facebook-login

facebookAppSecret?: string

プロパティ値

string

facebookAppSecretSettingName

Facebook ログインに使用されるアプリ シークレットを含むアプリ設定名。

facebookAppSecretSettingName?: string

プロパティ値

string

facebookOAuthScopes

Facebook ログイン認証の一部として要求される OAuth 2.0 スコープ。 この設定は省略可能です。 Facebook ログインのドキュメント: https://developers.facebook.com/docs/facebook-login

facebookOAuthScopes?: string[]

プロパティ値

string[]

gitHubClientId

ログインに使用される GitHub アプリのクライアント ID。 この設定は、Github ログインを有効にするために必要です

gitHubClientId?: string

プロパティ値

string

gitHubClientSecret

GitHub ログインに使用される GitHub アプリのクライアント シークレット。 この設定は、Github ログインを有効にするために必要です。

gitHubClientSecret?: string

プロパティ値

string

gitHubClientSecretSettingName

GitHub ログインに使用される GitHub アプリのクライアント シークレットを含むアプリ設定名。

gitHubClientSecretSettingName?: string

プロパティ値

string

gitHubOAuthScopes

GitHub ログイン認証の一部として要求される OAuth 2.0 スコープ。 この設定は省略可能です

gitHubOAuthScopes?: string[]

プロパティ値

string[]

googleClientId

Google Web アプリケーションの OpenID Connect クライアント ID。 この設定は、Google サインインを有効にするために必要です。 Google Sign-In ドキュメント: https://developers.google.com/identity/sign-in/web/

googleClientId?: string

プロパティ値

string

googleClientSecret

Google Web アプリケーションに関連付けられているクライアント シークレット。 この設定は、Google サインインを有効にするために必要です。 Google Sign-In ドキュメント: https://developers.google.com/identity/sign-in/web/

googleClientSecret?: string

プロパティ値

string

googleClientSecretSettingName

Google Web アプリケーションに関連付けられているクライアント シークレットを含むアプリ設定名。

googleClientSecretSettingName?: string

プロパティ値

string

googleOAuthScopes

Google Sign-In 認証の一部として要求される OAuth 2.0 スコープ。 この設定は省略可能です。 指定しない場合、"openid"、"profile"、および "email" が既定のスコープとして使用されます。 Google Sign-In ドキュメント: https://developers.google.com/identity/sign-in/web/

googleOAuthScopes?: string[]

プロパティ値

string[]

isAuthFromFile

認証構成設定をファイルから読み取る必要がある場合は "true"、それ以外の場合は "false"

isAuthFromFile?: string

プロパティ値

string

issuer

このアプリケーションのアクセス トークンを発行するエンティティを表す 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

issuer?: string

プロパティ値

string

microsoftAccountClientId

認証に使用されるアプリ用に作成された OAuth 2.0 クライアント ID。 この設定は、Microsoft アカウント認証を有効にするために必要です。 Microsoft アカウント OAuth のドキュメント: https://dev.onedrive.com/auth/msa_oauth.htm

microsoftAccountClientId?: string

プロパティ値

string

microsoftAccountClientSecret

認証に使用されるアプリ用に作成された OAuth 2.0 クライアント シークレット。 この設定は、Microsoft アカウント認証を有効にするために必要です。 Microsoft アカウント OAuth のドキュメント: https://dev.onedrive.com/auth/msa_oauth.htm

microsoftAccountClientSecret?: string

プロパティ値

string

microsoftAccountClientSecretSettingName

認証に使用されるアプリ用に作成された OAuth 2.0 クライアント シークレットを含むアプリ設定。

microsoftAccountClientSecretSettingName?: string

プロパティ値

string

microsoftAccountOAuthScopes

Microsoft アカウント認証の一部として要求される OAuth 2.0 スコープ。 この設定は省略可能です。 指定しない場合は、既定のスコープとして "wl.basic" が使用されます。 Microsoft アカウントのスコープとアクセス許可に関するドキュメント: https://msdn.microsoft.com/en-us/library/dn631845.aspx

microsoftAccountOAuthScopes?: string[]

プロパティ値

string[]

runtimeVersion

現在のアプリで使用されている認証/承認機能の RuntimeVersion。 この値の設定は、認証/承認モジュールの特定の機能の動作を制御できます。

runtimeVersion?: string

プロパティ値

string

tokenRefreshExtensionHours

セッション トークンがトークン更新 API の呼び出しに使用できるセッション トークンの有効期限後の時間数。 既定値は 72 時間です。

tokenRefreshExtensionHours?: number

プロパティ値

number

tokenStoreEnabled

ログイン フロー中に取得されたプラットフォーム固有のセキュリティ トークンを永続的に格納 true。それ以外の場合は、falseします。 既定値は falseです。

tokenStoreEnabled?: boolean

プロパティ値

boolean

twitterConsumerKey

サインインに使用される Twitter アプリケーションの OAuth 1.0a コンシューマー キー。 この設定は、Twitter サインインを有効にするために必要です。 Twitter Sign-In ドキュメント: https://dev.twitter.com/web/sign-in

twitterConsumerKey?: string

プロパティ値

string

twitterConsumerSecret

サインインに使用される Twitter アプリケーションの OAuth 1.0a コンシューマー シークレット。 この設定は、Twitter サインインを有効にするために必要です。 Twitter Sign-In ドキュメント: https://dev.twitter.com/web/sign-in

twitterConsumerSecret?: string

プロパティ値

string

twitterConsumerSecretSettingName

サインインに使用される Twitter アプリケーションの OAuth 1.0a コンシューマー シークレットを含むアプリ設定名。

twitterConsumerSecretSettingName?: string

プロパティ値

string

unauthenticatedClientAction

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

unauthenticatedClientAction?: UnauthenticatedClientAction

プロパティ値

UnauthenticatedClientAction

validateIssuer

発行者が有効な HTTPS URL で、そのように検証される必要があるかどうかを示す値を取得します。

validateIssuer?: boolean

プロパティ値

boolean

継承されたプロパティの詳細

id

リソース ID。注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

id?: string

プロパティ値

string

ProxyOnlyResource.id 年から継承

kind

リソースの種類。

kind?: string

プロパティ値

string

ProxyOnlyResource.kind から継承された

name

リソース名。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

name?: string

プロパティ値

string

ProxyOnlyResource.name から継承

type

リソースの種類。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

type?: string

プロパティ値

string

継承元ProxyOnlyResource.type