title	hardwareOathAuthenticationMethod: assignAndActivateBySerialNumber
description	Assign and activate a hardware token at the same time by hardware token serial number.
author	luc-msft
ms.localizationpriority	medium
ms.subservice	entra-sign-in
doc_type	apiPageType
ms.date	12/06/2024

hardwareOathAuthenticationMethod: assignAndActivateBySerialNumber

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

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

[!INCLUDE national-cloud-support]

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

[!INCLUDE permissions-table]

Permissions acting on another user

[!INCLUDE permissions-table]

[!INCLUDE rbac-authentication-methods-apis-write-others]

HTTP request

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

POST /me/authentication/hardwareOathMethods/assignAndActivateBySerialNumber

[!INCLUDE me-apis-sign-in-note]

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.

HTTP

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

{
  "verificationCode": "588651",
  "serialNumber": "TOTP123456",
  "displayName": "Amy Masters Token"
}