externalUsersSelfServiceSignUpEventsFlow-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-Benutzerflow für externe Identitäten innerhalb einer externen Microsoft Entra-ID in Mitarbeitern oder externen Mandanten dar. Ein Benutzerflow wird als Richtlinie für mehrere Ereignisse implementiert, die die spezifischen Ereignisse an bestimmten Punkten der Benutzerinteraktion ausführt.
Erbt von authenticationEventsFlow.
Methoden
Keine.
Eine Liste der API-Vorgänge zum Verwalten dieses Ressourcentyps finden Sie unter dem Ressourcentyp authenticationEventsFlow.
Eigenschaften
Eigenschaft | Typ | Beschreibung |
---|---|---|
id | Zeichenfolge | Der eindeutige Bezeichner für die Entität. Schreibgeschützt. Geerbt von entity. |
displayName | Zeichenfolge | Erforderlich. Der Anzeigename für die Ereignisrichtlinie. Muss eindeutig sein. Geerbt von authenticationEventsFlow. |
description | Zeichenfolge | Optional. Die Beschreibung der Ereignisrichtlinie. Geerbt von authenticationEventsFlow. |
Bedingungen | authenticationConditions | Optional. Die Bedingungen, die den Kontext der Authentifizierungsanforderung darstellen, mit der entschieden wird, ob die Ereignisrichtlinie aufgerufen wird. Geerbt von authenticationEventsFlow. |
Priorität | Int32 | Optional. Die Priorität, die für jedes einzelne Ereignis der Ereignisrichtlinie verwendet werden soll. Wenn mehrere konkurrierende Listener für ein Ereignis dieselbe Priorität haben, wird ein Listener ausgewählt, und ein Fehler wird automatisch protokolliert. Der Standardwert ist 500. Geerbt von authenticationEventsFlow. |
onInteractiveAuthFlowStart | onInteractiveAuthFlowStartHandler | Erforderlich. Die Konfiguration für das, was aufgerufen werden soll, wenn ein Authentifizierungsflow initiiert werden kann. |
onAttributeCollection | onAttributeCollectionHandler | Die Konfiguration für das, was aufgerufen werden soll, wenn Attribute bereit sind, vom Benutzer gesammelt zu werden. |
onAttributeCollectionStart | onAttributeCollectionStartHandler | Die Konfiguration dessen, was aufgerufen werden soll, wenn die Zuordnungssammlung gestartet wurde. |
onAttributeCollectionSubmit | onAttributeCollectionSubmitHandler | Die Konfiguration für das, was aufgerufen werden soll, wenn Attribute am Ende der Zuordnungssammlung übermittelt wurden. |
onAuthenticationMethodLoadStart | onAuthenticationMethodLoadStartHandler | Erforderlich. Die Konfiguration für das, was aufgerufen werden soll, wenn Authentifizierungsmethoden bereit sind, dem Benutzer angezeigt zu werden. Es muss mindestens ein Identitätsanbieter verknüpft sein. Unterstützt $filter (eq ). Syntaxinformationen finden Sie unter Unterstützung für das Filtern nach Benutzerflows . |
onUserCreateStart | onUserCreateStartHandler | Die Konfiguration für das, was während der Benutzererstellung aufgerufen werden soll. |
Unterstützung für das Filtern nach Benutzerflows
- Filtern nach identityProviders:
?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/any(idp:idp/id eq '{identityProvider-id}')
- Filtern nach Attributen:
?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/any(attribute:attribute/id eq '{attribute-ID}')
- Filtern nach verknüpften Anwendungen:
?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/any(appId:appId/appId eq '{appId}')
Beziehungen
Keine.
JSON-Darstellung
Die folgende JSON-Darstellung zeigt den Ressourcentyp.
{
"@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",
"id": "String (identifier)",
"displayName": "String",
"description": "String",
"conditions": {
"@odata.type": "microsoft.graph.authenticationConditions"
},
"priority": "Integer",
"onInteractiveAuthFlowStart": {
"@odata.type": "microsoft.graph.onInteractiveAuthFlowStartHandler"
},
"onAuthenticationMethodLoadStart": {
"@odata.type": "microsoft.graph.onAuthenticationMethodLoadStartHandler"
},
"onAttributeCollection": {
"@odata.type": "microsoft.graph.onAttributeCollectionHandler"
},
"onAttributeCollectionStart": {
"@odata.type": "microsoft.graph.onAttributeCollectionStartHandler"
},
"onAttributeCollectionSubmit": {
"@odata.type": "microsoft.graph.onAttributeCollectionSubmitHandler"
},
"onUserCreateStart": {
"@odata.type": "microsoft.graph.onUserCreateStartHandler"
}
}