hardwareOathAuthenticationMethod: assignAndActivateBySerialNumber

Article
2024-12-23

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Assign and activate a hardware token at the same time by hardware token serial number.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permissions acting on self

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	UserAuthenticationMethod.ReadWrite	UserAuthenticationMethod.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

Permissions acting on another user

Permission type	Least privileged permission	Higher privileged permissions
Delegated (work or school account)	UserAuthenticationMethod.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	UserAuthenticationMethod.ReadWrite.All	Not available.

Important

In delegated scenarios with work or school accounts where the signed-in user is acting on another user, they must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.

Authentication Administrator
Privileged Authentication Administrator

HTTP request

Assign and activate a hardware OATH authentication method for yourself by using the device serial number.

POST /me/authentication/hardwareOathMethods/assignAndActivateBySerialNumber

Note

Calling the /me endpoint requires a signed-in user and therefore a delegated permission. Application permissions aren't supported when using the /me endpoint.

Assign and activate a hardware OATH authentication method for another user by using the device serial number.

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

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the parameters.

The following table lists the parameters that are required when you call this action.

Parameter	Type	Description
verificationCode	String	The 6-digit TOTP code that refreshes every 30 or 60 seconds on the Hardware OATH token.
serialNumber	String	Serial number of the Hardware OATH token, often found on the back of the token.
displayName	String	An optional name that can be provided to the Hardware OATH token.

Response

If successful, this action returns a 204 No Content response code.

Examples

Request

The following example shows a request.

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

{
  "verificationCode": "588651",
  "serialNumber": "TOTP123456",
  "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.AssignAndActivateBySerialNumber;

var requestBody = new AssignAndActivateBySerialNumberPostRequestBody
{
	VerificationCode = "588651",
	SerialNumber = "TOTP123456",
	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.AssignAndActivateBySerialNumber.PostAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



mgc-beta users authentication hardware-oath-methods assign-and-activate-by-serial-number post --user-id {user-id} --body '{\
  "verificationCode": "588651",\
  "serialNumber": "TOTP123456",\
  "displayName": "Amy Masters Token"\
}\
'

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// 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"
	  //other-imports
)

requestBody := graphusers.NewItemAssignAndActivateBySerialNumberPostRequestBody()
verificationCode := "588651"
requestBody.SetVerificationCode(&verificationCode) 
serialNumber := "TOTP123456"
requestBody.SetSerialNumber(&serialNumber) 
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().AssignAndActivateBySerialNumber().Post(context.Background(), requestBody, nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// 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.assignandactivatebyserialnumber.AssignAndActivateBySerialNumberPostRequestBody assignAndActivateBySerialNumberPostRequestBody = new com.microsoft.graph.beta.users.item.authentication.hardwareoathmethods.assignandactivatebyserialnumber.AssignAndActivateBySerialNumberPostRequestBody();
assignAndActivateBySerialNumberPostRequestBody.setVerificationCode("588651");
assignAndActivateBySerialNumberPostRequestBody.setSerialNumber("TOTP123456");
assignAndActivateBySerialNumberPostRequestBody.setDisplayName("Amy Masters Token");
graphClient.me().authentication().hardwareOathMethods().assignAndActivateBySerialNumber().post(assignAndActivateBySerialNumberPostRequestBody);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const assignAndActivateBySerialNumber = {
  verificationCode: '588651',
  serialNumber: 'TOTP123456',
  displayName: 'Amy Masters Token'
};

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

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Users\Item\Authentication\HardwareOathMethods\AssignAndActivateBySerialNumber\AssignAndActivateBySerialNumberPostRequestBody;


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

$requestBody = new AssignAndActivateBySerialNumberPostRequestBody();
$requestBody->setVerificationCode('588651');
$requestBody->setSerialNumber('TOTP123456');
$requestBody->setDisplayName('Amy Masters Token');

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

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


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

$params = @{
	verificationCode = "588651"
	serialNumber = "TOTP123456"
	displayName = "Amy Masters Token"
}

# A UPN can also be used as -UserId.
Set-MgBetaUserAuthenticationHardwareOathMethodAndActivateBySerialNumber -UserId $userId -BodyParameter $params

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# 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_by_serial_number.assign_and_activate_by_serial_number_post_request_body import AssignAndActivateBySerialNumberPostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = AssignAndActivateBySerialNumberPostRequestBody(
	verification_code = "588651",
	serial_number = "TOTP123456",
	display_name = "Amy Masters Token",
)

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

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

HTTP/1.1 204 No Content

Share via

hardwareOathAuthenticationMethod: assignAndActivateBySerialNumber

Permissions

Permissions acting on self

Permissions acting on another user

HTTP request

Request headers

Request body

Response

Examples

Request

Response

Feedback

Additional resources