authentication_methods

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

Overview

Name	authentication_methods
Type	Resource
Id	entra_id.users.authentication_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])$)

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])$)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	user_id, authentication_method_id		Represents all authentication methods registered to a user.
list	select	user_id		Represents all authentication methods registered to a user.
insert	insert	user_id
update	update	user_id, authentication_method_id
reset_password	exec	user_id, authentication_method_id		Reset a user's password, represented by a password authentication method object. This can only be done by an administrator with appropriate permissions and can't be performed on a user's own account. To reset a user's password in Azure AD B2C, use the Update user API operation and update the passwordProfile > forceChangePasswordNextSignIn object. This flow writes the new password to Microsoft Entra ID and pushes it to on-premises Active Directory if configured using password writeback. The admin can either provide a new password or have the system generate one. The user is prompted to change their password on their next sign in. This reset is a long-running operation and returns a Location header with a link where the caller can periodically check for the status of the reset operation.

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
authentication_method_id	string	The unique identifier of authenticationMethod
user_id	string	The unique identifier of user

SELECT examples

get

Represents all authentication methods registered to a user.

SELECT
id,
createdDateTime
FROM entra_id.users.authentication_methods
WHERE user_id = '{{ user_id }}' -- required
AND authentication_method_id = '{{ authentication_method_id }}' -- required
;

list

Represents all authentication methods registered to a user.

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

INSERT examples

insert

No description available.

INSERT INTO entra_id.users.authentication_methods (
id,
createdDateTime,
user_id
)
SELECT 
'{{ id }}',
'{{ createdDateTime }}',
'{{ user_id }}'
RETURNING
id,
createdDateTime
;

Manifest

# Description fields are for documentation purposes
- name: authentication_methods
props:
  - name: user_id
    value: "{{ user_id }}"
    description: Required parameter for the authentication_methods resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: createdDateTime
    value: "{{ createdDateTime }}"
    description: |
      Represents the date and time when an entity was created. Read-only.

UPDATE examples

update

No description available.

UPDATE entra_id.users.authentication_methods
SET 
id = '{{ id }}',
createdDateTime = '{{ createdDateTime }}'
WHERE 
user_id = '{{ user_id }}' --required
AND authentication_method_id = '{{ authentication_method_id }}' --required
RETURNING
id,
createdDateTime;

Lifecycle Methods

reset_password

Reset a user's password, represented by a password authentication method object. This can only be done by an administrator with appropriate permissions and can't be performed on a user's own account. To reset a user's password in Azure AD B2C, use the Update user API operation and update the passwordProfile > forceChangePasswordNextSignIn object. This flow writes the new password to Microsoft Entra ID and pushes it to on-premises Active Directory if configured using password writeback. The admin can either provide a new password or have the system generate one. The user is prompted to change their password on their next sign in. This reset is a long-running operation and returns a Location header with a link where the caller can periodically check for the status of the reset operation.

EXEC entra_id.users.authentication_methods.reset_password 
@user_id='{{ user_id }}' --required, 
@authentication_method_id='{{ authentication_method_id }}' --required 
@@json=
'{
"newPassword": "{{ newPassword }}"
}'
;