title	hardwareOathAuthenticationMethod: activate
description	Activate a hardware OATH token that is already assigned to a user. A user can self-activate their token or an admin can activate for a user.
author	luc-msft
ms.localizationpriority	medium
ms.subservice	entra-sign-in
doc_type	apiPageType
ms.date	12/06/2024

hardwareOathAuthenticationMethod: activate

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Activate a hardware OATH token that is already assigned to a user. A user can self-activate their token or an admin can activate for a user.

[!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 other users

[!INCLUDE permissions-table]

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

HTTP request

Activate a hardware OATH authentication method assigned to you.

POST /me/authentication/hardwareOathMethods/{hardwareOathAuthenticationMethodId}/activate

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

Activate a hardware OATH authentication method assigned to another user.

POST /users/{usersId}/authentication/hardwareOathMethods/{hardwareOathAuthenticationMethodId}/activate

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.
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/{hardwareOathAuthenticationMethodId}/activate
Content-Type: application/json

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