Créer phoneAuthenticationMethod

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 une nouvelle méthode d’authentification par téléphone. Un utilisateur ne peut avoir qu’un seul téléphone de chaque type, capturé dans la propriété phoneType . Cela signifie, par exemple, que l’ajout d’un mobile téléphone à un utilisateur possédant un téléphone préexistant mobile échouera. En outre, un utilisateur doit toujours avoir un mobile téléphone avant d’ajouter un alternateMobile téléphone.

L’ajout d’un numéro de téléphone le rend utilisable à la fois dans Azure l’authentification multifacteur (MFA) et la réinitialisation de mot de passe en libre-service (SSPR), si elle est activée.

En outre, si un utilisateur est activé par une stratégie pour utiliser la connexion par SMS et qu’un mobile numéro est ajouté, le système tente d’enregistrer le numéro pour l’utiliser dans ce système.

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

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. Cette opération prend en charge les rôles intégrés suivants, qui n’offrent que le moindre privilège nécessaire :

  • Administrateur d’authentification
  • Administrateur d’authentification privilégié

Lorsque les utilisateurs gèrent leurs propres méthodes d’authentification, le système les invite à effectuer l’authentification multifacteur (MFA) s’ils se sont authentifiés pour la dernière fois il y a plus de 10 minutes dans la session active.

Requête HTTP

Ajoutez une méthode d’authentification par téléphone au compte d’un autre utilisateur. Les utilisateurs ne peuvent pas ajouter une méthode d’authentification par téléphone à leur propre compte.

POST /users/{id | userPrincipalName}/authentication/phoneMethods

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 d’un objet phoneAuthenticationMethod . Le JSON doit inclure phoneNumber et phoneType, mais pas smsSignInState (qui est en lecture seule).

Propriété Type Description
phoneNumber String Le numéro de téléphone pour envoyer un SMS ou appeler pour l’authentification. Les numéros de téléphone utilisent le format « +<numéro>de code><du pays x<extension> », avec extension facultative. Par exemple, +1 5555551234 ou +1 5555551234x123 sont valides. Les nombres sont rejetés lors de la création/mise à jour s’ils ne correspondent pas au format requis.
phoneType String Les valeurs possibles sont : mobile, alternateMobile etoffice.

Réponse

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

Exemples

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/users/kim@contoso.com/authentication/phoneMethods
Content-type: application/json

{
  "phoneNumber": "+1 2065555555",
  "phoneType": "mobile"
}

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
Content-type: application/json

{
  "phoneNumber": "+1 2065555555",
  "phoneType": "phoneType-value",
  "smsSignInState": "ready",
  "id": "3179e48a-750b-4051-897c-87b9720928f7"
}