agentIdentityBlueprint: addKey

名前空間: microsoft.graph

agentIdentityBlueprint にキー資格情報を追加します。 このメソッドと removeKey を使用すると、期限切れのキーのローリングを自動化できます。

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

既存の有効な証明書がない (証明書がまだ追加されていないか、すべての証明書の有効期限が切れている) エージェント ID ブループリントは、このサービス アクションを使用できません。 代わりに、 Update エージェント ID ブループリント 操作を使用して更新を実行できます。

アクセス許可

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

HTTP 要求

POST /applications/{id}/microsoft.graph.agentIdentityBlueprint/addKey

要求ヘッダー

要求本文

要求本文で、パラメーターの JSON 表現を指定します。 次の表に、このアクションを呼び出すときに必要なパラメーターを示します。

応答

成功した場合、このアクションは応答コード 200 OK と、応答本文 に keyCredential を返します。

例

要求

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

POST https://graph.microsoft.com/beta/applications/{id}/microsoft.graph.agentIdentityBlueprint/addKey
Content-Type: application/json

{
  "keyCredential": {
    "@odata.type": "microsoft.graph.keyCredential"
  },
  "passwordCredential": {
    "@odata.type": "microsoft.graph.passwordCredential"
  },
  "proof": "String"
}

const options = {
	authProvider,
};

const client = Client.init(options);

const addKey = {
  keyCredential: {
    '@odata.type': 'microsoft.graph.keyCredential'
  },
  passwordCredential: {
    '@odata.type': 'microsoft.graph.passwordCredential'
  },
  proof: 'String'
};

await client.api('/applications/{id}/microsoft.graph.agentIdentityBlueprint/addKey')
	.version('beta')
	.post(addKey);

応答

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

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

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

{
  "value": {
    "@odata.type": "microsoft.graph.keyCredential"
  }
}