Crear phoneMethod
Espacio de nombres: microsoft.graph
Agregue un nuevo método de autenticación de teléfono para un usuario. Un usuario solo puede tener un teléfono de cada tipo, capturado en la propiedad phoneType . Esto significa, por ejemplo, que se produce 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 agregar un alternateMobile
teléfono.
Agregar un número de teléfono hace que esté disponible para su uso en azure multifactor authentication (MFA) y autoservicio de restablecimiento de contraseña (SSPR), si está habilitado.
Además, si una directiva habilita a un usuario para usar el inicio de sesión por 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 nacionales de nube.
Servicio global | Gobierno de EE. UU. L4 | Us Government L5 (DOD) | China operada por 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
Permissions
Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores 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) | UserAuthenticationMethod.ReadWrite.All | No disponible. |
Delegado (cuenta personal de Microsoft) | No admitida. | No admitida. |
Aplicación | UserAuthenticationMethod.ReadWrite.All | No disponible. |
Importante
En escenarios delegados con cuentas profesionales o educativas, al usuario que ha iniciado sesión se le debe asignar un rol de Microsoft Entra compatible o un rol personalizado con un permiso de rol admitido. Se admiten los siguientes roles con privilegios mínimos para esta operación.
- Administrador de autenticación
- Administrador de autenticación con privilegios
Los usuarios no pueden agregar un método de autenticación de teléfono a su propia cuenta.
Solicitud HTTP
Agregue un método de autenticación de teléfono a la cuenta de otro usuario.
POST /users/{id | userPrincipalName}/authentication/phoneMethods
Encabezados de solicitud
Nombre | Descripción |
---|---|
Authorization | {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la 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 | Número de teléfono al que se va a enviar un mensaje de texto o a la llamada para la autenticación. Los números de teléfono usan el formato +{country code} {number}x{extension} , con la 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 necesario. |
phoneType | Cadena | Los valores posibles son: mobile , alternateMobile y office . |
Respuesta
Si se ejecuta 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
Este es un ejemplo de la solicitud.
POST https://graph.microsoft.com/v1.0/users/kim@contoso.com/authentication/phoneMethods
Content-type: application/json
{
"phoneNumber": "+1 2065555555",
"phoneType": "mobile"
}
Respuesta
Este es un ejemplo de 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"
}