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 utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

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 que presentan la siguiente estructura:

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

object (AccountAndRole)

Obligatorio. La lista de cuentas y roles con los que compartir el cuaderno.
notifyViaEmail

boolean

Obligatorio. Si quieres notificar a los usuarios con los que has compartido el archivo por correo electrónico.

Cuerpo de la respuesta

Si la solicitud se hace correctamente, el cuerpo de la respuesta estará vacío.

Permisos de autorización

Debes disponer de 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 el Authentication Overview.

Permisos de IAM

Requiere los siguientes permisos de gestión de identidades y accesos (IAM) en el recurso name:

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

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

AccountAndRole

Información de la cuenta y del rol.

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

string

Obligatorio. La dirección de correo asociada a la cuenta.
role

enum (ProjectRole)

Obligatorio. El rol en el cuaderno.

ProjectRole

El rol del proyecto.

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