authentication_windows_hello_for_business_methods

Creates, updates, deletes, gets or lists an authentication_windows_hello_for_business_methods resource.

Overview

Name	authentication_windows_hello_for_business_methods
Type	Resource
Id	entra_id.users.authentication_windows_hello_for_business_methods

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
createdDateTime	string (date-time)	Represents the date and time when an entity was created. Read-only. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
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.
displayName	string	The name of the device on which Windows Hello for Business is registered
keyStrength		Key strength of this Windows Hello for Business key. The possible values are: normal, weak, unknown.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
createdDateTime	string (date-time)	Represents the date and time when an entity was created. Read-only. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
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.
displayName	string	The name of the device on which Windows Hello for Business is registered
keyStrength		Key strength of this Windows Hello for Business key. The possible values are: normal, weak, unknown.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	user_id, windows_hello_for_business_authentication_method_id		Read the properties and relationships of a windowsHelloForBusinessAuthenticationMethod object.
list	select	user_id		Get a list of the windowsHelloForBusinessAuthenticationMethod objects and their properties.
delete	delete	user_id, windows_hello_for_business_authentication_method_id	If-Match	Deletes a windowsHelloForBusinessAuthenticationMethod object.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
user_id	string	The unique identifier of user
windows_hello_for_business_authentication_method_id	string	The unique identifier of windowsHelloForBusinessAuthenticationMethod
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of a windowsHelloForBusinessAuthenticationMethod object.

SELECT
id,
createdDateTime,
device,
displayName,
keyStrength
FROM entra_id.users.authentication_windows_hello_for_business_methods
WHERE user_id = '{{ user_id }}' -- required
AND windows_hello_for_business_authentication_method_id = '{{ windows_hello_for_business_authentication_method_id }}' -- required
;

list

Get a list of the windowsHelloForBusinessAuthenticationMethod objects and their properties.

SELECT
id,
createdDateTime,
device,
displayName,
keyStrength
FROM entra_id.users.authentication_windows_hello_for_business_methods
WHERE user_id = '{{ user_id }}' -- required
;

DELETE examples

delete

Deletes a windowsHelloForBusinessAuthenticationMethod object.

DELETE FROM entra_id.users.authentication_windows_hello_for_business_methods
WHERE user_id = '{{ user_id }}' --required
AND windows_hello_for_business_authentication_method_id = '{{ windows_hello_for_business_authentication_method_id }}' --required
AND If-Match = '{{ If-Match }}'
;