Create emailMethod

Namespace: microsoft.graph

Set a user's emailAuthenticationMethod object. Email authentication is a self-service password reset method. A user may only have one email authentication method.

Self-service operations aren't supported.

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 Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application UserAuthenticationMethod.ReadWrite.All Not available.

Important

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

HTTP request

Add an email authentication method to another user's account.

POST /users/{id | userPrincipalName}/authentication/emailMethods

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 desired email address.

The following table lists the properties that are required when you create the emailAuthenticationMethod.

Property Type Description
emailAddress String Email address.

Response

If successful, this method returns a 201 Created response code and a new emailAuthenticationMethod object in the response body.

Examples

Request

POST https://graph.microsoft.com/v1.0/users/[email protected]/authentication/emailMethods
Content-Type: application/json

{
  "emailAddress": "[email protected]"
}

Response

The following example shows the response.

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

HTTP/1.1 201 Created
Content-type: application/json

{
  "id": "3ddfcfc8-9383-446f-83cc-3ab9be4be18f",
  "emailAddress": "[email protected]"
}