Skip to content

authentication-post-externalauthenticationmethods.md

Latest commit

 

History

History
136 lines (99 loc) · 5.11 KB

authentication-post-externalauthenticationmethods.md

File metadata and controls

136 lines (99 loc) · 5.11 KB
title Create externalAuthenticationMethod
description Create a new externalAuthenticationMethod object.
author rannderson
ms.date 04/01/2025
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type apiPageType

Create externalAuthenticationMethod

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Create a new externalAuthenticationMethod object. This API doesn't support self-service operations.

[!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-apis-write-others]

HTTP request

Assign an external MFA to another user. This API doesn't support self-service operations.

POST /users/{usersId}/authentication/externalAuthenticationMethods

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 externalAuthenticationMethod object.

You can specify the following properties when creating an externalAuthenticationMethod.

Property Type Description
configurationId String A unique identifier used to manage and integrate external auth methods within Microsoft Entra ID. Required.
displayName String Custom name given to the registered external MFA. Required.

Response

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

Examples

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/users/{id}/authentication/externalAuthenticationMethods
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.externalAuthenticationMethod",
  "configurationId": "26310fee-860b-4eab-8749-ab730dcf335e",
  "displayName": "Adatum"
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

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

{
  "@odata.type": "#microsoft.graph.externalAuthenticationMethod",
  "id": "78381c69-811f-51f6-66ec-c2c2aa0e2b46",
  "createdDateTime": "2025-04-02T16:01:39",
  "configurationId": "26310fee-860b-4eab-8749-ab730dcf335e",
  "displayName": "Adatum"
}