Method: projects.locations.collections.engines.getWorkspaceSettings

Receber as configurações do Workspace para o usuário final.

Solicitação HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*}:getWorkspaceSettings

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

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. Nome completo do recurso do mecanismo. Formato: projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Configurações do Workspace para o usuário final.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "workspaceAccessEnabled": boolean,
  "customerDomainValid": boolean
}
Campos
workspaceAccessEnabled

boolean

Indica se um usuário final tem o acesso ao Workspace ativado.
customerDomainValid

boolean

Indica se o domínio do cliente do usuário que está chamando corresponde aos repositórios de dados do Workspace nesse mecanismo.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • discoveryengine.engines.get

Para mais informações, consulte a documentação do IAM.