Crear phoneAuthenticationMethod

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Agregue un nuevo método de autenticación telefónica. Un usuario solo puede tener un teléfono de cada tipo, capturado en la propiedad phoneType . Esto significa que, por ejemplo, se producirá un error al agregar un mobile teléfono a un usuario con un teléfono preexistente mobile . Además, un usuario siempre debe tener un mobile teléfono antes de agregarlo alternateMobile .

Al agregar un número de teléfono, estará disponible para su uso tanto en la autenticación multifactor (MFA) de Azure como en el autoservicio de restablecimiento de contraseña (SSPR), si está habilitado.

Además, si la directiva permite a un usuario usar el inicio de sesión mediante SMS y se agrega un mobile número, el sistema intenta registrar el número para usarlo en ese sistema.

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Servicio global Administración pública de EE. UU. Gobierno de EE. UU. L5 (DOD) China operado por 21Vianet
✅ ✅ ✅ ✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) UserAuthMethod-Phone.ReadWrite UserAuthMethod-Phone.ReadWrite.All, UserAuthenticationMethod.ReadWrite, UserAuthenticationMethod.ReadWrite.All
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación UserAuthenticationMethod.ReadWrite.All UserAuthMethod-Phone.ReadWrite.All

Importante

Para el acceso delegado con cuentas profesionales o educativas, el usuario que ha iniciado sesión debe tener asignado un rol compatible de Microsoft Entra o un rol personalizado que conceda los permisos necesarios para esta operación. Esta operación admite los siguientes roles integrados, que proporcionan solo el privilegio mínimo necesario:

  • Administrador de autenticación
  • Administrador de autenticación con privilegios

Cuando los usuarios administran sus propios métodos de autenticación, el sistema les pide que completen la autenticación multifactor (MFA) si se autenticaron por última vez hace más de 10 minutos en la sesión actual.

Solicitud HTTP

Agregar un método de autenticación telefónica a la cuenta de otro usuario. Los usuarios no pueden agregar un método de autenticación de teléfono a su propia cuenta.

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

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre autenticación y autorización.
Content-Type application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON de un objeto phoneAuthenticationMethod . El JSON debe incluir phoneNumber y phoneType, pero no smsSignInState (que es de solo lectura).

Propiedad Tipo Descripción
phoneNumber Cadena El número de teléfono al que se va a enviar un mensaje de texto o llamar para la autenticación. Los números de teléfono tienen el formato "+<número de código>><de país x<extensión>", con extensión opcional. Por ejemplo, +1 5555551234 o +1 5555551234x123 son válidos. Los números se rechazan al crear o actualizar si no coinciden con el formato requerido.
phoneType Cadena Los valores posibles son mobile, alternateMobile, y office.

Respuesta

Si se realiza correctamente, este método devuelve un 201 Created código de respuesta y un nuevo objeto phoneAuthenticationMethod en el cuerpo de la respuesta.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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

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

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

HTTP/1.1 201 Created
Content-type: application/json

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