homeRealmDiscoveryPolicy-Ressourcentyp

Artikel
07/16/2024

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

Erbt von stsPolicy.

Methoden

Methode	Rückgabetyp	Beschreibung
List	homeRealmDiscoveryPolicy	Liest Eigenschaften und Beziehungen von homeRealmDiscoveryPolicies-Objekten.
Create	homeRealmDiscoveryPolicy	Erstellen Sie ein homeRealmDiscoveryPolicy-Objekt.
Get	homeRealmDiscoveryPolicy	Lesen von Eigenschaften und Beziehungen eines homeRealmDiscoveryPolicy-Objekts.
Update	Keine	Aktualisieren eines homeRealmDiscoveryPolicy-Objekts.
Delete	Keine	Löschen sie ein homeRealmDiscoveryPolicy-Objekt.
Liste gilt für	directoryObject collection	Rufen Sie die Liste der directoryObjects ab, auf die diese Richtlinie angewendet wurde.
Zuweisen zum Dienstprinzipal	Keine	Weisen Sie einem servicePrincipal-Objekt ein homeRealmDiscoveryPolicy-Objekt zu.
Liste, die dem Dienstprinzipal zugewiesen ist	homeRealmDiscoveryPolicy-Sammlung	Auflisten der homeRealmDiscoveryPolicy-Objekte, die einem servicePrincipal-Objekt zugewiesen sind.
Aufheben der Zuweisung vom Dienstprinzipal	Keine	Entfernen Sie ein homeRealmDiscoveryPolicy-Objekt aus einem servicePrincipal-Objekt .

Eigenschaften

Eigenschaft	Typ	Beschreibung
id	Zeichenfolge	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	Zeichenfolge	Beschreibung für diese Richtlinie.
displayName	Zeichenfolge	Anzeigename für diese Richtlinie. Erforderlich.
isOrganizationDefault	Boolesch	Wenn auf `true`festgelegt ist, wird diese Richtlinie aktiviert. Es kann viele Richtlinien für denselben Richtlinientyp geben, aber nur eine kann als Standardeinstellung der Organisation aktiviert werden. Optional, der Standardwert ist `false`.

Eigenschaften einer Richtliniendefinition für die Startbereichsermittlung

Das folgende Objekt zeigt die Eigenschaften, die das JSON-Objekt für eine Richtliniendefinition für die Tokengültigkeitsdauer bilden. Dieses JSON-Objekt muss in eine Zeichenfolge mit Escapezeichen für Anführungszeichen konvertiert werden, um in die Definitionseigenschaft eingefügt zu werden, wie im folgenden Beispiel gezeigt.

"definition": [
    "{
        \"HomeRealmDiscoveryPolicy\": {
          \"AccelerateToFederatedDomain\":true,
          \"AllowCloudPasswordValidation\": false,
          \"PreferredDomain\":\"federated.example.edu\",
          \"AlternateIdLogin\":{
            \"Enabled\":true
          }
        }
      }"
  ]

Eigenschaft	Typ	Beschreibung
AccelerateToFederatedDomain	Boolesch	Legen Sie für `true` die automatische Entschleunigung auf 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 Die 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 die Anmeldung bei Microsoft Entra mit E-Mail als alternative Anmelde-ID zuzulassen. Funktioniert nur, wenn IsOrganizationDefault auf `true`festgelegt ist. Optional.
PreferredDomain	Zeichenfolge	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
}

Freigeben über