authentication_external_authentication_methods

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

Overview

Name	authentication_external_authentication_methods
Type	Resource
Id	entra_id.users.authentication_external_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.
configurationId	string	A unique identifier used to manage the external auth method within Microsoft Entra ID.
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])$)
displayName	string	Custom name given to the registered external MFA.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
configurationId	string	A unique identifier used to manage the external auth method within Microsoft Entra ID.
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])$)
displayName	string	Custom name given to the registered external MFA.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	user_id, external_authentication_method_id		Represents the external MFA registered to a user for authentication using an external identity provider.
list	select	user_id		Represents the external MFA registered to a user for authentication using an external identity provider.
insert	insert	user_id		Create a new externalAuthenticationMethod object. This API doesn't support self-service operations.
update	update	user_id, external_authentication_method_id
delete	delete	user_id, external_authentication_method_id	If-Match	Delete an externalAuthenticationMethod object. This API doesn't support self-service operations.

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
external_authentication_method_id	string	The unique identifier of externalAuthenticationMethod
user_id	string	The unique identifier of user
If-Match	string	ETag

SELECT examples

get

Represents the external MFA registered to a user for authentication using an external identity provider.

SELECT
id,
configurationId,
createdDateTime,
displayName
FROM entra_id.users.authentication_external_authentication_methods
WHERE user_id = '{{ user_id }}' -- required
AND external_authentication_method_id = '{{ external_authentication_method_id }}' -- required
;

list

Represents the external MFA registered to a user for authentication using an external identity provider.

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

INSERT examples

insert

Create a new externalAuthenticationMethod object. This API doesn't support self-service operations.

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

Manifest

# Description fields are for documentation purposes
- name: authentication_external_authentication_methods
props:
  - name: user_id
    value: "{{ user_id }}"
    description: Required parameter for the authentication_external_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.
  - name: configurationId
    value: "{{ configurationId }}"
    description: |
      A unique identifier used to manage the external auth method within Microsoft Entra ID.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Custom name given to the registered external MFA.

UPDATE examples

update

No description available.

UPDATE entra_id.users.authentication_external_authentication_methods
SET 
id = '{{ id }}',
createdDateTime = '{{ createdDateTime }}',
configurationId = '{{ configurationId }}',
displayName = '{{ displayName }}'
WHERE 
user_id = '{{ user_id }}' --required
AND external_authentication_method_id = '{{ external_authentication_method_id }}' --required
RETURNING
id,
configurationId,
createdDateTime,
displayName;

DELETE examples

delete

Delete an externalAuthenticationMethod object. This API doesn't support self-service operations.

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