Method: getPasswordPolicy

プロジェクトまたはテナントで設定されたパスワード ポリシー構成を取得します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
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 パスワード ポリシーに準拠していないパスワードは拒否され、エラーがスローされます。