Créer userAttributeAssignments

Espace de noms: microsoft.graph

Créez un objet identityUserFlowAttributeAssignment dans b2xIdentityUserFlow.

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

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ✅ ✅ ✅

Autorisations

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

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
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

Pour l’accès délégué à l’aide de comptes professionnels ou scolaires, l’utilisateur connecté doit disposer d’un rôle Microsoft Entra pris en charge ou d’un rôle personnalisé qui accorde les autorisations requises pour cette opération. 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/{id}/userAttributeAssignments

En-têtes de demande

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

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet identityUserFlowAttributeAssignment .

Le tableau suivant répertorie les propriétés qui sont requises lorsque vous créez identityUserFlowAttributeAssignment.

Propriété Type Description
displayName String Nom d’affichage de identityUserFlowAttribute dans un flux d’utilisateur.
isOptional Booléen Détermine si identityUserFlowAttribute est facultatif. true signifie que l’utilisateur n’a pas à fournir de valeur. false signifie que l’utilisateur ne peut pas terminer l’inscription sans fournir une valeur.
requiresVerification Booléen Détermine si identityUserFlowAttribute nécessite une vérification. Ceci est uniquement utilisé pour vérifier le numéro de téléphone ou l’adresse e-mail de l’utilisateur.
userAttributeValues collection userAttributeValuesItem Les options d’entrée pour l’attribut de flux utilisateur. S’applique uniquement lorsque userInputType est radioSingleSelect, dropdownSingleSelectou checkboxMultiSelect.
userInputType identityUserFlowAttributeInputType Type d’entrée de l’attribut de flux utilisateur. Les valeurs possibles sont textBox, dateTimeDropdown, radioSingleSelect, dropdownSingleSelect, emailBox, checkboxMultiSelect.
userAttribute identityUserFlowAttribute Identificateur de l’attribut de flux d’utilisateur à inclure dans l’affectation de flux d’utilisateur.

Réponse

En cas de réussite, cette méthode renvoie un code de réponse et un 201 Created objet identityUserFlowAttributeAssignment dans le corps de la réponse.

Exemples

Demande

POST https://graph.microsoft.com/beta/identity/b2xUserFlows/B2X_1_Partner/userAttributeAssignments
Content-Type: application/json

{
    "isOptional": false,
    "requiresVerification": false,
    "userInputType": "TextBox",
    "displayName": "Shoe size",
    "userAttributeValues": [],
    "userAttribute": {
        "id": "extension_guid_shoeSize"
    }
}

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/userAttributeAssignments/extension_guid_shoeSize
Content-Type: application/json

{
    "id": "extension_guid_shoeSize",
    "isOptional": false,
    "requiresVerification": false,
    "userInputType": "TextBox",
    "displayName": "Shoe size",
    "userAttributeValues": []
}