hardwareOathAuthenticationMethod: assignAndActivate

Artigo
12/24/2024

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.

Atribua e ative um token de hardware ao mesmo tempo. Esta operação requer o ID do dispositivo para ativá-lo.

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.

Permissões que atuam de forma autónoma

Tipo de permissão	Permissões com menos privilégios	Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante)	UserAuthenticationMethod.ReadWrite	UserAuthenticationMethod.ReadWrite.All
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Application	UserAuthenticationMethod.ReadWrite.All	Indisponível.

Permissões que atuam noutro utilizador

Tipo de permissão	Permissão com menos privilégios	Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante)	Sem suporte.	Sem suporte.
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Aplicativo	Sem suporte.	Sem suporte.

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 e ative um método de autenticação OATH de hardware para si próprio.

POST /me/authentication/hardwareOathMethods/assignAndActivate

Atribua e ative um método de autenticação OATH de hardware para outro utilizador.

POST /users/{usersId}/authentication/hardwareOathMethods/assignAndActivate

Cabeçalhos de solicitação

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 dos parâmetros.

A tabela seguinte lista os parâmetros que são necessários quando chama esta ação.

Parâmetro	Tipo	Descrição
verificationCode	Cadeia de caracteres	O código TOTP de 6 dígitos que é atualizado a cada 30 ou 60 segundos no token OATH de Hardware.
device	hardwareOathTokenAuthenticationMethodDevice	ID do token de hardware que deve ser atribuído ao utilizador e ativado.
displayName	Cadeia de caracteres	Um nome opcional que pode ser fornecido ao token OATH de Hardware.

Resposta

Se tiver êxito, esta ação retornará um código de resposta 204 No Content.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/me/authentication/hardwareOathMethods/assignAndActivate
Content-Type: application/json

{
  "device": {
        "id": "aad49556-####-####-####-############"
    },
  "verificationCode": "588651",
  "displayName": "Amy Masters Token"
}


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

// Dependencies
using Microsoft.Graph.Beta.Me.Authentication.HardwareOathMethods.AssignAndActivate;
using Microsoft.Graph.Beta.Models;

var requestBody = new AssignAndActivatePostRequestBody
{
	Device = new HardwareOathTokenAuthenticationMethodDevice
	{
		Id = "aad49556-####-####-####-############",
	},
	VerificationCode = "588651",
	DisplayName = "Amy Masters Token",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Me.Authentication.HardwareOathMethods.AssignAndActivate.PostAsync(requestBody);

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.



mgc-beta users authentication hardware-oath-methods assign-and-activate post --user-id {user-id} --body '{\
  "device": {\
        "id": "aad49556-####-####-####-############"\
    },\
  "verificationCode": "588651",\
  "displayName": "Amy Masters Token"\
}\
'

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.



// 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"
	  graphusers "github.com/microsoftgraph/msgraph-beta-sdk-go/users"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphusers.NewItemAssignAndActivatePostRequestBody()
device := graphmodels.NewHardwareOathTokenAuthenticationMethodDevice()
id := "aad49556-####-####-####-############"
device.SetId(&id) 
requestBody.SetDevice(device)
verificationCode := "588651"
requestBody.SetVerificationCode(&verificationCode) 
displayName := "Amy Masters Token"
requestBody.SetDisplayName(&displayName) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Me().Authentication().HardwareOathMethods().AssignAndActivate().Post(context.Background(), requestBody, nil)

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.beta.users.item.authentication.hardwareoathmethods.assignandactivate.AssignAndActivatePostRequestBody assignAndActivatePostRequestBody = new com.microsoft.graph.beta.users.item.authentication.hardwareoathmethods.assignandactivate.AssignAndActivatePostRequestBody();
HardwareOathTokenAuthenticationMethodDevice device = new HardwareOathTokenAuthenticationMethodDevice();
device.setId("aad49556-####-####-####-############");
assignAndActivatePostRequestBody.setDevice(device);
assignAndActivatePostRequestBody.setVerificationCode("588651");
assignAndActivatePostRequestBody.setDisplayName("Amy Masters Token");
graphClient.me().authentication().hardwareOathMethods().assignAndActivate().post(assignAndActivatePostRequestBody);

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

const assignAndActivate = {
  device: {
        id: 'aad49556-####-####-####-############'
    },
  verificationCode: '588651',
  displayName: 'Amy Masters Token'
};

await client.api('/me/authentication/hardwareOathMethods/assignAndActivate')
	.version('beta')
	.post(assignAndActivate);

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Users\Item\Authentication\HardwareOathMethods\AssignAndActivate\AssignAndActivatePostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\HardwareOathTokenAuthenticationMethodDevice;


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

$requestBody = new AssignAndActivatePostRequestBody();
$device = new HardwareOathTokenAuthenticationMethodDevice();
$device->setId('aad49556-####-####-####-############');
$requestBody->setDevice($device);
$requestBody->setVerificationCode('588651');
$requestBody->setDisplayName('Amy Masters Token');

$graphServiceClient->me()->authentication()->hardwareOathMethods()->assignAndActivate()->post($requestBody)->wait();

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.users.item.authentication.hardwareoathmethods.assign_and_activate.assign_and_activate_post_request_body import AssignAndActivatePostRequestBody
from msgraph_beta.generated.models.hardware_oath_token_authentication_method_device import HardwareOathTokenAuthenticationMethodDevice
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = AssignAndActivatePostRequestBody(
	device = HardwareOathTokenAuthenticationMethodDevice(
		id = "aad49556-####-####-####-############",
	),
	verification_code = "588651",
	display_name = "Amy Masters Token",
)

await graph_client.me.authentication.hardware_oath_methods.assign_and_activate.post(request_body)

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 204 No Content

Compartilhar via

hardwareOathAuthenticationMethod: assignAndActivate

Permissões

Permissões que atuam de forma autónoma

Permissões que atuam noutro utilizador

Solicitação HTTP

Cabeçalhos de solicitação

Corpo da solicitação

Resposta

Exemplos

Solicitação

Resposta

Comentários

Recursos adicionais