Skip to content

hardwareoathauthenticationmethod-get.md

Latest commit

 

History

History
157 lines (120 loc) · 5.56 KB

hardwareoathauthenticationmethod-get.md

File metadata and controls

157 lines (120 loc) · 5.56 KB
title Get hardwareOathAuthenticationMethod
description Get the details of the hardware token assigned to a user.
author luc-msft
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 12/06/2024

Get hardwareOathAuthenticationMethod

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get the details of the hardware token assigned to 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 another user

[!INCLUDE permissions-table]

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

HTTP request

Get details of a hardware OATH authentication method assigned to you.

GET /me/authentication/hardwareOathMethods/{hardwareOathAuthenticationMethodId}

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

Get details of a hardware OATH authentication method assigned to another user.

GET /users/{usersId}/authentication/hardwareOathMethods/{hardwareOathAuthenticationMethodId}

Optional query parameters

This method does not support optional query parameters to customize the response.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

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

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/me/authentication/hardwareOathMethods/{hardwareOathAuthenticationMethodId}

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 200 OK
Content-Type: application/json

{
  "value": {
    "@odata.type": "#microsoft.graph.hardwareOathAuthenticationMethod",
    "id": "aad49556-####-####-####-############",
    "lastUsedDateTime": "2022-11-06T23:16:12Z",
    "device": {
        "id": "aad49556-####-####-####-############",
        "displayName": "Amy Masters Token",
        "serialNumber": "TOTP123456",
        "manufacturer": "Contoso",
        "model": "Hardware Token 1000",
        "secretKey": null,
        "timeIntervalInSeconds": 30,
        "status": "activated",
        "hashFunction": "hmacsha1",
        "assignedTo": {
            "id": "0cadbf92-####-####-####-############",
            "displayName": "Amy Masters"
        }
    }
  }
}