authentication_software_oath_methods

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

Overview

Name	authentication_software_oath_methods
Type	Resource
Id	entra_id.users.authentication_software_oath_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])$)
secretKey	string	The secret key of the method. Always returns null.

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])$)
secretKey	string	The secret key of the method. Always returns null.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	user_id, software_oath_authentication_method_id		The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.
list	select	user_id		The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.
delete	delete	user_id, software_oath_authentication_method_id	If-Match	Delete a user's Software OATH token authentication method 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
software_oath_authentication_method_id	string	The unique identifier of softwareOathAuthenticationMethod
user_id	string	The unique identifier of user
If-Match	string	ETag

SELECT examples

get

The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.

SELECT
id,
createdDateTime,
secretKey
FROM entra_id.users.authentication_software_oath_methods
WHERE user_id = '{{ user_id }}' -- required
AND software_oath_authentication_method_id = '{{ software_oath_authentication_method_id }}' -- required
;

list

The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.

SELECT
id,
createdDateTime,
secretKey
FROM entra_id.users.authentication_software_oath_methods
WHERE user_id = '{{ user_id }}' -- required
;

DELETE examples

delete

Delete a user's Software OATH token authentication method object.

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