Share via


b2cIdentityUserFlow-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 einen Benutzerablauf innerhalb eines Azure Active Directory B2C-Mandanten dar.

Um Ihnen beim Einrichten der am häufigsten verwendeten Identitätsabläufe für Ihre Anwendungen zu helfen, umfasst Azure Active Directory B2C vordefinierte, konfigurierbare Richtlinien namens Benutzerabläufe. Mithilfe eines Benutzerablaufs können Sie festlegen, wie Benutzer mit Ihrer Anwendung interagieren, wenn sie sich z. B. anmelden, registrieren, ein Profil bearbeiten oder ein Kennwort zurücksetzen. Sie können in Ihrem Mandanten mehrere Benutzerabläufe unterschiedlicher Art erstellen und sie nach Bedarf in Ihren Anwendungen verwenden. Mit Benutzerabläufen können Sie Folgendes steuern:

  • Welche Kontotypen für die Anmeldung verwendet werden, z. B. Social Media-Konten wie ein Facebook-Konto oder ein lokales Konto
  • Welche Attribute des Nutzers erfasst werden sollen, z. B. Vorname, Postleitzahl oder Schuhgröße
  • Mehrstufige Azure-Authentifizierung
  • Anpassung der Benutzeroberfläche
  • Informationen, die von der Anwendung im Token empfangen werden

Methoden

Methode Rückgabetyp Beschreibung
Auflisten von Benutzerabläufen b2cIdentityUserFlow-Sammlung Abrufen aller B2C-Benutzerabläufe.
Abrufen von Benutzerabläufen b2cIdentityUserFlow Abrufen von Eigenschaften eines B2C-Benutzerablaufs.
Erstellen eines Benutzerablaufs b2cIdentityUserFlow Erstellen eines neuen B2C-Benutzerablaufs.
Benutzerablauf aktualisieren b2cIdentityUserFlow Eigenschaften eines B2C-Benutzerablaufs aktualisieren.
Löschen von Benutzerabläufen Keine Löschen eines B2C-Benutzerablaufs.
Auflisten von Identitätsanbietern identityProvider-Sammlung Abrufen aller Identitätsanbieter in einem B2C-Benutzerablauf.
Hinzufügen von Identitätsanbietern Keine Hinzufügen eines Identitätsanbieters zu einem B2C-Benutzerablauf.
Löschen von Identitätsanbietern Keine Entfernen eines Identitätsanbieters aus einem B2C-Benutzerablauf
Lise der Benutzerattribut-Aufgaben identityUserFlowAttributeAssignment-Sammlung Abrufen aller Benutzerattribut-Aufgaben in einem B2C-Benutzerablauf.
Erstellen von Benutzerattribut-Aufgaben identityUserFlowAttributeAssignment Erstellen einer Benutzerattribut-Aufgabe in einem B2C-Benutzerablauf.
Sprachen auflisten userFlowLanguageConfiguration-Sammlung Abrufen aller Sprachen innerhalb eines B2C-Benutzerflusses.
Sprache erstellen userFlowLanguageConfiguration Erzeugt eine benutzerdefinierte Sprache in einem B2C-Benutzerfluss.
Abrufen der Konfiguration der API-Connectors für einen Benutzerablauf userFlowApiConnectorConfiguration Rufen Sie die Konfiguration für API-Connectors in einem Benutzerablauf ab. Der $expand-Abfrageparameter wird für diese Methode nicht unterstützt.
Konfigurieren eines API-Connectors in einem Benutzerablauf Keine Konfigurieren Sie einen API-Connector für bestimmte Schritte in einem Benutzerablauf, indem Sie die Eigenschaft apiConnectorConfiguration aktualisieren.
Auflisten von Identitätsanbietern (veraltet) identityProvider-Sammlung Abrufen aller Identitätsanbieter in einem B2C-Benutzerablauf.
Hinzufügen von Identitätsanbietern (veraltet) Keine Hinzufügen eines Identitätsanbieters zu einem B2C-Benutzerablauf.
Löschen von Identitätsanbietern (veraltet) Keine Entfernen eines Identitätsanbieters aus einem B2C-Benutzerablauf

Eigenschaften

Eigenschaft Typ Beschreibung
id String Der Name des Benutzerablaufs. Dies ist ein erforderlicher Wert, der nach dessen Erstellung unveränderlich ist. Dem Namen wird nach der Erstellung der Wert B2C_1_ vorangestellt.
userFlowType userFlowType Der Typ des Benutzerablaufs. Die unterstützten Werte für userFlowType lauten: signUp, signIn, signUpOrSignIn, passwordReset, profileUpdate, resourceOwner.
userFlowTypeVersion Single Die Version des Benutzerablaufs.
isLanguageCustomizationEnabled Boolesch Die Eigenschaft, die bestimmt, ob die Sprachanpassung innerhalb des B2C-Benutzerablaufs aktiviert ist. Die Sprachanpassung ist für B2C-Benutzerabläufe nicht standardmäßig aktiviert.
defaultLanguageTag String Gibt die Standardsprache des b2cIdentityUserFlow an, die verwendet wird, wenn kein ui_locale-Tag in der Anforderung angegeben ist. Dieses Feld ist RFC 5646-kompatibel.
apiConnectorConfiguration userFlowApiConnectorConfiguration Konfiguration zur Aktivierung eines API-Connectors zur Verwendung als Teil des Benutzerflusses. Sie können den Wert dieses Objektes nur mit Get userFlowApiConnectorConfiguration erhalten.

Beziehungen

Beziehung Typ Beschreibung
userFlowIdentityProviders identityProviderBase-Sammlung Die im Benutzerablauf enthaltenen Identitätsanbieter.
identityProviders (veraltet) identityProvider-Sammlung Die im Benutzerablauf enthaltenen Identitätsanbieter.
userAttributeAssignments identityUserFlowAttributeAssignment-Sammlung Die Benutzerattribut-Aufgaben, die im Benutzerablauf beinhaltet sind.
Sprachen userFlowLanguageConfiguration-Sammlung Die für die Anpassung unterstützten Sprachen innerhalb des Benutzerablaufs. Die Sprachanpassung ist in B2C-Benutzerabläufen nicht standardmäßig aktiviert.

JSON-Darstellung

Es folgt eine JSON-Darstellung der Ressource.

{
    "id": "String (identifier)",
    "userFlowType": "String",
    "userFlowTypeVersion": "Single",
    "isLanguageCustomizationEnabled": "Boolean",
    "defaultLanguageTag": "String",
    "userFlowIdentityProviders": [{"@odata.type": "microsoft.graph.identityProviderBase"}],
    "identityProviders": [{"@odata.type": "microsoft.graph.identityProvider"}],
    "userAttributeAssignments": [{"@odate.type": "microsoft.graph.identityUserFlowAttributeAssignment"}],
    "languages": [{"@odata.type": "microsoft.graph.userFlowLanguageConfiguration"}],
    "apiConnectorConfiguration": {
      "@odata.type": "microsoft.graph.userFlowApiConnectorConfiguration"
    }
}