Skip to content

externalauthenticationmethod.md

Latest commit

 

History

History
63 lines (52 loc) · 3.13 KB

externalauthenticationmethod.md

File metadata and controls

63 lines (52 loc) · 3.13 KB
title externalAuthenticationMethod resource type
description A representation of an external MFA registered to a user. External MFA is used to sign in to Microsoft Entra ID using an external identity provider.
author rannderson
ms.date 04/01/2025
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type resourcePageType
toc.title External MFA

externalAuthenticationMethod resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

A representation of an external MFA registered to a user. External MFA is used to sign in to Microsoft Entra ID using an external identity provider.

The externalAuthenticationMethod resource is a derived type of the authenticationMethod resource type.

Methods

Method Return type Description
List externalAuthenticationMethod collection Get a list of the externalAuthenticationMethod objects and their properties.
Create externalAuthenticationMethod Create a new externalAuthenticationMethod object.
Get externalAuthenticationMethod Read the properties and relationships of an externalAuthenticationMethod object.
Delete None Delete an externalAuthenticationMethod object.

Properties

Property Type Description
configurationId String A unique identifier used to manage the external auth method within Microsoft Entra ID.
createdDateTime DateTimeOffset Represents the date and time when an entity was created. Inherited from authenticationMethod.
lastUsedDateTime DateTimeOffset The date and time the authentication method was last used by the user. Read-only. Optional. This optional value is null if the authentication method doesn't populate it. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Inherited from authenticationMethod.
displayName String Custom name given to the registered external MFA.
id String The unique identifier for an the authentication method for the user. Inherited from entity.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.externalAuthenticationMethod",
  "id": "String (identifier)",
  "createdDateTime": "String (timestamp)",
  "lastUsedDateTime": "String (timestamp)",
  "configurationId": "String",
  "displayName": "String"
}