Пространство имен: microsoft.graph
Обновите свойства объекта qrCodePinAuthenticationMethodConfiguration, который представляет политику метода проверки подлинности PIN-кода QR-кода для клиента Microsoft Entra.
Этот API доступен в следующих национальных облачных развертываниях.
| Глобальная служба |
Правительство США L4 |
Правительство США L5 (DOD) |
Китай управляется 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
| Тип разрешения |
Разрешения с наименьшими привилегиями |
Более высокие привилегированные разрешения |
| Делегированное (рабочая или учебная учетная запись) |
Policy.ReadWrite.AuthenticationMethod |
Недоступно. |
| Делегированные (личная учетная запись Майкрософт) |
Не поддерживается. |
Не поддерживается. |
| Для приложений |
Policy.ReadWrite.AuthenticationMethod |
Недоступно. |
Важно!
Для делегированного доступа с использованием рабочих или учебных учетных записей пользователю, выполнившего вход, необходимо назначить поддерживаемую роль Microsoft Entra или пользовательскую роль, которая предоставляет разрешения, необходимые для этой операции.
Администратор политики проверки подлинности — это наименее привилегированная роль, поддерживаемая для этой операции.
HTTP-запрос
PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/qrCodePin
Текст запроса
В тексте запроса укажите представление объекта qrCodePinAuthenticationMethodConfiguration в формате JSON со значениями свойств, которые необходимо обновить.
| Свойство |
Тип |
Описание |
| excludeTargets |
коллекция excludeTarget |
Группы пользователей, исключенные из политики. |
| pinLength |
Int32 |
Требуемая длина ПИН-кода. Минимальное значение — 8 цифр, а максимальное — 20 цифр. |
| standardQRCodeLifetimeInDays |
Int32 |
Время существования стандартных QR-кодов по умолчанию в днях. Минимальное значение — 1 день, а максимальное — 395 дней. Значение по умолчанию — 365 дней. |
| state |
authenticationMethodState |
Состояние политики. Возможные значения: enabled, disabled. |
Примечание: Свойство @odata.type со значением #microsoft.graph.qrCodePinAuthenticationMethodConfiguration должно быть включено в текст.
Отклик
В случае успешного 200 OK выполнения этот метод возвращает код ответа и обновленный объект qrCodePinAuthenticationMethodConfiguration в тексте ответа.
Примеры
Запрос
Ниже показан пример запроса.
PATCH https://graph.microsoft.com/v1.0/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/qrCodePin
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.qrCodePinAuthenticationMethodConfiguration",
"state": "enabled",
"standardQRCodeLifetimeInDays": 180,
"pinLength": 10
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new QrCodePinAuthenticationMethodConfiguration
{
OdataType = "#microsoft.graph.qrCodePinAuthenticationMethodConfiguration",
State = AuthenticationMethodState.Enabled,
StandardQRCodeLifetimeInDays = 180,
PinLength = 10,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Policies.AuthenticationMethodsPolicy.AuthenticationMethodConfigurations["{authenticationMethodConfiguration-id}"].PatchAsync(requestBody);
Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewAuthenticationMethodConfiguration()
state := graphmodels.ENABLED_AUTHENTICATIONMETHODSTATE
requestBody.SetState(&state)
standardQRCodeLifetimeInDays := int32(180)
requestBody.SetStandardQRCodeLifetimeInDays(&standardQRCodeLifetimeInDays)
pinLength := int32(10)
requestBody.SetPinLength(&pinLength)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
authenticationMethodConfigurations, err := graphClient.Policies().AuthenticationMethodsPolicy().AuthenticationMethodConfigurations().ByAuthenticationMethodConfigurationId("authenticationMethodConfiguration-id").Patch(context.Background(), requestBody, nil)
Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
QrCodePinAuthenticationMethodConfiguration authenticationMethodConfiguration = new QrCodePinAuthenticationMethodConfiguration();
authenticationMethodConfiguration.setOdataType("#microsoft.graph.qrCodePinAuthenticationMethodConfiguration");
authenticationMethodConfiguration.setState(AuthenticationMethodState.Enabled);
authenticationMethodConfiguration.setStandardQRCodeLifetimeInDays(180);
authenticationMethodConfiguration.setPinLength(10);
AuthenticationMethodConfiguration result = graphClient.policies().authenticationMethodsPolicy().authenticationMethodConfigurations().byAuthenticationMethodConfigurationId("{authenticationMethodConfiguration-id}").patch(authenticationMethodConfiguration);
Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.
const options = {
authProvider,
};
const client = Client.init(options);
const authenticationMethodConfiguration = {
'@odata.type': '#microsoft.graph.qrCodePinAuthenticationMethodConfiguration',
state: 'enabled',
standardQRCodeLifetimeInDays: 180,
pinLength: 10
};
await client.api('/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/qrCodePin')
.update(authenticationMethodConfiguration);
Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\QrCodePinAuthenticationMethodConfiguration;
use Microsoft\Graph\Generated\Models\AuthenticationMethodState;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new QrCodePinAuthenticationMethodConfiguration();
$requestBody->setOdataType('#microsoft.graph.qrCodePinAuthenticationMethodConfiguration');
$requestBody->setState(new AuthenticationMethodState('enabled'));
$requestBody->setStandardQRCodeLifetimeInDays(180);
$requestBody->setPinLength(10);
$result = $graphServiceClient->policies()->authenticationMethodsPolicy()->authenticationMethodConfigurations()->byAuthenticationMethodConfigurationId('authenticationMethodConfiguration-id')->patch($requestBody)->wait();
Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.
Import-Module Microsoft.Graph.Identity.SignIns
$params = @{
"@odata.type" = "#microsoft.graph.qrCodePinAuthenticationMethodConfiguration"
state = "enabled"
standardQRCodeLifetimeInDays =
pinLength =
}
Update-MgPolicyAuthenticationMethodPolicyAuthenticationMethodConfiguration -AuthenticationMethodConfigurationId $authenticationMethodConfigurationId -BodyParameter $params
Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.qr_code_pin_authentication_method_configuration import QrCodePinAuthenticationMethodConfiguration
from msgraph.generated.models.authentication_method_state import AuthenticationMethodState
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = QrCodePinAuthenticationMethodConfiguration(
odata_type = "#microsoft.graph.qrCodePinAuthenticationMethodConfiguration",
state = AuthenticationMethodState.Enabled,
standard_q_r_code_lifetime_in_days = 180,
pin_length = 10,
)
result = await graph_client.policies.authentication_methods_policy.authentication_method_configurations.by_authentication_method_configuration_id('authenticationMethodConfiguration-id').patch(request_body)
Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.
Отклик
Ниже приводится пример отклика.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.qrCodePinAuthenticationMethodConfiguration",
"id": "qrCodePin",
"state": "enabled",
"standardQRCodeLifetimeInDays": 180,
"pinLength": 10,
"excludeTargets": []
}