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

Obtém a política de controlo de acesso para um recurso de agente. É devolvido um erro NOT_FOUND se o recurso não existir. É devolvida uma política vazia se o recurso existir, mas não tiver uma política definida.

Pedido HTTP

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

O URL usa a sintaxe de transcodificação de gRPC.

Parâmetros de caminho

Parâmetros
resource

string

Obrigatório: o recurso para o qual a política está a ser pedida. Consulte os nomes dos recursos para ver o valor adequado para este campo.

Parâmetros de consulta

Parâmetros
options

object (GetPolicyOptions)

OPCIONAL: um objeto GetPolicyOptions para especificar opções para agents.getIamPolicy.

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

Se for bem-sucedido, o corpo da resposta contém uma instância de Policy.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

GetPolicyOptions

Encapsula as definições fornecidas a agents.getIamPolicy.

Representação JSON 
{
  "requestedPolicyVersion": integer
}
Campos
requestedPolicyVersion

integer

Opcional. A versão máxima da política que vai ser usada para formatar a política.

Os valores válidos são 0, 1 e 3. Os pedidos que especifiquem um valor inválido são rejeitados.

Os pedidos de políticas com quaisquer associações de funções condicionais têm de especificar a versão 3. As políticas sem associações de funções condicionais podem especificar qualquer valor válido ou deixar o campo não definido.

A política na resposta pode usar a versão da política que especificou ou pode usar uma versão da política inferior. Por exemplo, se especificar a versão 3, mas a política não tiver associações de funções condicionais, a resposta usa a versão 1.

Para saber que recursos suportam condições nas respetivas políticas de IAM, consulte a documentação da IAM.