Update emailAuthenticationMethod

Namespace: microsoft.graph

Update a user's email address represented by an emailAuthenticationMethod object.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

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.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) UserAuthenticationMethod.ReadWrite.All UserAuthenticationMethod.ReadWrite
Delegated (personal Microsoft account) Not supported. Not supported.
Application UserAuthenticationMethod.ReadWrite.All Not available.

In delegated scenarios with work or school accounts where the signed-in user is acting on another user, they must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.

  • Authentication Administrator
  • Privileged Authentication Administrator

Users cannot update their own email authentication method.

HTTP request

The ID of the email authentication method, referenced by {emailMethods-id}, is always 3ddfcfc8-9383-446f-83cc-3ab9be4be18f.

Update the email authentication method for another user's account.

PATCH /users/{id | userPrincipalName}/authentication/emailMethods/{emailMethods-id}

Request headers

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

Request body

In the request body, supply a JSON representation of the emailAuthenticationMethod object with the updated email address.

The following table shows the properties that are required when you update the emailAuthenticationMethod.

Property Type Description
emailAddress String New email address.

Response

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

Examples

Request

PATCH https://graph.microsoft.com/v1.0/users/kim@contoso.com/authentication/emailMethods/3ddfcfc8-9383-446f-83cc-3ab9be4be18f
Content-Type: application/json

{
  "emailAddress": "kim@contoso.com"
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 204 No Content