Partager via


Créer des userAttributeAssignments

Espace de noms: microsoft.graph

Créez un objet identityUserFlowAttributeAssignment dans un 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/{id}/userAttributeAssignments

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 de l’objet identityUserFlowAttributeAssignment .

Le tableau suivant répertorie les propriétés requises lorsque vous créez l’élément identityUserFlowAttributeAssignment.

Propriété Type Description
displayName String Nom d’affichage de l’attribut identityUserFlowAttribute dans un flux d’utilisateur.
isOptional Boolean Détermine si l’attribut identityUserFlowAttribute est facultatif. true signifie que l’utilisateur n’a pas besoin de fournir une valeur. false signifie que l’utilisateur ne peut pas terminer l’inscription sans fournir de valeur.
requiresVerification Boolean Détermine si l’attribut identityUserFlowAttribute nécessite une vérification. Il est utilisé uniquement pour vérifier le numéro de téléphone ou l’adresse e-mail de l’utilisateur.
userAttributeValues collection userAttributeValuesItem Options d’entrée pour l’attribut de flux utilisateur. Applicable 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 utilisateur à inclure dans l’affectation de flux utilisateur.

Réponse

Si elle réussit, cette méthode renvoie un 201 Created code de réponse et un objet identityUserFlowAttributeAssignment dans le corps de la réponse.

Exemples

Demande

POST https://graph.microsoft.com/v1.0/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/v1.0/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": []
}