agentIdentityBlueprint: addKey

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

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

注:

公開キーの値は、証明書の資格情報をアプリケーションに追加する場合にのみ指定する必要があります。 秘密キー証明書をアプリケーションに追加すると、アプリケーションが危険にさらされるリスクがあります。

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

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

アクセス許可

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

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

重要

  • エージェント ID ブループリントまたはブループリント プリンシパルを作成したプリンシパルは、自動的に所有者として割り当てられます。
  • 所有者は、エージェントIDロールを割り当てなくても、所有するブループリントに関連付けられたエージェントIDを作成および変更できます。
  • 非所有者が委任されたシナリオで職場または学校アカウントを使用してこの API を呼び出すには、管理者にサポートされている Microsoft Entra ロールが割り当てられている必要があります。 この操作では、次の最小特権の組み込みロールがサポートされます。

HTTP 要求

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

要求ヘッダー

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

要求本文

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

プロパティ 型 説明
keyCredential keyCredential 追加する新しいアプリケーション キーの資格情報。 タイプ、使用法、キーは、この使用に必要なプロパティです。 サポートされているキーの種類は次のとおりです。
  • AsymmetricX509Cert: 使用法は Verify である必要があります。
  • X509CertAndPassword: 使用法は次の Sign
passwordCredential passwordCredential keyのパスワードを含む secretText のみを設定する必要があります。 このプロパティは、タイプ X509CertAndPassword のキーに対してのみ必須です。 それ以外の場合は [ null ] に設定します。
証明 文字列 既存のキーの所有の証明として使用される自己署名 JWT トークン。 この JWT トークンは、アプリケーションの既存の有効な証明書の 1 つの秘密キーを使用して署名される必要があります。 トークンには、次の要求を含める必要があります。
  • aud: オーディエンスは 00000002-0000-0000-c000-000000000000必要があります。
  • iss: 発行者は、要求を開始した アプリケーションの ID である必要があります。
  • nbf: 時間の前ではありません。
  • exp: 有効期限は nbf + 10 分の値である必要があります。

この所有証明トークンを生成する手順については、 ローリング キーの所有証明トークンの生成を参照してください。 要求の種類の詳細については、「 要求のペイロード」を参照してください。

応答

成功した場合、このアクションは 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"
}

応答

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

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

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

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