user: convertExternalToInternalMemberUser

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.

Convert an externally authenticated user into an internal user. The user is able to sign into the host tenant as an internal user and access resources as a member. For more information about this conversion, see Convert external users to internal users.

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

In delegated scenarios, the calling user must have at least the User Administrator Microsoft Entra roles.

HTTP request

POST /users/{usersId}/convertExternalToInternalMemberUser

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the parameters.

The following table lists the parameters that are required when you call this action.

Parameter Type Description
mail String Optional.
passwordProfile passwordProfile Required for users whose authentication is managed in the cloud.
userPrincipalName String Required for cloud users to change the userPrincipalName. Not required for on-premises synced users, as their userPrincipalName is managed on-premises.

Response

If successful, this method returns a 200 OK response code and conversionUserDetails response object.

Examples

Example 1: Convert a cloud user and require them to reset their password on next sign in

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/users/0b8cc234-ef87-4015-9785-cbb42000d41c/convertExternalToInternalMemberUser
Content-type: application/json

{
    "userPrincipalName": "AdeleVance@contoso.com",
    "passwordProfile": {
        "password": "Zdi087#2jhkahf",
        "forceChangePasswordNextSignIn": "true"
    }
}

Response

The following example shows the response.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.conversionUserDetails",
    "displayName": "Adele Vance",
    "userPrincipalName": "AdeleVance@contoso.com",
    "convertedToInternalUserDateTime": "2024-02-05T20:16:37.5012924Z",
    "mail": "AdeleV@woodgrove.com"
}

Example 2: Convert a cloud user, change their mail address, and require password reset on next sign in

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/users/0b8cc234-ef87-4015-9785-cbb42000d41c/convertExternalToInternalMemberUser
Content-type: application/json

{
    "userPrincipalName": "AdeleVance@contoso.com",
    "passwordProfile": {
        "password": "Zdi087#2jhkahf",
        "forceChangePasswordNextSignIn": "true"
    },
    "mail": "AdeleV@contoso.com"
}

Response

The following example shows the response.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.conversionUserDetails",
    "displayName": "Adele Vance",
    "userPrincipalName": "AdeleVance@contoso.com",
    "convertedToInternalUserDateTime": "2024-02-05T20:16:37.5012924Z",
    "mail": "AdeleV@woodgrove.com"
}

Example 3: Convert external User to internal for a user synchronized from on-premises AD

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/users/0b8cc234-ef87-4015-9785-cbb42000d41c/convertExternalToInternalMemberUser

Response

The following example shows the response.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.conversionUserDetails",
    "displayName": "Adele Vance",
    "userPrincipalName": "AdeleVance@contoso.com",
    "convertedToInternalUserDateTime": "2024-02-05T20:16:37.5012924Z",
    "mail": "AdeleV@woodgrove.com"
}