Method: projects.locations.collections.engines.getWorkspaceSettings

Ottieni le impostazioni di Workspace per l'utente finale.

Richiesta HTTP


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

Gli URL utilizzano la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatorio. Nome completo risorsa del motore. Formato: projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Impostazioni di Workspace per l'utente finale.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "workspaceAccessEnabled": boolean,
  "customerDomainValid": boolean
}
Campi
workspaceAccessEnabled

boolean

Indica se l'accesso a Workspace è abilitato per un utente finale.
customerDomainValid

boolean

Indica se il dominio personalizzato dell'utente chiamante corrisponde ai datastore di Workspace in questo motore.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • discoveryengine.engines.get

Per saperne di più, consulta la documentazione di IAM.