application: addPasswordapplication: addPassword

名前空間: microsoft.graphNamespace: microsoft.graph

アプリケーションに強力なパスワードを追加します。Adds a strong password to an application.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) Directory.accessasuser.all、すべてのディレクトリを示します。Application.ReadWrite.All, Directory.AccessAsUser.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication Application.ReadWrite.OwnedBy、Application.ReadWrite.AllApplication.ReadWrite.OwnedBy, Application.ReadWrite.All

HTTP 要求HTTP request

POST /applications/{id}/addPassword

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.
Content-TypeContent-Type application/json. Required.application/json. Required.

要求本文Request body

要求本文で、 passwordCredential 次のプロパティを持つオプションのオブジェクトを指定します。In the request body, provide an optional passwordCredential object with the following properties.

プロパティProperty 種類Type 説明Description
displayNamedisplayName 文字列String パスワードのフレンドリ名。Friendly name for the password. 省略可能。Optional.
endDateTimeendDateTime DateTimeOffsetDateTimeOffset ISO 8601 形式を使用してパスワードの有効期限が切れる日付と時刻。常に UTC 時間です。The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、'2014-01-01T00:00:00Z' のようになります。For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. 省略可能。Optional. 既定値は "startDateTime + 2 年" です。The default value is "startDateTime + 2 years".
startDateTimestartDateTime DateTimeOffsetDateTimeOffset パスワードが有効になる日時。The date and time at which the password becomes valid. Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、'2014-01-01T00:00:00Z' のようになります。For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. 省略可能。Optional. 既定値は "now" です。The default value is "now".

応答Response

成功した場合、このメソッドは応答 200 OK コードと、応答本文で新しい passwordcredential オブジェクトを返します。If successful, this method returns a 200 OK response code and a new passwordCredential object in the response body. Response オブジェクトの secretText プロパティには、Azure Active Directory によって16-64 文字の長さの強力なパスワードが格納されています。The secretText property in the response object contains the strong passwords generated by Azure Active Directory that are 16-64 characters in length. 今後、このパスワードを取得する方法はありません。There is no way to retrieve this password in the future.

Examples

次の例は、この API を呼び出す方法を示しています。The following example shows how to call this API.

要求Request

要求の例を次に示します。The following is an example of the request. 要求で指定されているidは、 appIdプロパティの値ではなく、アプリケーションのidプロパティの値です。The id that is specified in the request is the value of the id property of the application, not the value of the appId property.

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

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

応答Response

応答の例を次に示します。The following is an example of the response.

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"
}