Skip to content

authentication-list-hardwareoathmethods.md

Latest commit

 

History

History
176 lines (140 loc) · 6.22 KB

authentication-list-hardwareoathmethods.md

File metadata and controls

176 lines (140 loc) · 6.22 KB
title List hardwareOathAuthenticationMethod objects
description List all hardware tokens assigned to a user
author luc-msft
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 12/06/2024

List hardwareOathAuthenticationMethod objects

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get a list of the hardware tokens 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 other users

[!INCLUDE permissions-table]

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

HTTP request

Get details of your own hardware OATH methods.

GET /me/authentication/hardwareOathMethods

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

Get details of another user's hardware OATH methods.

GET /users/{usersId}/authentication/hardwareOathMethods

Optional query parameters

This method supports the $select, $filter and $top OData query parameters to help customize the response. For general information, see OData query parameters.

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 collection of hardwareOathAuthenticationMethod objects in the response body.

Examples

Request

The following example shows a request to retrieve the hardware tokens for the signed-in user.

HTTP

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

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-####-####-####-############",
      "device": {
        "id": "aad49556-####-####-####-############",
        "displayName": "Amy Masters Token 1",
        "serialNumber": "TOTP123456",
        "manufacturer": "Contoso",
        "model": "Hardware Token 1000",
        "secretKey": null,
        "timeIntervalInSeconds": 30,
        "status": "activated",
        "hashFunction": "hmacsha1",
        "assignedTo": {
            "id": "0cadbf92-####-####-####-############",
            "displayName": "Amy Masters"
        }
      }
    },
    {
      "@odata.type": "#microsoft.graph.hardwareOathAuthenticationMethod",
      "id": "3dee0e53-####-####-####-############",
      "device": {
        "id": "3dee0e53-####-####-####-############",
        "displayName": "Amy Masters Token 2",
        "serialNumber": "TOTP654321",
        "manufacturer": "Contoso",
        "model": "Hardware Token 1000",
        "secretKey": null,
        "timeIntervalInSeconds": 30,
        "status": "activated",
        "hashFunction": "hmacsha1",
        "assignedTo": {
            "id": "0cadbf92-####-####-####-############",
            "displayName": "Amy Masters"
        }
      }
    }
  ]
}