Type de ressource externalUsersSelfServiceSignUpEventsFlow

Article
08/07/2024

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Représente un flux d’utilisateur libre-service pour les identités externes au sein d’un ID externe Microsoft Entra dans le personnel ou les locataires externes. Un flux utilisateur est implémenté en tant que stratégie multi-événements exécutant les événements spécifiques à des points spécifiques d’interaction utilisateur.

Hérite d’authenticationEventsFlow.

Méthodes

Aucun.

Pour obtenir la liste des opérations d’API pour la gestion de ce type de ressource, consultez le type de ressource authenticationEventsFlow.

Propriétés

Propriété	Type	Description
id	Chaîne	Identificateur unique de l’entité. En lecture seule. Hérité de l’entité.
displayName	Chaîne	Obligatoire. Nom d’affichage de la stratégie d’événements. Doit être unique. Hérité de authenticationEventsFlow.
description	String	Facultatif. Description de la stratégie d’événements. Hérité de authenticationEventsFlow.
conditions	authenticationConditions	Optional. Conditions représentant le contexte de la demande d’authentification utilisée pour déterminer si la stratégie d’événements est appelée. Hérité de authenticationEventsFlow.
priorité	Int32	Optional. Priorité à utiliser pour chaque événement individuel de la stratégie d’événements. Si plusieurs écouteurs concurrents pour un événement ont la même priorité, un est choisi et une erreur est consignée en mode silencieux. La valeur par défaut est 500. Hérité de authenticationEventsFlow.
onInteractiveAuthFlowStart	onInteractiveAuthFlowStartHandler	Obligatoire. Configuration de ce qu’il faut appeler lorsqu’un flux d’authentification est prêt à être lancé.
onAttributeCollection	onAttributeCollectionHandler	Configuration de ce qu’il faut appeler lorsque les attributs sont prêts à être collectés auprès de l’utilisateur.
onAttributeCollectionStart	onAttributeCollectionStartHandler	Configuration de ce qu’il faut appeler lorsque la collecte d’attribution a démarré.
onAttributeCollectionSubmit	onAttributeCollectionSubmitHandler	Configuration de ce qu’il faut appeler lorsque des attributs ont été envoyés à la fin de la collecte d’attribution.
onAuthenticationMethodLoadStart	onAuthenticationMethodLoadStartHandler	Obligatoire. Configuration de ce qu’il faut appeler lorsque les méthodes d’authentification sont prêtes à être présentées à l’utilisateur. Doit avoir au moins un fournisseur d’identité lié. Prend en charge `$filter` (`eq`). Pour plus d’informations sur la syntaxe, consultez prise en charge du filtrage sur les flux utilisateur .
onUserCreateStart	onUserCreateStartHandler	Configuration de ce qu’il faut appeler lors de la création de l’utilisateur.

Prise en charge du filtrage sur les flux d’utilisateurs

Filtrer sur identityProviders : ?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/any(idp:idp/id eq '{identityProvider-id}')
Filtrer sur les attributs : ?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/any(attribute:attribute/id eq '{attribute-ID}')
Filtrer sur les applications liées : ?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/any(appId:appId/appId eq '{appId}')

Relations

Aucun.

Représentation JSON

La représentation JSON suivante montre le type de ressource.

{
  "@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"
  }
}

Partager via