Namespace: microsoft.graph
Importante
As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Atualize as propriedades de um objeto emailAuthenticationMethodConfiguration, que representa a política de método de autenticação OTP de e-mail para o inquilino Microsoft Entra.
Esta API está disponível nas seguintes implementações de cloud nacionais.
| Serviço global |
US Government L4 |
US Government L5 (DOD) |
China operada pela 21Vianet |
| ✅ |
✅ |
✅ |
✅ |
Permissões
Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.
| Tipo de permissão |
Permissões com menos privilégios |
Permissões com privilégios superiores |
| Delegada (conta corporativa ou de estudante) |
Policy.ReadWrite.AuthenticationMethod |
Indisponível. |
| Delegado (conta pessoal da Microsoft) |
Sem suporte. |
Sem suporte. |
| Aplicativo |
Policy.ReadWrite.AuthenticationMethod |
Indisponível. |
Importante
Para acesso delegado através de contas escolares ou profissionais, tem de ser atribuída ao utilizador com sessão iniciada uma função de Microsoft Entra suportada ou uma função personalizada que conceda as permissões necessárias para esta operação.
O Administrador de Políticas de Autenticação é a função com menos privilégios suportada para esta operação.
Solicitação HTTP
PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/email
| Nome |
Descrição |
| Autorização |
{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
| Content-Type |
application/json. Obrigatório. |
Corpo da solicitação
No corpo do pedido, forneça apenas os valores das propriedades a atualizar. As propriedades existentes que não estão incluídas no corpo do pedido mantêm os valores anteriores ou são recalculadas com base em alterações a outros valores de propriedade.
A tabela a seguir especifica as propriedades que podem ser atualizadas.
| Propriedade |
Tipo |
Descrição |
| allowExternalIdToUseEmailOtp |
externalEmailOtpState |
Determina se o OTP de e-mail é utilizável por utilizadores externos para autenticação. Os valores possíveis são: default, enabled, disabled, unknownFutureValue. |
| excludeTargets |
excludeTarget collection |
Grupos de utilizadores excluídos da política. |
| state |
authenticationMethodState |
Indica se este método de autenticação está ativado ou não. Os valores possíveis são: enabled, disabled. |
Nota: Tem de incluir a @odata.type propriedade com um valor de #microsoft.graph.emailAuthenticationMethodConfiguration no corpo do pedido.
Resposta
Se tiver êxito, este método retornará um código de resposta 204 No Content. Não devolve nada no corpo da resposta.
Exemplos
Solicitação
PATCH https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/email
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.emailAuthenticationMethodConfiguration",
"allowExternalIdToUseEmailOtp": "disabled",
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new EmailAuthenticationMethodConfiguration
{
OdataType = "#microsoft.graph.emailAuthenticationMethodConfiguration",
AllowExternalIdToUseEmailOtp = ExternalEmailOtpState.Disabled,
};
// 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);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewAuthenticationMethodConfiguration()
allowExternalIdToUseEmailOtp := graphmodels.DISABLED_EXTERNALEMAILOTPSTATE
requestBody.SetAllowExternalIdToUseEmailOtp(&allowExternalIdToUseEmailOtp)
// 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)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
EmailAuthenticationMethodConfiguration authenticationMethodConfiguration = new EmailAuthenticationMethodConfiguration();
authenticationMethodConfiguration.setOdataType("#microsoft.graph.emailAuthenticationMethodConfiguration");
authenticationMethodConfiguration.setAllowExternalIdToUseEmailOtp(ExternalEmailOtpState.Disabled);
AuthenticationMethodConfiguration result = graphClient.policies().authenticationMethodsPolicy().authenticationMethodConfigurations().byAuthenticationMethodConfigurationId("{authenticationMethodConfiguration-id}").patch(authenticationMethodConfiguration);
const options = {
authProvider,
};
const client = Client.init(options);
const authenticationMethodConfiguration = {
'@odata.type': '#microsoft.graph.emailAuthenticationMethodConfiguration',
allowExternalIdToUseEmailOtp: 'disabled',
};
await client.api('/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/email')
.version('beta')
.update(authenticationMethodConfiguration);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\EmailAuthenticationMethodConfiguration;
use Microsoft\Graph\Beta\Generated\Models\ExternalEmailOtpState;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new EmailAuthenticationMethodConfiguration();
$requestBody->setOdataType('#microsoft.graph.emailAuthenticationMethodConfiguration');
$requestBody->setAllowExternalIdToUseEmailOtp(new ExternalEmailOtpState('disabled'));
$result = $graphServiceClient->policies()->authenticationMethodsPolicy()->authenticationMethodConfigurations()->byAuthenticationMethodConfigurationId('authenticationMethodConfiguration-id')->patch($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
"@odata.type" = "#microsoft.graph.emailAuthenticationMethodConfiguration"
allowExternalIdToUseEmailOtp = "disabled"
}
Update-MgBetaPolicyAuthenticationMethodPolicyAuthenticationMethodConfiguration -AuthenticationMethodConfigurationId $authenticationMethodConfigurationId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.email_authentication_method_configuration import EmailAuthenticationMethodConfiguration
from msgraph_beta.generated.models.external_email_otp_state import ExternalEmailOtpState
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = EmailAuthenticationMethodConfiguration(
odata_type = "#microsoft.graph.emailAuthenticationMethodConfiguration",
allow_external_id_to_use_email_otp = ExternalEmailOtpState.Disabled,
)
result = await graph_client.policies.authentication_methods_policy.authentication_method_configurations.by_authentication_method_configuration_id('authenticationMethodConfiguration-id').patch(request_body)
Resposta
HTTP/1.1 204 NO CONTENT