Skip to content

windowshelloforbusinessauthenticationmethod.md

Latest commit

 

History

History
62 lines (53 loc) · 3.83 KB

windowshelloforbusinessauthenticationmethod.md

File metadata and controls

62 lines (53 loc) · 3.83 KB
title windowsHelloForBusinessAuthenticationMethod resource type
description A representation of a Windows Hello for Business instance registered to a user. Windows Hello for Business is a sign-in authentication method.
author calvinlui
ms.reviewer intelligentaccesspm
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type resourcePageType
toc.title Windows Hello for Business
ms.date 07/22/2024

windowsHelloForBusinessAuthenticationMethod resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

A representation of a Windows Hello for Business authentication method registered to a user. Windows Hello for Business is a sign-in authentication method for Windows devices.

This is a derived type that inherits from the authenticationMethod resource type.

Methods

Method Return type Description
List windowsHelloForBusinessAuthenticationMethod collection Get a list of the windowsHelloForBusinessAuthenticationMethod objects and their properties.
Get windowsHelloForBusinessAuthenticationMethod Read the properties and relationships of a windowsHelloForBusinessAuthenticationMethod object.
Delete None Deletes a windowsHelloForBusinessAuthenticationMethod object.

Properties

Property Type Description
createdDateTime DateTimeOffset The date and time that this Windows Hello for Business key was registered.
displayName String The name of the device on which Windows Hello for Business is registered
id String A unique identifier for this authentication method. Inherited from authenticationMethod
keyStrength authenticationMethodKeyStrength Key strength of this Windows Hello for Business key. The possible values are: normal, weak, unknown.
lastUsedDateTime DateTimeOffset The date and time the authentication method was last used by the user. Read-only. Optional. This optional value is null if the authentication method doesn't populate it. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Inherited from authenticationMethod.

Relationships

Relationship Type Description
device device The registered device on which this Windows Hello for Business key resides. Supports $expand.

When you get a user's Windows Hello for Business registration information, this property is returned only on a single GET and when you specify ?$expand. For example, GET /users/admin@contoso.com/authentication/windowsHelloForBusinessMethods/_jpuR-TGZtk6aQCLF3BQjA2?$expand=device.

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.windowsHelloForBusinessAuthenticationMethod",
  "id": "String (Identifier)",
  "displayName": "String",
  "createdDateTime": "String (timestamp)",
  "keyStrength": {"@odata.type": "microsoft.graph.authenticationMethodKeyStrength"},
  "lastUsedDateTime": "String (timestamp)",
}