authentication_email_methods

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

Overview

Name	authentication_email_methods
Type	Resource
Id	entra_id.users.authentication_email_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])$)
emailAddress	string	The email address registered to this user.

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])$)
emailAddress	string	The email address registered to this user.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	user_id, email_authentication_method_id		The email address registered to a user for authentication.
list	select	user_id		The email address registered to a user for authentication.
insert	insert	user_id		Set a user's emailAuthenticationMethod object. Email authentication is a self-service password reset method. A user may only have one email authentication method. Self-service operations aren't supported.
update	update	user_id, email_authentication_method_id		Update a user's email address represented by an emailAuthenticationMethod object. Self-service operations aren't supported.
delete	delete	user_id, email_authentication_method_id	If-Match	Deletes a user's emailAuthenticationMethod 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
email_authentication_method_id	string	The unique identifier of emailAuthenticationMethod
user_id	string	The unique identifier of user
If-Match	string	ETag

SELECT examples

get

The email address registered to a user for authentication.

SELECT
id,
createdDateTime,
emailAddress
FROM entra_id.users.authentication_email_methods
WHERE user_id = '{{ user_id }}' -- required
AND email_authentication_method_id = '{{ email_authentication_method_id }}' -- required
;

list

The email address registered to a user for authentication.

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

INSERT examples

insert

Set a user's emailAuthenticationMethod object. Email authentication is a self-service password reset method. A user may only have one email authentication method. Self-service operations aren't supported.

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

Manifest

# Description fields are for documentation purposes
- name: authentication_email_methods
props:
  - name: user_id
    value: "{{ user_id }}"
    description: Required parameter for the authentication_email_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.
  - name: emailAddress
    value: "{{ emailAddress }}"
    description: |
      The email address registered to this user.

UPDATE examples

update

Update a user's email address represented by an emailAuthenticationMethod object. Self-service operations aren't supported.

UPDATE entra_id.users.authentication_email_methods
SET 
id = '{{ id }}',
createdDateTime = '{{ createdDateTime }}',
emailAddress = '{{ emailAddress }}'
WHERE 
user_id = '{{ user_id }}' --required
AND email_authentication_method_id = '{{ email_authentication_method_id }}' --required
RETURNING
id,
createdDateTime,
emailAddress;

DELETE examples

delete

Deletes a user's emailAuthenticationMethod object.

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