phoneAuthenticationMethod: enableSmsSignIn

Пространство имен: microsoft.graph

Включите вход в SMS для существующего mobile номера телефона, зарегистрированного для пользователя. Для успешного включения:

• Телефон должен иметь ."phoneType": "mobile"
• Телефон должен быть уникальным в системе входа в SMS (никто другой также не может использовать этот номер).
• Пользователь должен быть включен для входа в SMS в политике методов проверки подлинности .

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	✅	✅	❌

Разрешения

Для вызова этого API требуется одно из следующих разрешений. Дополнительные сведения, включая сведения о том, как выбрать разрешения, см. в статье Разрешения.

Разрешения, действующие на себя

Тип разрешения	Разрешения (в порядке повышения привилегий)
Делегированные (рабочая или учебная учетная запись)	UserAuthenticationMethod.ReadWrite
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.
Для приложений	Не поддерживается.

Разрешения, действующие для других пользователей

Тип разрешения	Разрешения (в порядке повышения привилегий)
Делегированные (рабочая или учебная учетная запись)	UserAuthenticationMethod.ReadWrite.All
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.
Приложение	UserAuthenticationMethod.ReadWrite.All

В делегированных сценариях, когда администратор действует с другим пользователем, администратору требуется по крайней мере роль администратора проверки подлинности или администратора привилегированной проверки подлинностиMicrosoft Entra.

HTTP-запрос

Включите вход в SMS для собственного метода проверки подлинности на мобильном телефоне.

POST /me/authentication/phoneMethods/{mobilePhoneMethodId}/enableSmsSignIn

Включите вход в SMS для собственного или другого метода проверки подлинности на мобильном телефоне пользователя.

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

Значение mobilePhoneMethodId для mobile phoneType равно 3179e48a-750b-4051-897c-87b9720928f7.

Заголовки запросов

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.

Текст запроса

Не указывайте текст запроса для этого метода.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 204 No Content. Он не возвращает ничего в теле ответа.

Примеры

В приведенном ниже примере показано, как вызывать этот API.

Запрос

Ниже показан пример запроса.

HTTP

POST https://graph.microsoft.com/v1.0/me/authentication/phoneMethods/3179e48a-750b-4051-897c-87b9720928f7/enableSmsSignIn

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Me.Authentication.PhoneMethods["{phoneAuthenticationMethod-id}"].EnableSmsSignIn.PostAsync();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users authentication phone-methods enable-sms-sign-in post --user-id {user-id} --phone-authentication-method-id {phoneAuthenticationMethod-id}

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



graphClient.Me().Authentication().PhoneMethods().ByPhoneAuthenticationMethodId("phoneAuthenticationMethod-id").EnableSmsSignIn().Post(context.Background(), nil)

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.me().authentication().phoneMethods().byPhoneAuthenticationMethodId("{phoneAuthenticationMethod-id}").enableSmsSignIn().post();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/me/authentication/phoneMethods/3179e48a-750b-4051-897c-87b9720928f7/enableSmsSignIn')
	.post();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->me()->authentication()->phoneMethods()->byPhoneAuthenticationMethodId('phoneAuthenticationMethod-id')->enableSmsSignIn()->post()->wait();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PowerShell

Import-Module Microsoft.Graph.Users.Actions

# A UPN can also be used as -UserId.
Enable-MgUserAuthenticationPhoneMethodSmsSignIn -UserId $userId -PhoneAuthenticationMethodId $phoneAuthenticationMethodId

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Python

from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


await graph_client.me.authentication.phone_methods.by_phone_authentication_method_id('phoneAuthenticationMethod-id').enable_sms_sign_in.post()

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже приводится пример отклика.

HTTP/1.1 204 No Content