Method: projects.locations.collections.engines.getWorkspaceSettings

Workspace-Einstellungen für den Endnutzer abrufen

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Vollständiger Name der Engine-Ressource. Format: projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Workspace-Einstellungen für den Endnutzer.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "workspaceAccessEnabled": boolean
}
Felder
workspaceAccessEnabled

boolean

Gibt an, ob der Arbeitsbereichzugriff für einen Endnutzer aktiviert ist.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource name:

  • discoveryengine.engines.get

Weitere Informationen finden Sie in der IAM-Dokumentation.