Partager via


Ajouter un attribut (au flux utilisateur)

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 .

Ajoutez un attribut à un flux d’utilisateur d’inscription en libre-service d’identités externes qui est représenté par un objet externalUsersSelfServiceSignupEventsFlow . Vous pouvez ajouter des attributs personnalisés et intégrés à un flux utilisateur.

L’attribut est ajouté aux collections d’affichageattributsattributeCollection> et attributeCollectionPage>> sur le flux utilisateur. Dans la collection views , les paramètres par défaut sont attribués à l’attribut. Vous pouvez CORRIGER le flux utilisateur pour personnaliser les paramètres de l’attribut sur l’objet views , par exemple, le marquer comme requis ou mettre à jour les types d’entrée autorisés.

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) EventListener.ReadWrite.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application EventListener.ReadWrite.All Non disponible.

Importante

Dans les scénarios délégués avec des comptes professionnels ou scolaires, l’utilisateur connecté doit être propriétaire ou membre du groupe ou 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/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$ref

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 propriété odata.id avec l’ID de l’objet identityUserFlowAttribute à ajouter au flux utilisateur.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 204 No Content. Si elle échoue, une erreur 4xx est renvoyée avec des détails spécifiques.

Exemples

Demande

L’exemple suivant montre une requête qui ajoute city en tant qu’attribut pour l’étape de collecte d’attributs d’un flux d’utilisateur d’inscription en libre-service d’identités externes. Si la requête réussit, l’attribut est ajouté auxattributsattributeCollection> et attributeCollectionPage>>affiche les collections sur le flux utilisateur. Après avoir ajouté l’attribut au flux utilisateur, vous pouvez corriger le flux d’utilisateur pour personnaliser les paramètres de l’attribut sur l’objet views , c’est-à-dire personnaliser la mise en page.

POST https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$ref

{
    "@odata.id":"https://graph.microsoft.com/beta/identity/userFlowAttributes/city"
} 

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content