Method: projects.locations.notebooks.share

Comparte un cuaderno con otras cuentas.

Solicitud HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/notebooks/*}:share

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

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. Nombre completo del recurso Notebook, como projects/{project}/locations/{location}/notebooks/{notebookId}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "accountAndRoles": [
    {
      object (AccountAndRole)
    }
  ],
  "notifyViaEmail": boolean
}
Campos
accountAndRoles[]

object (AccountAndRole)

Obligatorio. Es la lista de cuentas y roles con los que se compartirá el notebook.
notifyViaEmail

boolean

Obligatorio. Indica si se debe notificar a los usuarios con los que se compartió el contenido por correo electrónico.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta está vacío.

Alcances 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 requieren los siguientes permisos de IAM en el recurso name:

  • discoveryengine.notebooks.getIamPolicy
  • discoveryengine.notebooks.setIamPolicy

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

AccountAndRole

Información de la cuenta y el rol

Representación JSON 
{
  "email": string,
  "role": enum (ProjectRole)
}
Campos
email

string

Obligatorio. Es la dirección de correo electrónico asociada a la cuenta.
role

enum (ProjectRole)

Obligatorio. Es el rol en el notebook.

ProjectRole

Es el rol del proyecto.

Enums
PROJECT_ROLE_UNKNOWN Rol desconocido.
PROJECT_ROLE_OWNER El usuario es propietario del proyecto.
PROJECT_ROLE_WRITER El usuario tiene permisos de escritura en el proyecto.
PROJECT_ROLE_READER El usuario tiene permisos de lector en el proyecto.
PROJECT_ROLE_NOT_SHARED El usuario no tiene acceso al proyecto.