Update 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.

Actualizar el número de teléfono asociado a un método de autenticación telefónica.

No se puede cambiar el tipo de teléfono. Para cambiar el tipo de teléfono, agregue un nuevo número del tipo deseado y, a continuación, elimine el objeto con el tipo original.

Si la directiva permite a un usuario usar SMS para iniciar sesión y se cambia el mobile número, el sistema intenta registrar el número para usarlo en ese sistema.

No se admiten las operaciones de autoservicio.

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 UserAuthenticationMethod.ReadWrite.All, UserAuthMethod-Phone.ReadWrite.All, UserAuthenticationMethod.ReadWrite
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación UserAuthenticationMethod.ReadWrite.All UserAuthMethod-Phone.ReadWrite.All

Importante

Para el acceso delegado mediante cuentas profesionales o educativas en las que el usuario que ha iniciado sesión actúa sobre otro usuario, se le debe asignar 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

Actualizar el método de autenticación telefónica de otro usuario. Los usuarios no pueden actualizar su propio método de autenticación telefónica.

PATCH /users/{id | userPrincipalName}/authentication/phoneMethods/{phoneMethodId}

El valor de phoneMethodId correspondiente al phoneType a actualizar es uno de los siguientes:

  • b6332ec1-7057-4abe-9331-3d72feddfe41para actualizar phoneTypealternateMobile.
  • e37fc753-ff3b-4958-9484-eaa9425c82bcpara actualizar phoneTypeoffice.
  • 3179e48a-750b-4051-897c-87b9720928f7para actualizar phoneTypemobile.

Encabezados de solicitud

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

Cuerpo de solicitud

En el cuerpo de la solicitud, proporcione los valores de los campos relevantes que deben actualizarse. Las propiedades existentes que no se incluyen en el cuerpo de la solicitud se recalcularán en función de los cambios realizados en otros valores de propiedad.

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 string Los valores posibles son: mobile, alternateMobile, o office.

Respuesta

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

Ejemplos

Solicitud

En el ejemplo siguiente se muestra la solicitud.

PATCH https://graph.microsoft.com/beta/users/kim@contoso.com/authentication/phoneMethods/3179e48a-750b-4051-897c-87b9720928f7
Content-type: application/json

{
  "phoneNumber": "+1 2065555554",
  "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 200 OK
Content-type: application/json

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