Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
A representation of an external authentication method registered to a user. External authentication methods are 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. |
| displayName | String | Custom name given to the registered external authentication method. |
| 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)",
"configurationId": "String",
"displayName": "String"
}