Share via


Créer b2cIdentityUserFlow

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 .

Créez un objet b2cIdentityUserFlow .

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) IdentityUserFlow.ReadWrite.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application IdentityUserFlow.ReadWrite.All Non disponible.

Le compte professionnel ou scolaire doit appartenir au moins au rôle Administrateur de flux d Microsoft Entra’utilisateur de l’ID externe.

Requête HTTP

POST /identity/b2cUserFlows

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON d’un b2cIdentityUserFlow.

Propriété Type Description
id Chaîne Obligatoire. Le nom du flux d’utilisateur. Le nom sera ajouté B2C_1_ avec après la création si le préfixe n’a pas été ajouté au nom pendant votre demande.
userFlowType String Obligatoire. Type de flux utilisateur que vous créez. Les valeurs prises en charge pour userFlowType sont les suivantes :
  • signUp
  • signIn
  • signUpOrSignIn
  • passwordReset
  • profileUpdate
  • resourceOwner
userFlowTypeVersion Flottant Obligatoire. La version du flux d’utilisateur.
isLanguageCustomizationEnabled Boolean Facultatif. Détermine si la personnalisation de la langue est activée dans le flux utilisateur Azure AD B2C. La personnalisation de la langue n’est pas activée par défaut pour les flux utilisateur Azure AD B2C.
defaultLanguageTag Chaîne Facultatif. Spécifie la langue par défaut du b2cIdentityUserFlow utilisé lorsqu’aucune balise n’est ui_locale spécifiée dans la requête. Ce champ n’est pas conforme à la norme RFC 5646.
identityProviders collection identityProvider Optional. Les fournisseurs d’identité que vous souhaitez inclure dans le flux utilisateur.

Réponse

Si elle réussit, cette méthode renvoie un 201 Created code de réponse et un en-tête Location avec un URI à l’objet b2cIdentityUserFlow créé pour cette requête, avec le B2C_1_ préfixe ajouté au nom. En cas d’échec, une 4xx erreur est retournée avec des détails spécifiques.

Exemples

Exemple 1 : Créer un flux d’utilisateur avec les valeurs par défaut

Demande

Voici un exemple de demande.

POST https://graph.microsoft.com/beta/identity/b2cUserFlows
Content-type: application/json

{
    "id": "Customer",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 3
}

Réponse

Voici un exemple de réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 201 Created
Location: https://graph.microsoft.com/beta/identity/b2cUserFlows('B2C_1_Customer')
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/b2cUserFlows/$entity",
    "id": "B2C_1_Customer",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 3,
    "isLanguageCustomizationEnabled": false,
    "defaultLanguageTag": "en",
    "authenticationMethods": "emailWithPassword",
    "tokenClaimsConfiguration": {
        "isIssuerEntityUserFlow": false
    },
    "apiConnectorConfiguration": {}
}

Exemple 2 : Créer un flux d’utilisateur avec les valeurs par défaut et un fournisseur d’identité

Demande

Voici un exemple de demande.

POST https://graph.microsoft.com/beta/identity/b2cUserFlows
Location: https://graph.microsoft.com/beta/identity/b2cUserFlows('B2C_1_Customer')
Content-type: application/json

{
    "id": "Customer",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 3,
    "identityProviders": [
        {
            "id": "Facebook-OAuth"
        }
    ]
}

Réponse

Voici un exemple de réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/b2cUserFlows/$entity",
    "id": "B2C_1_Customer",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 3,
    "isLanguageCustomizationEnabled": false,
    "defaultLanguageTag": "en",
    "authenticationMethods": "0",
    "tokenClaimsConfiguration": {
        "isIssuerEntityUserFlow": false
    },
    "apiConnectorConfiguration": {}
}

Exemple 3 : Créer un flux utilisateur avec les valeurs et la configuration par défaut pour les connecteurs d’API

Demande

Voici un exemple de demande.

POST https://graph.microsoft.com/beta/identity/b2cUserFlows
Content-type: application/json

{
    "id": "UserFlowWithAPIConnector",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1,
    "apiConnectorConfiguration":{
        "postFederationSignup":{
            "@odata.id": "{apiConnectorId}"
        },
        "postAttributeCollection":{
            "@odata.id": "{apiConnectorId}"
        }
    }
}

Réponse

Voici un exemple de réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

Note: La apiConnectorConfiguration propriété retourne toujours une valeur «{} ». Pour afficher la valeur complète avec les propriétés de navigation, utilisez cette API.

HTTP/1.1 201 Created
Location: https://graph.microsoft.com/beta/identity/b2cUserFlows/B2C_1_Partner
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/b2cUserFlows/$entity",
    "id": "B2C_1_UserFlowWithAPIConnector",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1,
    "apiConnectorConfiguration": {}
}