Skip to content

authentication-post-hardwareoathmethods.md

Latest commit

 

History

History
149 lines (112 loc) · 5.44 KB

authentication-post-hardwareoathmethods.md

File metadata and controls

149 lines (112 loc) · 5.44 KB
title Create hardwareOathAuthenticationMethod
description Assign a hardware token to a user without activation.
author luc-msft
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 12/06/2024

Create hardwareOathAuthenticationMethod

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Assign a hardware token to a user without activation. To activate, use the activation API operation.

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

Assign a hardware OATH authentication method to yourself.

POST /me/authentication/hardwareOathMethods

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

Assign a hardware OATH authentication method to another user.

POST /users/{usersId}/authentication/hardwareOathMethods

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 hardwareOathAuthenticationMethod object.

You can specify the following properties when creating a hardwareOathAuthenticationMethod.

Property Type Description
id String ID of the hardware token that is to be assigned to the user and activated.

Response

If successful, this method returns a 201 Created response code and a hardwareOathAuthenticationMethod object in the response body.

Examples

Request

The following example shows a request.

HTTP

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

{
  "device": {
        "id": "aad49556-####-####-####-############"
    },
}

C#

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

Go

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

Java

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

JavaScript

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

PHP

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

PowerShell

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

Python

[!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 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.hardwareOathAuthenticationMethod",
  "id": "658d0bfe-3cb9-d4d3-5296-147bc3b1f130",
  "createdDateTime": "String (timestamp)"
}