Method: projects.locations.collections.engines.assistants.agents.getIamPolicy

エージェント リソースのアクセス制御ポリシーを取得します。リソースが存在しない場合は、NOT_FOUND エラーが返されます。リソースが存在するが、ポリシーが設定されていない場合は、空のポリシーが返されます。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1alpha/{resource=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}:getIamPolicy

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
resource

string

必須: ポリシーをリクエストする対象のリソース。このフィールドに適切な値については、リソース名をご覧ください。

クエリ パラメータ

パラメータ
options

object (GetPolicyOptions)

省略可: agents.getIamPolicy にオプションを指定するための GetPolicyOptions オブジェクト。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には Policy のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

詳細については、Authentication Overview をご覧ください。

GetPolicyOptions

agents.getIamPolicy に指定された設定をカプセル化します。

JSON 表現 
{
  "requestedPolicyVersion": integer
}
フィールド
requestedPolicyVersion

integer

省略可。ポリシーの形式設定に使用されるポリシーの最大バージョン。

有効な値は 0、1、3 です。無効な値を指定したリクエストは拒否されます。

条件付きロール バインディングがあるポリシーのリクエストでは、バージョン 3 を指定する必要があります。条件付きロール バインディングがないポリシーでは、有効な値を指定することも、フィールドを設定しないこともできます。

レスポンスのポリシーでは、指定したポリシー バージョンを使用するか、それより低いポリシー バージョンを使用する場合があります。たとえば、バージョン 3 を指定しても、ポリシーに条件付きロール バインディングがない場合、レスポンスではバージョン 1 が使用されます。

IAM ポリシーで条件をサポートするリソースについては、IAM のドキュメントをご覧ください。