emailAuthenticationMethodConfiguration Ressourcentyp

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Stellt die Richtlinie für E-Mail-Authentifizierungsmethoden mit Einmalkennungen (One-Time Passcode, OTP) dieses Mandanten dar. Authentifizierungsmethodenrichtlinien definieren Konfigurationseinstellungen und Benutzer oder Gruppen, die für die Verwendung der Authentifizierungsmethode aktiviert sind. Die cloudnativen Benutzer des Mandanten können E-Mail-OTP für die Self-Service-Kennwortzurücksetzung verwenden. Externe Benutzer können E-Mail-OTP für die Authentifizierung während der Einlösung von Einladungen und die Self-Service-Registrierung für bestimmte Apps in Benutzerflows verwenden.

Erbt von authenticationMethodConfiguration.

Methoden

Methode Rückgabetyp Beschreibung
Get emailAuthenticationMethodConfiguration Lesen Sie die Eigenschaften und Beziehungen eines emailAuthenticationMethodConfiguration-Objekts.
Update Keine Aktualisieren Sie die Eigenschaften eines emailAuthenticationMethodConfiguration-Objekts.
Löschen Keine Setzt das emailAuthenticationMethodConfiguration-Objekt auf die Standardkonfiguration zurück.

Eigenschaften

Eigenschaft Typ Beschreibung
allowExternalIdToUseEmailOtp externalEmailOtpState Bestimmt, ob E-Mail-OTP von externen Benutzern zur Authentifizierung verwendet werden kann. Mögliche Werte sind: default, enabled, disabled, unknownFutureValue. Für Mandanten im Bundesstaat, die default die Beta-API nicht verwendet haben, ist E-Mail-OTP ab Oktober 2021 automatisch aktiviert.
excludeTargets excludeTarget-Sammlung Gruppen von Benutzern, die von der Richtlinie ausgeschlossen sind.
id Zeichenfolge Der Richtlinienbezeichner der Authentifizierungsmethode. Geerbt von authenticationMethodConfiguration.
state authenticationMethodState Gibt an, ob diese Authentifizierungsmethode aktiviert ist oder nicht. Die möglichen Werte sind: enabled, disabled.

Beziehungen

Beziehung Typ Beschreibung
includeTargets AuthenticationMethodTarget-Sammlung Eine Auflistung von Gruppen, die für die Verwendung der Authentifizierungsmethode aktiviert sind.

JSON-Darstellung

Die folgende JSON-Darstellung veranschaulicht den Ressourcentyp.

{
  "@odata.type": "#microsoft.graph.emailAuthenticationMethodConfiguration",
  "allowExternalIdToUseEmailOtp": "String",
    "excludeTargets": [
    {
      "@odata.type": "microsoft.graph.excludeTarget"
    }
  ],
  "id": "String (identifier)",
  "includeTargets": [ { "@odata.type": "microsoft.graph.authenticationMethodTarget" } ],
  "state": "String"
}