編輯

共用方式為

externalAuthenticationMethodConfiguration resource type

  • 發行項

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.

Specifies the properties and connection information for an external authentication method.

Inherits from authenticationMethodConfiguration.

Methods

Method Return type Description
Get externalAuthenticationMethodConfiguration Read the properties and relationships of an externalAuthenticationMethodConfiguration object.
Update externalAuthenticationMethodConfiguration Update the properties of an externalAuthenticationMethodConfiguration object.
Delete None Delete an externalAuthenticationMethodConfiguration object.

Properties

Property Type Description
appId String appId for the app registration in Microsoft Entra ID representing the integration with the external provider.
displayName String Display name for the external authentication method. This name is shown to users during sign-in.
excludeTargets excludeTarget collection Groups of users excluded from the policy. Inherited from authenticationMethodConfiguration.
id String The unique identifier for this object. Read-only. Inherited from entity.
openIdConnectSetting openIdConnectSetting Open ID Connection settings used by this external authentication method.
state authenticationMethodState The state of the method in the policy. Inherited from authenticationMethodConfiguration. The possible values are: enabled, disabled.

Relationships

Relationship Type Description
includeTargets authenticationMethodTarget collection A collection of groups that are enabled to use an authentication method as part of an authentication method policy in Microsoft Entra ID.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.externalAuthenticationMethodConfiguration",
  "id": "String (identifier)",
  "state": "String",
  "excludeTargets": [
    {
      "@odata.type": "microsoft.graph.excludeTarget"
    }
  ],
  "displayName": "String",
  "appId": "String",
  "openIdConnectSetting": {
    "@odata.type": "microsoft.graph.openIdConnectSetting"
  }
}