Partager via

Créer b2xIdentityUserFlow

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 b2xIdentityUserFlow .

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.

Importante

Dans les scénarios délégués avec des comptes professionnels ou scolaires, l’utilisateur connecté doit se voir attribuer un rôle Microsoft Entra pris en charge ou un rôle personnalisé avec une autorisation de rôle prise en charge. ID externe’administrateur de flux utilisateur est le rôle le moins privilégié pris en charge pour cette opération.

Requête HTTP

POST /identity/b2xUserFlows

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 b2xIdentityUserFlow.

Propriété Type Description
id String Obligatoire. Le nom du flux d’utilisateur. Le nom sera ajouté B2X_1 avec après la création.
userFlowType String Obligatoire. Type de flux utilisateur que vous créez. Cette valeur sera toujours signUpOrSignIn.
userFlowTypeVersion Flottant Obligatoire. La version du flux d’utilisateur. Cette valeur sera toujours 1.
identityProviders collection identityProvider Optional. Les fournisseurs d’identité que vous souhaitez inclure dans le flux utilisateur.
apiConnectorConfiguration userFlowApiConnectorConfiguration Optional. Configuration permettant d’activer un connecteur API à utiliser dans le cadre du flux d’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 b2xIdentityUserFlow créé pour cette requête, avec le B2X_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

L’exemple suivant illustre une demande.

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

{
    "id": "Partner",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1
}

Réponse

L’exemple suivant illustre la 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/b2xUserFlows/B2X_1_Partner
Content-type: application/json

{
    "id": "B2X_1_Partner",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1
}

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

Demande

L’exemple suivant illustre une demande.

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

{
    "id": "Partner",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1,
    "identityProviders": [
        {
            "id": "Facebook-OAuth",
            "type": "Facebook",
            "name": "Facebook"
        }
    ]
}

Réponse

L’exemple suivant illustre la 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/b2xUserFlows/B2X_1_Partner
Content-type: application/json

{
    "id": "B2X_1_Partner",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1
}

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

Demande

L’exemple suivant illustre une demande.

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

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

Réponse

L’exemple suivant illustre la 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/b2xUserFlows/B2X_1_Partner
Content-type: application/json

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