authentication

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

Overview

Name	authentication
Type	Resource
Id	entra_id.users.authentication

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.
emailMethods	array	The email address registered to a user for authentication.
externalAuthenticationMethods	array	Represents the external MFA registered to a user for authentication using an external identity provider.
fido2Methods	array	Represents the FIDO2 security keys registered to a user for authentication.
methods	array	Represents all authentication methods registered to a user.
microsoftAuthenticatorMethods	array	The details of the Microsoft Authenticator app registered to a user for authentication.
operations	array	Represents the status of a long-running operation, such as a password reset operation.
passwordMethods	array	Represents the password registered to a user for authentication. For security, the password itself is never returned in the object, but action can be taken to reset a password.
phoneMethods	array	The phone numbers registered to a user for authentication.
platformCredentialMethods	array	Represents a platform credential instance registered to a user on Mac OS.
softwareOathMethods	array	The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.
temporaryAccessPassMethods	array	Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.
windowsHelloForBusinessMethods	array	Represents the Windows Hello for Business authentication method registered to a user for authentication.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	user_id		The authentication methods that are supported for the user.
update	update	user_id
delete	delete	user_id	If-Match

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
If-Match	string	ETag

SELECT examples

get

The authentication methods that are supported for the user.

SELECT
id,
emailMethods,
externalAuthenticationMethods,
fido2Methods,
methods,
microsoftAuthenticatorMethods,
operations,
passwordMethods,
phoneMethods,
platformCredentialMethods,
softwareOathMethods,
temporaryAccessPassMethods,
windowsHelloForBusinessMethods
FROM entra_id.users.authentication
WHERE user_id = '{{ user_id }}' -- required
;

UPDATE examples

update

No description available.

UPDATE entra_id.users.authentication
SET 
id = '{{ id }}',
emailMethods = '{{ emailMethods }}',
externalAuthenticationMethods = '{{ externalAuthenticationMethods }}',
fido2Methods = '{{ fido2Methods }}',
methods = '{{ methods }}',
microsoftAuthenticatorMethods = '{{ microsoftAuthenticatorMethods }}',
operations = '{{ operations }}',
passwordMethods = '{{ passwordMethods }}',
phoneMethods = '{{ phoneMethods }}',
platformCredentialMethods = '{{ platformCredentialMethods }}',
softwareOathMethods = '{{ softwareOathMethods }}',
temporaryAccessPassMethods = '{{ temporaryAccessPassMethods }}',
windowsHelloForBusinessMethods = '{{ windowsHelloForBusinessMethods }}'
WHERE 
user_id = '{{ user_id }}' --required
RETURNING
id,
emailMethods,
externalAuthenticationMethods,
fido2Methods,
methods,
microsoftAuthenticatorMethods,
operations,
passwordMethods,
phoneMethods,
platformCredentialMethods,
softwareOathMethods,
temporaryAccessPassMethods,
windowsHelloForBusinessMethods;

DELETE examples

delete

No description available.

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