b2xIdentityUserFlow-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 Self-Service-Registrierungsbenutzerflow innerhalb eines Microsoft Entra Mandanten dar.

Benutzerabläufe werden verwendet, um einen Self-Service-Registrierungsvorgang für Gastbenutzer in einer Anwendung zu aktivieren. Benutzerabläufe definieren die Benutzererfahrung des Endbenutzers während der Registrierung, einschließlich der Anzeige der Identitätsanbieter, die er zur Authentifizierung verwenden kann, zusammen mit den Attributen, die beim Registrierungsvorgang erfasst werden.

Methoden

Methode	Rückgabetyp	Beschreibung
Auflisten von Benutzerabläufen	b2xIdentityUserFlow-Sammlung	Abrufen aller B2X-Benutzerabläufe.
Abrufen von Benutzerabläufen	b2xIdentityUserFlow	Abrufen von Eigenschaften eines B2X-Benutzerablaufs.
Erstellen eines Benutzerablaufs	b2xIdentityUserFlow	Erstellen eines neuen B2X-Benutzerablaufs.
Löschen von Benutzerabläufen	Keine	Löschen eines B2X-Benutzerablaufs.
Auflisten von Identitätsanbietern	identityProvider-Sammlung	Abrufen aller Identitätsanbieter in einem B2X-Benutzerablauf.
Hinzufügen von Identitätsanbietern	Keine	Hinzufügen eines Identitätsanbieters zu einem B2X-Benutzerablauf.
Entfernen von Identitätsanbietern	Keine	Entfernen eines Identitätsanbieters aus einem B2X-Benutzerablauf.
Auflisten von Identitätsanbietern (veraltet)	identityProvider-Sammlung	Abrufen aller Identitätsanbieter in einem B2X-Benutzerablauf.
Hinzufügen von Identitätsanbietern (veraltet)	Keine	Hinzufügen eines Identitätsanbieters zu einem B2X-Benutzerablauf.
Entfernen von Identitätsanbietern (veraltet)	Keine	Entfernen eines Identitätsanbieters aus einem B2X-Benutzerablauf.
Lise der Benutzerattribut-Aufgaben	identityUserFlowAttributeAssignment-Sammlung	Abrufen aller Benutzerattribut-Aufgaben in einem B2X-Benutzerablauf.
Erstellen von Benutzerattribut-Aufgaben	identityUserFlowAttributeAssignment	Erstellen einer Benutzerattribut-Aufgabe in einem B2X-Benutzerablauf.
Sprachen auflisten	userFlowLanguageConfiguration-Sammlung	Abrufen aller Sprachen innerhalb eines B2X-Benutzerablaufs.
Abrufen der Konfiguration der API-Connectors für einen Benutzerablauf	userFlowApiConnectorConfiguration	Rufen Sie die Konfiguration für API-Connectors in einem Benutzerablauf ab. Der abfrageparameter $expand 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.

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 B2X_1_ vorangestellt.
userFlowType	userFlowType	Der Typ des Benutzerablaufs. Bei Self-Service-Registrierungsbenutzerflows kann der Wert nur sein signUpOrSignIn und nach der Erstellung nicht geändert werden.
userFlowTypeVersion	Single	Die Version des Benutzerablaufs. Für Selbstbedienungs-Benutzerabläufe für die Registrierung ist die Version immer 1.
apiConnectorConfiguration	userFlowApiConnectorConfiguration	Konfiguration zur Aktivierung eines API-Connectors zur Verwendung als Teil des Selbstbedienungs-Benutzerablaufs für die Registrierung. 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 einem Selbstbedienungs-Benutzerablauf für die Registrierung standardmäßig aktiviert. Sie können keine benutzerdefinierten Sprachen in Benutzerflows für die Self-Service-Registrierung erstellen.

JSON-Darstellung

Die folgende JSON-Darstellung zeigt den Ressourcentyp.

{
    "id": "String (identifier)",
    "userFlowType": "String",
    "userFlowTypeVersion": "Single",
    "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"
    }
}