Edit

Share via


Get hardwareOathAuthenticationMethod

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get the details of the hardware token assigned to a user.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

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

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) UserAuthenticationMethod.Read UserAuthenticationMethod.ReadWrite, UserAuthenticationMethod.ReadWrite.All, UserAuthenticationMethod.Read.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application UserAuthenticationMethod.Read.All UserAuthenticationMethod.ReadWrite.All

Permissions acting on another user

Permission type Least privileged permission Higher privileged permissions
Delegated (work or school account) Not supported. Not supported.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Not supported. Not supported.

Important

In delegated scenarios with work or school accounts where the signed-in user is acting on another user, they must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.

  • Global Reader
  • Authentication Administrator
  • Privileged Authentication Administrator

HTTP request

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

GET /me/authentication/hardwareOathMethods/{hardwareOathAuthenticationMethodId}

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.

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

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",
        "serialNumber": "TOTP123456",
        "manufacturer": "Contoso",
        "model": "Hardware Token 1000",
        "secretKey": null,
        "timeIntervalInSeconds": 30,
        "status": "activated",
        "hashFunction": "hmacsha1",
        "assignedTo": {
            "id": "0cadbf92-####-####-####-############",
            "displayName": "Amy Masters"
        }
    }
  }
}