Method: getPasswordPolicy

Ruft die Konfiguration der Passwortrichtlinie für das Projekt oder den Mandanten ab.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
tenantId

string

Die ID eines Mandanten.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Konfiguration der Passwortrichtlinie.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "customStrengthOptions": {
    object (CustomStrengthOptions)
  },
  "schemaVersion": integer,
  "allowedNonAlphanumericCharacters": [
    string
  ],
  "enforcementState": enum (EnforcementState),
  "forceUpgradeOnSignin": boolean
}
Felder
customStrengthOptions

object (CustomStrengthOptions)

Die benutzerdefinierten Stärkeoptionen, die von der Passwortrichtlinie erzwungen werden.
schemaVersion

integer

Nur Ausgabe. Schemaversion für die Passwortrichtlinie
allowedNonAlphanumericCharacters[]

string

Nur Ausgabe. Zulässige Zeichen, die die Anforderung „non_alphanumeric“ erfüllen.
enforcementState

enum (EnforcementState)

Nur Ausgabe. Welcher Erzwingungsmodus für die Passwortrichtlinie verwendet werden soll.
forceUpgradeOnSignin

boolean

Nutzer müssen ein Passwort haben, das der Passwortrichtlinie entspricht, um sich anzumelden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

CustomStrengthOptions

Benutzerdefinierte Optionen für die Passwortstärke, die für Nutzerpasswörter erzwungen werden sollen.

JSON-Darstellung 
{
  "minPasswordLength": integer,
  "maxPasswordLength": integer,
  "containsLowercaseCharacter": boolean,
  "containsUppercaseCharacter": boolean,
  "containsNumericCharacter": boolean,
  "containsNonAlphanumericCharacter": boolean
}
Felder
minPasswordLength

integer

Mindestlänge des Passworts. Liegt im Bereich von 6 bis 30
maxPasswordLength

integer

Maximale Passwortlänge. Keine Standardmaximallänge
containsLowercaseCharacter

boolean

Das Passwort muss einen Kleinbuchstaben enthalten.
containsUppercaseCharacter

boolean

Das Passwort muss einen Großbuchstaben enthalten.
containsNumericCharacter

boolean

Das Passwort muss eine Ziffer enthalten.
containsNonAlphanumericCharacter

boolean

Das Passwort muss ein nicht alphanumerisches Zeichen enthalten.

EnforcementState

Erzwingungsstatus für die Passwortrichtlinie

Enums
ENFORCEMENT_STATE_UNSPECIFIED Der Status der Erzwingung wurde nicht festgelegt.
OFF Die Passwortrichtlinie wird für das Projekt nicht verwendet.
ENFORCE Passwörter, die nicht der Passwortrichtlinie entsprechen, werden abgelehnt und es wird ein Fehler ausgegeben.