Criar hardwareOathTokenAuthenticationMethodDevice

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 hardwareOathTokenAuthenticationMethodDevice . Esta API suporta dois cenários:

Crie o novo token de hardware sem atribuir a um utilizador. Em seguida, pode atribuir a um utilizador.
Crie e atribua um token de hardware a um utilizador no mesmo pedido.

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

Ao utilizar permissões delegadas com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ter uma função de Microsoft Entra adequada ou uma função personalizada com as permissões necessárias. A função incorporada com menos privilégios necessária para esta operação é Administrador de Políticas de Autenticação.

Para criar e atribuir um token OATH de hardware a um utilizador num único pedido, o utilizador com sessão iniciada também tem de ter:

A permissão delegada UserAuthenticationMethod.ReadWrite.All .
Administrador de Autenticação (função com menos privilégios para atribuir tokens de hardware a utilizadores não administradores) ou Administrador de Autenticação Privilegiada (função com menos privilégios para atribuir tokens de hardware a utilizadores administradores).

Solicitação HTTP

POST /directory/authenticationMethodDevices/hardwareOathDevices

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 do objeto hardwareOathTokenAuthenticationMethodDevice .

Pode especificar as seguintes propriedades ao criar um hardwareOathTokenAuthenticationMethodDevice.

Propriedade	Tipo	Descrição
serialNumber	Cadeia de caracteres	Número de série do token de hardware específico, geralmente encontrado na parte de trás do dispositivo. Obrigatório.
fabricante	Cadeia de caracteres	Nome do fabricante do token de hardware. Obrigatório.
modelo	Cadeia de caracteres	Nome do modelo do token de hardware. Obrigatório.
secretKey	Cadeia de caracteres	Chave secreta do token de hardware específico, fornecido pelo fornecedor. Obrigatório.
timeIntervalInSeconds	Int32	Intervalo de atualização do código de verificação de seis dígitos, em segundos. Os valores possíveis são: 30 ou 60. Obrigatório.
hashFunction	hardwareOathTokenHashFunction	Função hash do token de hardware. Os valores possíveis são: `hmacsha1` ou `hmacsha256`. O valor predefinido é: `hmacsha1`. Opcional.
assignTo	identity	ID de utilizador se pretender atribuir diretamente o token a um utilizador. Opcional.
displayName	Cadeia de caracteres	Nome que pode ser fornecido ao token OATH de Hardware. Opcional.

Resposta

Se for bem-sucedido, este método devolve um 201 Created código de resposta e um objeto hardwareOathTokenAuthenticationMethodDevice no corpo da resposta.

Exemplos

Exemplo 1: Criar um token sem atribuição de utilizador

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/directory/authenticationMethodDevices/hardwareOathDevices
Content-Type: application/json

{
  "displayName": "Token 1",
  "serialNumber": "TOTP123456",
  "manufacturer": "Contoso",
  "model": "Hardware Token 1000",
  "secretKey": "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB",
  "timeIntervalInSeconds": 30,
  "hashFunction": "hmacsha1"
}


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

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new HardwareOathTokenAuthenticationMethodDevice
{
	DisplayName = "Token 1",
	SerialNumber = "TOTP123456",
	Manufacturer = "Contoso",
	Model = "Hardware Token 1000",
	SecretKey = "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB",
	TimeIntervalInSeconds = 30,
	HashFunction = HardwareOathTokenHashFunction.Hmacsha1,
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Directory.AuthenticationMethodDevices.HardwareOathDevices.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.



// 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.NewHardwareOathTokenAuthenticationMethodDevice()
displayName := "Token 1"
requestBody.SetDisplayName(&displayName) 
serialNumber := "TOTP123456"
requestBody.SetSerialNumber(&serialNumber) 
manufacturer := "Contoso"
requestBody.SetManufacturer(&manufacturer) 
model := "Hardware Token 1000"
requestBody.SetModel(&model) 
secretKey := "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB"
requestBody.SetSecretKey(&secretKey) 
timeIntervalInSeconds := int32(30)
requestBody.SetTimeIntervalInSeconds(&timeIntervalInSeconds) 
hashFunction := graphmodels.HMACSHA1_HARDWAREOATHTOKENHASHFUNCTION 
requestBody.SetHashFunction(&hashFunction) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
hardwareOathDevices, err := graphClient.Directory().AuthenticationMethodDevices().HardwareOathDevices().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);

HardwareOathTokenAuthenticationMethodDevice hardwareOathTokenAuthenticationMethodDevice = new HardwareOathTokenAuthenticationMethodDevice();
hardwareOathTokenAuthenticationMethodDevice.setDisplayName("Token 1");
hardwareOathTokenAuthenticationMethodDevice.setSerialNumber("TOTP123456");
hardwareOathTokenAuthenticationMethodDevice.setManufacturer("Contoso");
hardwareOathTokenAuthenticationMethodDevice.setModel("Hardware Token 1000");
hardwareOathTokenAuthenticationMethodDevice.setSecretKey("6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB");
hardwareOathTokenAuthenticationMethodDevice.setTimeIntervalInSeconds(30);
hardwareOathTokenAuthenticationMethodDevice.setHashFunction(HardwareOathTokenHashFunction.Hmacsha1);
HardwareOathTokenAuthenticationMethodDevice result = graphClient.directory().authenticationMethodDevices().hardwareOathDevices().post(hardwareOathTokenAuthenticationMethodDevice);

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 hardwareOathTokenAuthenticationMethodDevice = {
  displayName: 'Token 1',
  serialNumber: 'TOTP123456',
  manufacturer: 'Contoso',
  model: 'Hardware Token 1000',
  secretKey: '6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB',
  timeIntervalInSeconds: 30,
  hashFunction: 'hmacsha1'
};

await client.api('/directory/authenticationMethodDevices/hardwareOathDevices')
	.version('beta')
	.post(hardwareOathTokenAuthenticationMethodDevice);

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\Models\HardwareOathTokenAuthenticationMethodDevice;
use Microsoft\Graph\Beta\Generated\Models\HardwareOathTokenHashFunction;


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

$requestBody = new HardwareOathTokenAuthenticationMethodDevice();
$requestBody->setDisplayName('Token 1');
$requestBody->setSerialNumber('TOTP123456');
$requestBody->setManufacturer('Contoso');
$requestBody->setModel('Hardware Token 1000');
$requestBody->setSecretKey('6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB');
$requestBody->setTimeIntervalInSeconds(30);
$requestBody->setHashFunction(new HardwareOathTokenHashFunction('hmacsha1'));

$result = $graphServiceClient->directory()->authenticationMethodDevices()->hardwareOathDevices()->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.


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = @{
	displayName = "Token 1"
	serialNumber = "TOTP123456"
	manufacturer = "Contoso"
	model = "Hardware Token 1000"
	secretKey = "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB"
	timeIntervalInSeconds = 30
	hashFunction = "hmacsha1"
}

New-MgBetaDirectoryAuthenticationMethodDeviceHardwareOathDevice -BodyParameter $params

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.models.hardware_oath_token_authentication_method_device import HardwareOathTokenAuthenticationMethodDevice
from msgraph_beta.generated.models.hardware_oath_token_hash_function import HardwareOathTokenHashFunction
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = HardwareOathTokenAuthenticationMethodDevice(
	display_name = "Token 1",
	serial_number = "TOTP123456",
	manufacturer = "Contoso",
	model = "Hardware Token 1000",
	secret_key = "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB",
	time_interval_in_seconds = 30,
	hash_function = HardwareOathTokenHashFunction.Hmacsha1,
)

result = await graph_client.directory.authentication_method_devices.hardware_oath_devices.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 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.hardwareOathTokenAuthenticationMethodDevice",
  "id": "9b037532-f999-1ed9-13fd-849ffb995e11",
  "displayName": "Token 1",
  "serialNumber": "TOTP123456",
  "manufacturer": "Contoso",
  "model": "Hardware Token 1000",
  "secretKey": null,
  "timeIntervalInSeconds": 30,
  "status": "available",
  "lastUsedDateTime": null,
  "assignedTo": null,
  "hashFunction": "hmacsha1"
}

Exemplo 2: Criar um token e atribuí-lo a um utilizador

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/directory/authenticationMethodDevices/hardwareOathDevices
Content-Type: application/json

{
  "displayName": "Token 1",
  "serialNumber": "TOTP123456",
  "manufacturer": "Contoso",
  "model": "Hardware Token 1000",
  "secretKey": "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB",
  "timeIntervalInSeconds": 30,
  "hashFunction": "hmacsha1",
  "assignTo": {
    "id": "0cadbf92-####-####-####-############"
    }
}


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

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new HardwareOathTokenAuthenticationMethodDevice
{
	DisplayName = "Token 1",
	SerialNumber = "TOTP123456",
	Manufacturer = "Contoso",
	Model = "Hardware Token 1000",
	SecretKey = "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB",
	TimeIntervalInSeconds = 30,
	HashFunction = HardwareOathTokenHashFunction.Hmacsha1,
	AssignTo = new User
	{
		Id = "0cadbf92-####-####-####-############",
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Directory.AuthenticationMethodDevices.HardwareOathDevices.PostAsync(requestBody);

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

requestBody := graphmodels.NewHardwareOathTokenAuthenticationMethodDevice()
displayName := "Token 1"
requestBody.SetDisplayName(&displayName) 
serialNumber := "TOTP123456"
requestBody.SetSerialNumber(&serialNumber) 
manufacturer := "Contoso"
requestBody.SetManufacturer(&manufacturer) 
model := "Hardware Token 1000"
requestBody.SetModel(&model) 
secretKey := "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB"
requestBody.SetSecretKey(&secretKey) 
timeIntervalInSeconds := int32(30)
requestBody.SetTimeIntervalInSeconds(&timeIntervalInSeconds) 
hashFunction := graphmodels.HMACSHA1_HARDWAREOATHTOKENHASHFUNCTION 
requestBody.SetHashFunction(&hashFunction) 
assignTo := graphmodels.NewUser()
id := "0cadbf92-####-####-####-############"
assignTo.SetId(&id) 
requestBody.SetAssignTo(assignTo)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
hardwareOathDevices, err := graphClient.Directory().AuthenticationMethodDevices().HardwareOathDevices().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);

HardwareOathTokenAuthenticationMethodDevice hardwareOathTokenAuthenticationMethodDevice = new HardwareOathTokenAuthenticationMethodDevice();
hardwareOathTokenAuthenticationMethodDevice.setDisplayName("Token 1");
hardwareOathTokenAuthenticationMethodDevice.setSerialNumber("TOTP123456");
hardwareOathTokenAuthenticationMethodDevice.setManufacturer("Contoso");
hardwareOathTokenAuthenticationMethodDevice.setModel("Hardware Token 1000");
hardwareOathTokenAuthenticationMethodDevice.setSecretKey("6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB");
hardwareOathTokenAuthenticationMethodDevice.setTimeIntervalInSeconds(30);
hardwareOathTokenAuthenticationMethodDevice.setHashFunction(HardwareOathTokenHashFunction.Hmacsha1);
User assignTo = new User();
assignTo.setId("0cadbf92-####-####-####-############");
hardwareOathTokenAuthenticationMethodDevice.setAssignTo(assignTo);
HardwareOathTokenAuthenticationMethodDevice result = graphClient.directory().authenticationMethodDevices().hardwareOathDevices().post(hardwareOathTokenAuthenticationMethodDevice);

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 hardwareOathTokenAuthenticationMethodDevice = {
  displayName: 'Token 1',
  serialNumber: 'TOTP123456',
  manufacturer: 'Contoso',
  model: 'Hardware Token 1000',
  secretKey: '6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB',
  timeIntervalInSeconds: 30,
  hashFunction: 'hmacsha1',
  assignTo: {
    id: '0cadbf92-####-####-####-############'
    }
};

await client.api('/directory/authenticationMethodDevices/hardwareOathDevices')
	.version('beta')
	.post(hardwareOathTokenAuthenticationMethodDevice);

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\Models\HardwareOathTokenAuthenticationMethodDevice;
use Microsoft\Graph\Beta\Generated\Models\HardwareOathTokenHashFunction;
use Microsoft\Graph\Beta\Generated\Models\User;


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

$requestBody = new HardwareOathTokenAuthenticationMethodDevice();
$requestBody->setDisplayName('Token 1');
$requestBody->setSerialNumber('TOTP123456');
$requestBody->setManufacturer('Contoso');
$requestBody->setModel('Hardware Token 1000');
$requestBody->setSecretKey('6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB');
$requestBody->setTimeIntervalInSeconds(30);
$requestBody->setHashFunction(new HardwareOathTokenHashFunction('hmacsha1'));
$assignTo = new User();
$assignTo->setId('0cadbf92-####-####-####-############');
$requestBody->setAssignTo($assignTo);

$result = $graphServiceClient->directory()->authenticationMethodDevices()->hardwareOathDevices()->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.


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = @{
	displayName = "Token 1"
	serialNumber = "TOTP123456"
	manufacturer = "Contoso"
	model = "Hardware Token 1000"
	secretKey = "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB"
	timeIntervalInSeconds = 30
	hashFunction = "hmacsha1"
	assignTo = @{
		id = "0cadbf92-####-####-####-############"
	}
}

New-MgBetaDirectoryAuthenticationMethodDeviceHardwareOathDevice -BodyParameter $params

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.models.hardware_oath_token_authentication_method_device import HardwareOathTokenAuthenticationMethodDevice
from msgraph_beta.generated.models.hardware_oath_token_hash_function import HardwareOathTokenHashFunction
from msgraph_beta.generated.models.user import User
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = HardwareOathTokenAuthenticationMethodDevice(
	display_name = "Token 1",
	serial_number = "TOTP123456",
	manufacturer = "Contoso",
	model = "Hardware Token 1000",
	secret_key = "6PJ4UKIW33NNXYZAEHQNFUFTZF7WFTFB",
	time_interval_in_seconds = 30,
	hash_function = HardwareOathTokenHashFunction.Hmacsha1,
	assign_to = User(
		id = "0cadbf92-####-####-####-############",
	),
)

result = await graph_client.directory.authentication_method_devices.hardware_oath_devices.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 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.hardwareOathTokenAuthenticationMethodDevice",
  "id": "9b037532-f999-1ed9-13fd-849ffb995e11",
  "displayName": "Token 1",
  "serialNumber": "TOTP123456",
  "manufacturer": "Contoso",
  "model": "Hardware Token 1000",
  "secretKey": null,
  "timeIntervalInSeconds": 30,
  "status": "assigned",
  "lastUsedDateTime": null,
  "assignedTo": null,
  "hashFunction": "hmacsha1",
  "assignedTo": {
    "id": "0cadbf92-####-####-####-############",
    "displayName": "Amy Masters"
    }
}

Comentários

Esta página foi útil?

Last updated on 2025-07-24

Compartilhar via

Criar hardwareOathTokenAuthenticationMethodDevice

Permissões

Solicitação HTTP

Cabeçalhos de solicitação

Corpo da solicitação

Resposta

Exemplos

Exemplo 1: Criar um token sem atribuição de utilizador

Solicitação

Resposta

Exemplo 2: Criar um token e atribuí-lo a um utilizador

Solicitação

Resposta

Comentários

Recursos adicionais