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 系统会拒绝不符合密码政策的密码，并抛出错误。