Method: projects.locations.collections.engines.getWorkspaceSettings

Obtiene la configuración de Workspace para el usuario final.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. Es el nombre completo del recurso del motor. Formato: projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es la configuración de Workspace para el usuario final.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "workspaceAccessEnabled": boolean
}
Campos
workspaceAccessEnabled

boolean

Indica si un usuario final tiene habilitado el acceso al espacio de trabajo.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • discoveryengine.engines.get

Para obtener más información, consulta la documentación de IAM.