Type de ressource b2cIdentityUserFlow

Article
03/26/2023

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 au sein d’un client d’Azure Active Directory B2C.

Pour vous aider à configurer les tâches d’identité les plus courantes pour vos applications, Azure Active Directory B2C inclut des politiques prédéfinies et configurables, appelées flux d’utilisateurs. Un flux d’utilisateur vous permet de déterminer la manière dont les utilisateurs interagissent avec votre application lorsqu’ils effectuent des tâches telles que la connexion, l’inscription, la modification d’un profil ou la réinitialisation d’un mot de passe. Vous pouvez créer plusieurs flux d’utilisateurs de types différents dans votre client et les utiliser dans vos applications selon vos besoins. Avec les flux d’utilisateurs, vous pouvez contrôler les fonctionnalités suivantes :

Types de comptes utilisés pour la connexion, tels que les comptes sociaux comme un compte Facebook ou un compte local
Attributs à collecter auprès du consommateur, tels que le prénom, le code postal et la pointure
Authentification multifacteur Azure
Personnalisation de l’interface utilisateur
Informations reçues par l’application dans le jeton

Méthodes

Méthode	Type renvoyé	Description
Répertorier les flux d’utilisateurs	Collection b2cIdentityUserFlow	Récupérez tous les flux d’utilisateur B2C.
Obtenir un flux d’utilisateur	b2cIdentityUserFlow	Récupérez les propriétés d’un flux d’utilisateur B2C.
Créer un flux d’utilisateur	b2cIdentityUserFlow	Créez un nouveau flux d’utilisateur B2C.
Mettre à jour un flux d’utilisateur	b2cIdentityUserFlow	Mettez à jour les propriétés d’un flux d’utilisateur B2C.
Supprimer un flux d’utilisateur	Aucune	Supprimez un flux d’utilisateur B2C.
Répertorier les fournisseurs d’identité	collection identityProvider	Récupérez tous les fournisseurs d’identité dans un flux utilisateur B2C.
Ajouter un fournisseur d’identité	Aucune	Ajoutez un fournisseur d’identité à un flux d’utilisateur B2C.
Supprimer un fournisseur d’identité	Néant	Supprimez un fournisseur d’identité d’un flux utilisateur B2C
Répertorier les affectations d’attribut utilisateur	Collection identityUserFlowAttributeAssignment	Récupérez les affectations d’attribut utilisateur dans un flux d’utilisateur B2C.
Créer une affectation d’attribut utilisateur	identityUserFlowAttributeAssignment	Créez une affectation d’attribut utilisateur dans un flux utilisateur B2C.
Répertorier les langues	Collection userFlowLanguageConfiguration	Récupérez toutes les langues au sein d’un flux d’utilisateur B2C.
Créer une langue	userFlowLanguageConfiguration	Crée une langue personnalisée dans un flux d’utilisateur B2C.
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 .
Répertorier les fournisseurs d’identité (déconseillé)	collection identityProvider	Récupérez tous les fournisseurs d’identité dans un flux utilisateur B2C.
Ajouter un fournisseur d’identité (déconseillé)	Aucune	Ajoutez un fournisseur d’identité à un flux d’utilisateur B2C.
Supprimer un fournisseur d’identité (déconseillé)	Aucun	Supprimez un fournisseur d’identité d’un flux utilisateur B2C

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 `B2C_1_` après sa création.
userFlowType	userFlowType	Le type de flux d’utilisateur. Les valeurs prises en charge pour userFlowType sont les suivantes : `signUp`, `signIn`, `signUpOrSignIn`, `passwordReset`, `profileUpdate`, `resourceOwner`.
userFlowTypeVersion	Unique	La version du flux d’utilisateur.
isLanguageCustomizationEnabled	Booléen	Propriété qui détermine si la personnalisation linguistique est activée dans le flux d’utilisateur B2C. La personnalisation linguistique n’est pas activée par défaut pour les flux d’utilisateur B2C.
defaultLanguageTag	Chaîne	Indique la langue par défaut de b2cIdentityUserFlow utilisée lorsqu’aucune balise `ui_locale` n’est spécifiée dans la demande. Ce champ n’est pas conforme à la norme RFC 5646.
apiConnectorConfiguration	userFlowApiConnectorConfiguration	Configuration permettant d’activer un connecteur API à utiliser dans le cadre du flux d’utilisateur. 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 n’est pas activée par défaut dans les flux d’utilisateur B2C.

Représentation JSON

Voici une représentation JSON de la 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"
    }
}