servicePrincipal: addPassword

名前空間: microsoft.graph

servicePrincipal オブジェクトに強力なパスワードを追加します。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) Application.ReadWrite.All、Directory.AccessAsUser.All
委任 (個人用 Microsoft アカウント) サポートされていません。
アプリケーション Application.ReadWrite.OwnedBy、Application.ReadWrite.All

HTTP 要求

POST /servicePrincipals/{id}/addPassword

要求ヘッダー

名前 説明
Authorization ベアラー {token}。必須。
Content-Type application/json. Required.

要求本文

要求本文で、空の passwordCredential オブジェクトを指定するか、次の省略可能なプロパティを指定します。

プロパティ 説明
displayName 文字列 パスワードの分名。 省略可能。
endDateTime DateTimeOffset パスワードの有効期限が切れる日時は、ISO 8601 形式を使用して表され、常に UTC 時刻になります。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 省略可能。 既定値は "startDateTime + 2 年" です。
startDateTime DateTimeOffset パスワードが有効になる日時。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 省略可能。 既定値は "now" です。

応答

成功した場合、このメソッドは応答コードと、応答本文の新しい 200 OK passwordCredential オブジェクトを返します。 応答 オブジェクトの secretText プロパティには、16 ~ 64 文字のAzure Active Directoryによって生成される強力なパスワードが含まれています。 将来、このパスワードを取得する方法はありません。

次の例は、この API を呼び出す方法を示しています。

要求

要求の例を次に示します。

POST https://graph.microsoft.com/v1.0/servicePrincipals/{id}/addPassword
Content-type: application/json

{
  "passwordCredential": {
    "displayName": "Password friendly name"
  }
}

応答

応答の例を次に示します。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

{
    "customKeyIdentifier": null,
    "endDateTime": "2021-09-09T19:50:29.3086381Z",
    "keyId": "f0b0b335-1d71-4883-8f98-567911bfdca6",
    "startDateTime": "2019-09-09T19:50:29.3086381Z",
    "secretText": "[6gyXA5S20@MN+WRXAJ]I-TO7g1:h2P8",
    "hint": "[6g",
    "displayName": "Password friendly name"
}