homeRealmDiscoveryPolicy-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 eine Richtlinie zum Steuern Microsoft Entra Authentifizierungsverhaltens für Verbundbenutzer dar, insbesondere für Einschränkungen der automatischen Beschleunigung und Benutzerauthentifizierung in Verbunddomänen. Sie können homeRealmDiscoveryPolicy für alle Dienstprinzipale in Ihrem organization oder für bestimmte Dienstprinzipale in Ihrem organization festlegen. Weitere Szenario- und Richtliniendetails finden Sie unter Konfigurieren Microsoft Entra Anmeldeverhaltens für eine Anwendung mithilfe einer Richtlinie für die Startbereichsermittlung sowie Anmelden bei Microsoft Entra ID mit E-Mail als alternative Anmelde-ID.

Erbt von stsPolicy.

Methoden

Methode Rückgabetyp Beschreibung
Erstellen von homeRealmDiscoveryPolicy homeRealmDiscoveryPolicy Erstellen Sie ein homeRealmDiscoveryPolicy-Objekt.
HomeRealmDiscoveryPolicy abrufen homeRealmDiscoveryPolicy Lesen von Eigenschaften und Beziehungen eines homeRealmDiscoveryPolicy-Objekts.
List homeRealmDiscoveryPolicies homeRealmDiscoveryPolicy Liest Eigenschaften und Beziehungen von homeRealmDiscoveryPolicies-Objekten.
Aktualisieren von homeRealmDiscoveryPolicy Keine Aktualisieren eines homeRealmDiscoveryPolicy-Objekts.
homeRealmDiscoveryPolicy löschen Keine Löschen sie ein homeRealmDiscoveryPolicy-Objekt.
Auflisten von "appliesTo" directoryObject collection Rufen Sie die Liste der directoryObjects ab, auf die diese Richtlinie angewendet wurde.
Assign homeRealmDiscoveryPolicy Keine Weisen Sie einem servicePrincipal-Objekt ein homeRealmDiscoveryPolicy-Objekt zu.
Auflisten der zugewiesenen homeRealmDiscoveryPolicy homeRealmDiscoveryPolicy-Sammlung Auflisten der homeRealmDiscoveryPolicy-Objekte, die einem servicePrincipal-Objekt zugewiesen sind.
Remove homeRealmDiscoveryPolicy Keine Entfernen Sie ein homeRealmDiscoveryPolicy-Objekt aus einem servicePrincipal-Objekt .

Eigenschaften

Eigenschaft Typ Beschreibung
id String Eindeutiger Bezeichner für diese Richtlinie. Schreibgeschützt.
Definition String-Sammlung Eine Zeichenfolgenauflistung, die eine JSON-Zeichenfolge enthält, die die Regeln und Einstellungen für diese Richtlinie definiert. Weitere Informationen zum JSON-Schema für diese Eigenschaft finden Sie unter Eigenschaften einer Richtliniendefinition für die Startbereichsermittlung . Erforderlich.
description String Beschreibung für diese Richtlinie.
displayName String Anzeigename für diese Richtlinie. Erforderlich.
isOrganizationDefault Boolesch Wenn auf truefestgelegt ist, wird diese Richtlinie aktiviert. Es kann viele Richtlinien für denselben Richtlinientyp geben, aber nur eine kann als organization Standard aktiviert werden. Optional, der Standardwert ist false.

Eigenschaften einer Richtliniendefinition für die Startbereichsermittlung

Die folgenden Eigenschaften bilden das JSON-Objekt, das eine Richtlinie für die Tokengültigkeitsdauer darstellt. Dieses JSON-Objekt muss in eine Zeichenfolge mit Escapezeichen für Anführungszeichen konvertiert werden, damit es in die Definitionseigenschaft eingefügt wird. Unten sehen Sie ein Beispiel im JSON-Format:

"definition": [
    "{
        \"HomeRealmDiscoveryPolicy\": {
          \"AccelerateToFederatedDomain\":true,
          \"AllowCloudPasswordValidation\": false,
          \"PreferredDomain\":\"federated.example.edu\",
          \"AlternateIdLogin\":{
            \"Enabled\":true
          }
        }
      }"
  ]
Eigenschaft Typ Beschreibung
AccelerateToFederatedDomain Boolesch Legen Sie für die automatische Beschleunigung auf true fest (Startbereichsermittlung umgehen). Wenn true nur eine überprüfte Verbunddomäne im Mandanten vorhanden ist, werden Die Benutzer zur Anmeldung direkt zum Verbundidentitätsanbieter (z. B. AD FS) weitergeleitet. Wenn true mehrere überprüfte Domänen im Mandanten vorhanden sind, muss PreferredDomain angegeben werden. Optional.
AllowCloudPasswordValidation Boolesch Legen Sie diese Einstellung auf true fest, damit eine Anwendung einen Verbundbenutzer authentifizieren kann, indem sie Anmeldeinformationen für Benutzername/Kennwort direkt an den Microsoft Entra Tokenendpunkt vorlegt. Funktioniert nur, wenn die Kennworthashsynchronisierung aktiviert ist. Optional.
AlternateIdLogin Json Legen Sie diesen Wert auf {\"Enabled\": true} fest, um Microsoft Entra Anmeldung per E-Mail als alternative Anmelde-ID zuzulassen. Funktioniert nur, wenn IsOrganizationDefault auf truefestgelegt ist. Optional.
PreferredDomain String Gibt eine Domäne an, bei der die Anmeldung beschleunigt werden soll. Sie kann weggelassen werden, wenn der Mandant nur über eine Verbunddomäne verfügt. Wenn sie nicht angegeben wird und mehr als eine überprüfte Verbunddomäne vorhanden ist, hat diese Richtlinie keine Auswirkung. Erforderlich, wenn AccelerateToFederatedDomain ist true.

Beziehungen

Beziehung Typ Beschreibung
Appliesto directoryObject collection Die directoryObject-Auflistung , auf die diese Richtlinie angewendet wurde. Schreibgeschützt.

JSON-Darstellung

Die folgende JSON-Darstellung zeigt den Ressourcentyp.

{
  "definition": ["String"],
  "description": "String",
  "displayName": "String",
  "id": "String (identifier)",
  "isOrganizationDefault": true
}