authenticationMethod: resetPassword

[アーティクル]
10/30/2023

名前空間: microsoft.graph

パスワード認証方法オブジェクトで表されるユーザーのパスワードをリセットします。これは、適切なアクセス許可を持つ管理者のみが実行でき、ユーザー自身のアカウントで実行することはできません。

このフローでは、新しいパスワードをMicrosoft Entra IDに書き込み、パスワードライトバックを使用して構成されている場合はオンプレミスの Active Directoryにプッシュします。管理者は、新しいパスワードを指定するか、システムにパスワードを生成させることができます。ユーザーは、次のサインイン時にパスワードを変更するように求められます。

このリセットは実行時間の長い操作であり、呼び出し元がリセット操作の状態を定期的にチェックできるリンクを含む Location ヘッダーを返します。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、アクセス許可のリファレンスを参照してください。

アクセス許可の種類	最小特権アクセス許可	特権の高いアクセス許可
委任 (職場または学校のアカウント)	UserAuthenticationMethod.ReadWrite.All	注意事項なし。
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
アプリケーション	サポートされていません。	サポートされていません。

委任されたシナリオの場合、管理者には少なくとも認証管理者または特権認証管理者Microsoft Entraロールが必要です。

ユーザー管理者、ヘルプデスク管理者、またはパスワード管理者の役割を持つ管理者は、「パスワードをリセットできるユーザー」で定義されている管理者以外のユーザーと制限された管理者ロールのセットのパスワードをリセットすることもできます。

HTTP 要求

POST /users/{id | userPrincipalName}/authentication/methods/{id}/resetPassword

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。認証と承認の詳細については、こちらをご覧ください。
Content-type	application/json. 必須です。

要求本文

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。

パラメーター	型	説明
newPassword	String	新しいパスワードを示す文字列を指定します。ハイブリッドパスワードシナリオを使用するテナントに必要です。クラウド専用パスワードを省略すると、システムによって生成されたパスワードが返されます。これは、他のエンコーディングを持たない Unicode 文字列です。受け入れ前にテナントの禁止パスワードシステムに対して検証され、テナントのクラウドやオンプレミスのパスワード要件に準拠する必要があります。

応答

成功した場合、このメソッドは 202 Accepted 応答コードと、応答本文で passwordResetResponse を返します。応答本文には、リセット操作の状態をチェックするための URL を含む Location ヘッダーも含めることができます。

呼び出し元がパスワードを送信しなかった場合、応答本文の JSON オブジェクトに Microsoft によって生成されたパスワードが提供されます。

応答ヘッダー

名前	説明
場所	操作の状態をチェックするために呼び出す URL。必須です。
再試行後	秒単位の期間。省略可能です。

例

例 1: ユーザーが送信したパスワード

次の例は、呼び出し元がパスワードを送信するときにこの API を呼び出す方法を示しています。

要求

次の例は要求を示しています。

POST https://graph.microsoft.com/v1.0/users/6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0/authentication/methods/28c10230-6103-485e-b985-444c60001490/resetPassword
Content-type: application/json

{
    "newPassword": "Cuyo5459"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Users.Item.Authentication.Methods.Item.ResetPassword;

var requestBody = new ResetPasswordPostRequestBody
{
	NewPassword = "Cuyo5459",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Users["{user-id}"].Authentication.Methods["{authenticationMethod-id}"].ResetPassword.PostAsync(requestBody);


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users authentication methods reset-password post --user-id {user-id} --authentication-method-id {authenticationMethod-id} --body '{\
    "newPassword": "Cuyo5459"\
}\
'



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphusers.NewResetPasswordPostRequestBody()
newPassword := "Cuyo5459"
requestBody.SetNewPassword(&newPassword) 

resetPassword, err := graphClient.Users().ByUserId("user-id").Authentication().Methods().ByAuthenticationMethodId("authenticationMethod-id").ResetPassword().Post(context.Background(), requestBody, nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.users.item.authentication.methods.item.resetpassword.ResetPasswordPostRequestBody resetPasswordPostRequestBody = new com.microsoft.graph.users.item.authentication.methods.item.resetpassword.ResetPasswordPostRequestBody();
resetPasswordPostRequestBody.setNewPassword("Cuyo5459");
var result = graphClient.users().byUserId("{user-id}").authentication().methods().byAuthenticationMethodId("{authenticationMethod-id}").resetPassword().post(resetPasswordPostRequestBody);


const options = {
	authProvider,
};

const client = Client.init(options);

const passwordResetResponse = {
    newPassword: 'Cuyo5459'
};

await client.api('/users/6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0/authentication/methods/28c10230-6103-485e-b985-444c60001490/resetPassword')
	.post(passwordResetResponse);


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\ResetPasswordPostRequestBody;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new ResetPasswordPostRequestBody();
$requestBody->setNewPassword('Cuyo5459');

$result = $graphServiceClient->users()->byUserId('user-id')->authentication()->methods()->byAuthenticationMethodId('authenticationMethod-id')->resetPassword()->post($requestBody)->wait();


Import-Module Microsoft.Graph.Users.Actions

$params = @{
	newPassword = "Cuyo5459"
}

Reset-MgUserAuthenticationMethodPassword -UserId $userId -AuthenticationMethodId $authenticationMethodId -BodyParameter $params


from msgraph import GraphServiceClient
from msgraph.generated.models.reset_password_post_request_body import ResetPasswordPostRequestBody

graph_client = GraphServiceClient(credentials, scopes)

request_body = ResetPasswordPostRequestBody(
	new_password = "Cuyo5459",
)

result = await graph_client.users.by_user_id('user-id').authentication.methods.by_authentication_method_id('authenticationMethod-id').reset_password.post(request_body)

応答

次の例は応答を示しています。

HTTP/1.1 202 Accepted
Content-type: application/json
Location: https://graph.microsoft.com/v1.0/users/6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0/authentication/operations/88e7560c-9ebf-435c-8089-c3998ac1ec51?aadgdc=DUB02P&aadgsu=ssprprod-a

{}

例 2: システム生成パスワード

次の例は、呼び出し元がパスワードを送信しない場合にこの API を呼び出す方法を示しています。

要求