Method: getPasswordPolicy

取得專案或租用戶的密碼政策設定組合。

HTTP 要求

GET https://identitytoolkit.googleapis.com/v2/passwordPolicy

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
tenantId

string

租戶的 ID。

要求主體

要求主體必須為空白。

回應主體

密碼政策的設定。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "customStrengthOptions": {
    object (CustomStrengthOptions)
  },
  "schemaVersion": integer,
  "allowedNonAlphanumericCharacters": [
    string
  ],
  "enforcementState": enum (EnforcementState),
  "forceUpgradeOnSignin": boolean
}
欄位
customStrengthOptions

object (CustomStrengthOptions)

密碼政策強制執行的自訂強度選項。
schemaVersion

integer

僅供輸出。密碼政策的結構定義版本號碼
allowedNonAlphanumericCharacters[]

string

僅供輸出。符合 non_alphanumeric 規定的字元。
enforcementState

enum (EnforcementState)

僅供輸出。密碼政策要使用的強制執行模式。
forceUpgradeOnSignin

boolean

使用者必須使用符合密碼政策的密碼才能登入。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/cloud-platform

詳情請參閱 Authentication Overview。

CustomStrengthOptions

強制使用者密碼採用的自訂強度選項。

JSON 表示法 
{
  "minPasswordLength": integer,
  "maxPasswordLength": integer,
  "containsLowercaseCharacter": boolean,
  "containsUppercaseCharacter": boolean,
  "containsNumericCharacter": boolean,
  "containsNonAlphanumericCharacter": boolean
}
欄位
minPasswordLength

integer

密碼長度下限。範圍為 6 到 30
maxPasswordLength

integer

密碼長度上限。沒有預設長度上限
containsLowercaseCharacter

boolean

密碼必須包含小寫字元。
containsUppercaseCharacter

boolean

密碼必須包含大寫字元。
containsNumericCharacter

boolean

密碼必須包含數字。
containsNonAlphanumericCharacter

boolean

密碼必須包含非英數字元。

EnforcementState

密碼政策的強制執行狀態

列舉
ENFORCEMENT_STATE_UNSPECIFIED 未設定強制執行狀態。
OFF 專案不會使用密碼政策。
ENFORCE 系統會拒絕不符合密碼政策的密碼，並擲回錯誤。