Skip to content

Latest commit

 

History

History
148 lines (109 loc) · 5.51 KB

File metadata and controls

148 lines (109 loc) · 5.51 KB
title hardwareOathAuthenticationMethod: assignAndActivate
description Assign and activate a hardware token at the same time.
author luc-msft
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 12/06/2024

hardwareOathAuthenticationMethod: assignAndActivate

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Assign and activate a hardware token at the same time. This operation requires the device ID to activate it.

[!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.

POST /me/authentication/hardwareOathMethods/assignAndActivate

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

Assign and activate a hardware OATH authentication method for another user.

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

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.
device hardwareOathTokenAuthenticationMethodDevice ID of the hardware token that is to be assigned to the user and activated.
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/assignAndActivate
Content-Type: application/json

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

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]


Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 204 No Content