title	Update externalAuthenticationMethodConfiguration
description	Update the properties of an externalAuthenticationMethodConfiguration object.
author	gregkmsft
ms.localizationpriority	medium
ms.subservice	entra-sign-in
doc_type	apiPageType
ms.date	09/10/2024

Update externalAuthenticationMethodConfiguration

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Update the properties of an externalAuthenticationMethodConfiguration object.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE rbac-authentication-methods-policy-apis-write]

HTTP request

PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{id}

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

[!INCLUDE table-intro]

Property	Type	Description
appId	String	appId for the app registration in Microsoft Entra ID representing the integration with the external provider.
excludeTargets	excludeTarget collection	Groups representing the users that should be excluded from the policy.
includeTargets	authenticationMethodTarget collection	Groups representing the users that are included in the policy and that can use the external authentication method.
state	authenticationMethodState	The state of the method in the policy. The possible values are: `enabled`, `disabled`.
openIdConnectSetting	openIdConnectSetting	Object representing the required settings for the OIDC request to the external provider.

Response

If successful, this method returns a 204 No Content response code.

Examples

Request

The following example shows a request.

HTTP

PATCH https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/b183b746-e7db-4fa2-bafc-69ecf18850dd
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.externalAuthenticationMethodConfiguration",
  "includeTargets": [
    {
        "targetType": "group",
        "id": "b183b746-e7db-4fa2-bafc-69ecf18850dd",
        "isRegistrationRequired": false,
    }
  ],
  "state": "enabled"
}