Type de ressource b2xIdentityUserFlow

Article
04/09/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 d’inscription en libre-service au sein d’un locataire Microsoft Entra.

Les flux d’utilisateurs sont utilisés pour activer une expérience d’inscription en libre-service aux utilisateurs invités sur une application. Les flux utilisateur définissent l’expérience que l’utilisateur final voit lors de l’inscription. Cette expérience inclut les fournisseurs d’identité qu’ils peuvent utiliser pour s’authentifier et les attributs qui sont collectés dans le cadre du processus d’inscription.

Méthodes

Méthode	Type renvoyé	Description
Répertorier les flux d’utilisateurs	Collection b2xIdentityUserFlow	Récupérez tous les flux d’utilisateur B2X.
Obtenir un flux d’utilisateur	b2xIdentityUserFlow	Récupérez les propriétés d’un flux d’utilisateur B2X.
Créer un flux d’utilisateur	b2xIdentityUserFlow	Créez un nouveau flux d’utilisateur B2X.
Supprimer un flux d’utilisateur	Aucune	Supprimez un flux d’utilisateur B2X.
Répertorier les fournisseurs d’identité	collection identityProvider	Récupérez tous les fournisseurs d’identité dans un flux utilisateur B2X.
Ajouter un fournisseur d’identité	Aucune	Ajoutez un fournisseur d’identité B2X à un flux d’utilisateur.
Supprimer un fournisseur d’identité	Aucune	Supprimez un fournisseur d’identité d’un flux d’utilisateur B2X.
Répertorier les fournisseurs d’identité (déconseillé)	collection identityProvider	Récupérez tous les fournisseurs d’identité dans un flux utilisateur B2X.
Ajouter un fournisseur d’identité (déconseillé)	Aucune	Ajoutez un fournisseur d’identité B2X à un flux d’utilisateur.
Supprimer un fournisseur d’identité (déconseillé)	Aucune	Supprimez un fournisseur d’identité d’un flux d’utilisateur B2X.
Répertorier les affectations d’attribut utilisateur	Collection identityUserFlowAttributeAssignment	Récupérer les affectations d’attribut utilisateur dans un flux d’utilisateur B2X.
Créer une affectation d’attribut utilisateur	identityUserFlowAttributeAssignment	Créez une affectation d’attribut utilisateur dans un flux d’utilisateur B2X.
Répertorier les langues	Collection userFlowLanguageConfiguration	Récupérez toutes les langues au sein d’un flux d’utilisateur B2X.
Obtenir la configuration des connecteurs API pour le flux d’utilisateur	userFlowApiConnectorConfiguration	Obtenez la configuration des connecteurs API utilisés dans le flux d’utilisateur. Le paramètre de requête $expand n’est pas pris en charge pour cette méthode.
Configurer un connecteur API dans un flux d’utilisateur	Aucune	Configurez un connecteur API pour les étapes spécifiques d’un flux d’utilisateur en mettant à jour la propriété apiConnectorConfiguration .

Propriétés

Propriété	Type	Description
id	String	Le nom du flux d’utilisateur. Il s’agit d’une valeur requise qui est immuable après sa création. Le nom est précédé de la valeur de `B2X_1_` après sa création.
userFlowType	userFlowType	Le type de flux d’utilisateur. Pour les flux d’utilisateurs d’inscription en libre-service, la valeur peut uniquement être `signUpOrSignIn` et ne peut pas être modifiée après la création.
userFlowTypeVersion	Unique	La version du flux d’utilisateur. Pour les flux utilisateur d’inscription en libre-service, la version est toujours `1`.
apiConnectorConfiguration	userFlowApiConnectorConfiguration	Configuration permettant d’activer un connecteur API à utiliser dans le cadre du flux d’utilisateur d’inscription en libre-service. Vous pouvez uniquement obtenir la valeur de cet objet à l’aide de Obtenir userFlowApiConnectorConfiguration.

Relations

Relation	Type	Description
userflowIdentityProviders	Collection IdentityProviderBase	Les fournisseurs d’identité inclus dans le flux d’utilisateur.
identityProviders (déconseillé)	collection identityProvider	Les fournisseurs d’identité inclus dans le flux d’utilisateur.
userAttributeAssignments	Collection identityUserFlowAttributeAssignment	Les affectations d’attribut utilisateur sont incluses dans le flux d’utilisateur.
langues	Collection userFlowLanguageConfiguration	Langues prises en charge pour la personnalisation au sein du flux d’utilisateur. La personnalisation linguistique est activée par défaut dans le flux d’utilisateur d’inscription en libre-service. Vous ne pouvez pas créer de langues personnalisées dans les flux d’utilisateurs d’inscription en libre-service.

Représentation JSON

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

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

Partager via