servicePrincipal: removeKey

名前空間: microsoft.graph

servicePrincipal からキー資格情報を削除します。 addKey と共に このメソッド を使用すると、servicePrincipal を使用して、期限切れのキーのローリングを自動化できます。

注意

create servicePrincipal および Update servicePrincipal 操作を引き続き使用して、ユーザーのコンテキストの持つサービスPrincipalのキー資格情報を追加および更新できます。

このメソッドの要求検証の一環として、アクションを実行する前に、既存のキーの所有証明が検証されます。

アクセス許可

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

HTTP 要求

POST /servicePrincipals/{id}/removeKey

要求ヘッダー

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

要求本文

要求本文で、次の必須プロパティを指定します。

プロパティ 説明
keyId GUID パスワードの一意の識別子。
proof 文字列 既存のキーの所有証明として使用される自己署名証明書の JWT トークン。 この JWT トークンは、servicePrincipal の既存の有効な証明書の 1 つのプライベート キーを使用して署名する必要があります。 トークンには、次の要求を含める必要があります。
  • aud - 対象ユーザーは 00000002-0000-0000-c000-000000000000 である必要があります。
  • iss - 発行者は、 び出しを行っている servicePrincipal の ID である必要があります。
  • nbf - 時間前ではないこと。
  • exp - 有効期限は "nbf" + 10 分にする必要があります。

この所有証明 トークンを 生成するために使用できるコード サンプルを次に示します。

応答

成功した場合、このメソッドは 204 No content 応答コードを返します。

この API を呼び出す方法の例を次に示します。

要求

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

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

{
    "keyId": "f0b0b335-1d71-4883-8f98-567911bfdca6",
    "proof":"eyJ0eXAiOiJ..."
}

応答

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

HTTP/1.1 204 No Content