共用方式為

SiteAuthSettings interface

  • 參考
套件:
@azure/arm-appservice-profile-2020-09-01-hybrid

Azure App Service 驗證/授權功能的組態設定。

Extends
ProxyOnlyResource

屬性

additionalLoginParams

當使用者登入時，要傳送至 OpenID Connect 授權端點的登入參數。 每個參數的格式都必須是 「key=value」。。
allowedAudiences

允許的物件值在驗證 Azure Active Directory 所發出的 JWT 時要考慮。 請注意，不論此設定為何，ClientID 值一律被視為允許的物件。
allowedExternalRedirectUrls

可在登入或註銷應用程式時重新導向至 的外部URL。 請注意，會忽略 URL 的查詢字串部分。 這是 Windows 市集應用程式後端通常需要的進階設定。 請注意，目前網域內的URL一律是隱含允許的。
clientId

此信賴憑證者應用程式的用戶端標識碼，稱為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

客戶端密碼的替代方案，也就是用於簽署之憑證的指紋。 這個屬性可作為客戶端密碼的取代專案。 它也是選擇性的。
defaultProvider

設定多個提供者時要使用的預設驗證提供者。 只有在設定多個提供者，且未驗證的客戶端動作設定為 “RedirectToLoginPage” 時，才需要此設定。
enabled

如果目前應用程式已啟用驗證/授權功能，true;否則，false。
facebookAppId

用於登入的 Facebook 應用程式的應用程式識別碼。 啟用Facebook登入需要此設定。 Facebook 登入檔：https://developers.facebook.com/docs/facebook-login
facebookAppSecret

用於 Facebook 登入之 Facebook 應用程式的應用程式秘密。 啟用Facebook登入需要此設定。 Facebook 登入檔：https://developers.facebook.com/docs/facebook-login
facebookOAuthScopes

將作為Facebook登入驗證一部分要求的OAuth 2.0範圍。 此設定是選擇性的。 Facebook 登入檔：https://developers.facebook.com/docs/facebook-login
googleClientId

Google Web 應用程式的 OpenID Connect 用戶端識別碼。 啟用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/
googleOAuthScopes

將作為Google Sign-In 驗證一部分要求的OAuth 2.0範圍。 此設定是選擇性的。 如果未指定，則會使用 「openid」、“profile」 和 「email」 作為預設範圍。 Google Sign-In 檔：https://developers.google.com/identity/sign-in/web/
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 用戶端識別碼。 啟用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
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
unauthenticatedClientAction

當未經驗證的客戶端嘗試存取應用程式時要採取的動作。
validateIssuer

取得值，指出簽發者是否應為有效的 HTTPS URL，並加以驗證。

繼承的屬性

id

資源標識碼。注意：此屬性將不會串行化。 它只能由伺服器填入。
kind

資源種類。
name

資源名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。
type

資源類型。 注意：這個屬性不會串行化。 它只能由伺服器填入。

屬性詳細資料

additionalLoginParams

當使用者登入時，要傳送至 OpenID Connect 授權端點的登入參數。 每個參數的格式都必須是 「key=value」。。

additionalLoginParams?: string[]

屬性值

string[]

allowedAudiences

允許的物件值在驗證 Azure Active Directory 所發出的 JWT 時要考慮。 請注意，不論此設定為何，ClientID 值一律被視為允許的物件。

allowedAudiences?: string[]

屬性值

string[]

allowedExternalRedirectUrls

可在登入或註銷應用程式時重新導向至 的外部URL。 請注意，會忽略 URL 的查詢字串部分。 這是 Windows 市集應用程式後端通常需要的進階設定。 請注意，目前網域內的URL一律是隱含允許的。

allowedExternalRedirectUrls?: string[]

屬性值

string[]

clientId

此信賴憑證者應用程式的用戶端標識碼，稱為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

defaultProvider

設定多個提供者時要使用的預設驗證提供者。 只有在設定多個提供者，且未驗證的客戶端動作設定為 “RedirectToLoginPage” 時，才需要此設定。

defaultProvider?: BuiltInAuthenticationProvider

屬性值

BuiltInAuthenticationProvider

enabled

如果目前應用程式已啟用驗證/授權功能，true;否則，false。

enabled?: boolean

屬性值

boolean

facebookAppId

用於登入的 Facebook 應用程式的應用程式識別碼。 啟用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

facebookOAuthScopes

將作為Facebook登入驗證一部分要求的OAuth 2.0範圍。 此設定是選擇性的。 Facebook 登入檔：https://developers.facebook.com/docs/facebook-login

facebookOAuthScopes?: string[]

屬性值

string[]

googleClientId

Google Web 應用程式的 OpenID Connect 用戶端識別碼。 啟用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

googleOAuthScopes

將作為Google Sign-In 驗證一部分要求的OAuth 2.0範圍。 此設定是選擇性的。 如果未指定，則會使用 「openid」、“profile」 和 「email」 作為預設範圍。 Google Sign-In 檔：https://developers.google.com/identity/sign-in/web/

googleOAuthScopes?: 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 用戶端識別碼。 啟用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

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

unauthenticatedClientAction

當未經驗證的客戶端嘗試存取應用程式時要採取的動作。

unauthenticatedClientAction?: UnauthenticatedClientAction

屬性值

UnauthenticatedClientAction

validateIssuer

取得值，指出簽發者是否應為有效的 HTTPS URL，並加以驗證。

validateIssuer?: boolean

屬性值

boolean

繼承的屬性詳細資料

id

資源標識碼。注意：此屬性將不會串行化。 它只能由伺服器填入。

id?: string

屬性值

string

繼承自ProxyOnlyResource.id

kind

資源種類。

kind?: string

屬性值

string

繼承自ProxyOnlyResource.kind

name

資源名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。

name?: string

屬性值

string

繼承自ProxyOnlyResource.name 的

type

資源類型。 注意：這個屬性不會串行化。 它只能由伺服器填入。

type?: string

屬性值

string

繼承自ProxyOnlyResource.type