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.
Crie um novo objeto externalAuthenticationMethod . Esta API não suporta operações self-service.
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 |
| Delegado (conta corporativa ou de estudante) |
UserAuthMethod-External.ReadWrite |
UserAuthMethod-External.ReadWrite.All, UserAuthenticationMethod.ReadWrite, UserAuthenticationMethod.ReadWrite.All |
| Delegado (conta pessoal da Microsoft) |
Sem suporte. |
Sem suporte. |
| Application |
UserAuthMethod-External.ReadWrite.All |
UserAuthenticationMethod.ReadWrite.All |
Importante
Em cenários delegados com contas escolares ou profissionais em que o utilizador com sessão iniciada está a agir sobre outro utilizador, tem de lhes ser atribuída uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. As seguintes funções com menos privilégios são suportadas para esta operação.
- Administrador de Autenticação
- Administrador de Autenticação Privilegiada
Solicitação HTTP
Atribua um método de autenticação externo a outro utilizador. Esta API não suporta operações self-service.
POST /users/{usersId}/authentication/externalAuthenticationMethods
| 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 uma representação JSON do objeto externalAuthenticationMethod .
Pode especificar as seguintes propriedades ao criar um externalAuthenticationMethod.
| Propriedade |
Tipo |
Descrição |
| configurationId |
Cadeia de caracteres |
Um identificador exclusivo utilizado para gerir e integrar métodos de autenticação externa no Microsoft Entra ID. Obrigatório. |
| displayName |
Cadeia de caracteres |
Nome personalizado dado ao método de autenticação externa registado. Obrigatório. |
Resposta
Se for bem-sucedido, este método devolve um 201 Created código de resposta e um objeto externalAuthenticationMethod no corpo da resposta.
Exemplos
Solicitação
O exemplo a seguir mostra uma solicitação.
POST https://graph.microsoft.com/beta/users/{id}/authentication/externalAuthenticationMethods
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.externalAuthenticationMethod",
"configurationId": "26310fee-860b-4eab-8749-ab730dcf335e",
"displayName": "Adatum"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new ExternalAuthenticationMethod
{
OdataType = "#microsoft.graph.externalAuthenticationMethod",
ConfigurationId = "26310fee-860b-4eab-8749-ab730dcf335e",
DisplayName = "Adatum",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Users["{user-id}"].Authentication.ExternalAuthenticationMethods.PostAsync(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.NewExternalAuthenticationMethod()
configurationId := "26310fee-860b-4eab-8749-ab730dcf335e"
requestBody.SetConfigurationId(&configurationId)
displayName := "Adatum"
requestBody.SetDisplayName(&displayName)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
externalAuthenticationMethods, err := graphClient.Users().ByUserId("user-id").Authentication().ExternalAuthenticationMethods().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
ExternalAuthenticationMethod externalAuthenticationMethod = new ExternalAuthenticationMethod();
externalAuthenticationMethod.setOdataType("#microsoft.graph.externalAuthenticationMethod");
externalAuthenticationMethod.setConfigurationId("26310fee-860b-4eab-8749-ab730dcf335e");
externalAuthenticationMethod.setDisplayName("Adatum");
ExternalAuthenticationMethod result = graphClient.users().byUserId("{user-id}").authentication().externalAuthenticationMethods().post(externalAuthenticationMethod);
const options = {
authProvider,
};
const client = Client.init(options);
const externalAuthenticationMethod = {
'@odata.type': '#microsoft.graph.externalAuthenticationMethod',
configurationId: '26310fee-860b-4eab-8749-ab730dcf335e',
displayName: 'Adatum'
};
await client.api('/users/{id}/authentication/externalAuthenticationMethods')
.version('beta')
.post(externalAuthenticationMethod);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\ExternalAuthenticationMethod;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ExternalAuthenticationMethod();
$requestBody->setOdataType('#microsoft.graph.externalAuthenticationMethod');
$requestBody->setConfigurationId('26310fee-860b-4eab-8749-ab730dcf335e');
$requestBody->setDisplayName('Adatum');
$result = $graphServiceClient->users()->byUserId('user-id')->authentication()->externalAuthenticationMethods()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
"@odata.type" = "#microsoft.graph.externalAuthenticationMethod"
configurationId = "26310fee-860b-4eab-8749-ab730dcf335e"
displayName = "Adatum"
}
New-MgBetaUserAuthenticationExternalAuthenticationMethod -UserId $userId -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.external_authentication_method import ExternalAuthenticationMethod
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ExternalAuthenticationMethod(
odata_type = "#microsoft.graph.externalAuthenticationMethod",
configuration_id = "26310fee-860b-4eab-8749-ab730dcf335e",
display_name = "Adatum",
)
result = await graph_client.users.by_user_id('user-id').authentication.external_authentication_methods.post(request_body)
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.externalAuthenticationMethod",
"id": "78381c69-811f-51f6-66ec-c2c2aa0e2b46",
"createdDateTime": "2025-04-02T16:01:39",
"configurationId": "26310fee-860b-4eab-8749-ab730dcf335e",
"displayName": "Adatum"
}