authentication_microsoft_authenticator_methods

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

Overview

Name	authentication_microsoft_authenticator_methods
Type	Resource
Id	entra_id.users.authentication_microsoft_authenticator_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 Microsoft Authenticator resides. This property is null if the device isn't registered for passwordless Phone Sign-In.
deviceTag	string	Tags containing app metadata.
displayName	string	The name of the device on which this app is registered.
phoneAppVersion	string	Numerical version of this instance of the Authenticator app.

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 Microsoft Authenticator resides. This property is null if the device isn't registered for passwordless Phone Sign-In.
deviceTag	string	Tags containing app metadata.
displayName	string	The name of the device on which this app is registered.
phoneAppVersion	string	Numerical version of this instance of the Authenticator app.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	user_id, microsoft_authenticator_authentication_method_id		Read the properties and relationships of a microsoftAuthenticatorAuthenticationMethod object.
list	select	user_id		Get a list of the microsoftAuthenticatorAuthenticationMethod objects and their properties.
delete	delete	user_id, microsoft_authenticator_authentication_method_id	If-Match	Delete a microsoftAuthenticatorAuthenticationMethod 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
microsoft_authenticator_authentication_method_id	string	The unique identifier of microsoftAuthenticatorAuthenticationMethod
user_id	string	The unique identifier of user
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of a microsoftAuthenticatorAuthenticationMethod object.

SELECT
id,
createdDateTime,
device,
deviceTag,
displayName,
phoneAppVersion
FROM entra_id.users.authentication_microsoft_authenticator_methods
WHERE user_id = '{{ user_id }}' -- required
AND microsoft_authenticator_authentication_method_id = '{{ microsoft_authenticator_authentication_method_id }}' -- required
;

list

Get a list of the microsoftAuthenticatorAuthenticationMethod objects and their properties.

SELECT
id,
createdDateTime,
device,
deviceTag,
displayName,
phoneAppVersion
FROM entra_id.users.authentication_microsoft_authenticator_methods
WHERE user_id = '{{ user_id }}' -- required
;

DELETE examples

delete

Delete a microsoftAuthenticatorAuthenticationMethod object.

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